(Comparing Files): Mention resync for `compare-windows'.
[emacs.git] / man / calc.texi
blob3ceb0c3ebffd3c2c910848e05aca6f633f420de8
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]
6 @settitle GNU Emacs Calc 2.1 Manual
7 @setchapternewpage odd
8 @comment %**end of header (This is for running Texinfo on a region.)
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
16 @c @expr{expr} will typeset an expression;
17 @c $x$ in TeX, @samp{x} otherwise.
19 @iftex
20 @macro texline
21 @end macro
22 @alias infoline=comment
23 @alias expr=math
24 @alias tfn=code
25 @alias mathit=expr
26 @macro cpi{}
27 @math{@pi{}}
28 @end macro
29 @macro cpiover{den}
30 @math{@pi/\den\}
31 @end macro
32 @end iftex
34 @ifnottex
35 @alias texline=comment
36 @macro infoline{stuff}
37 \stuff\
38 @end macro
39 @alias expr=samp
40 @alias tfn=t
41 @alias mathit=i
42 @macro cpi{}
43 @expr{pi}
44 @end macro
45 @macro cpiover{den}
46 @expr{pi/\den\}
47 @end macro
48 @end ifnottex
51 @tex
52 % Suggested by Karl Berry <karl@@freefriends.org>
53 \gdef\!{\mskip-\thinmuskip}
54 @end tex
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
60 @tex
61 \gdef\coloneq{\mathrel{\mathord:\mathord=}}
63 \gdef\beforedisplay{\vskip-10pt}
64 \gdef\afterdisplay{\vskip-5pt}
65 \gdef\beforedisplayh{\vskip-25pt}
66 \gdef\afterdisplayh{\vskip-10pt}
67 @end tex
68 @newdimen@kyvpos @kyvpos=0pt
69 @newdimen@kyhpos @kyhpos=0pt
70 @newcount@calcclubpenalty @calcclubpenalty=1000
71 @ignore
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
80 @end ignore
81 @end iftex
83 @copying
84 This file documents Calc, the GNU Emacs calculator.
86 Copyright (C) 1990, 1991, 2001, 2002, 2005 Free Software Foundation, Inc.
88 @quotation
89 Permission is granted to copy, distribute and/or modify this document
90 under the terms of the GNU Free Documentation License, Version 1.1 or
91 any later version published by the Free Software Foundation; with the
92 Invariant Sections being just ``GNU GENERAL PUBLIC LICENSE'', with the
93 Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover
94 Texts as in (a) below.
96 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
97 this GNU Manual, like GNU software.  Copies published by the Free
98 Software Foundation raise funds for GNU development.''
99 @end quotation
100 @end copying
102 @dircategory Emacs
103 @direntry
104 * Calc: (calc).         Advanced desk calculator and mathematical tool.
105 @end direntry
107 @titlepage
108 @sp 6
109 @center @titlefont{Calc Manual}
110 @sp 4
111 @center GNU Emacs Calc Version 2.1
112 @c [volume]
113 @sp 1
114 @center March 2005
115 @sp 5
116 @center Dave Gillespie
117 @center daveg@@synaptics.com
118 @page
120 @vskip 0pt plus 1filll
121 Copyright @copyright{} 1990, 1991, 2001, 2002, 2005
122 Free Software Foundation, Inc.
123 @insertcopying
124 @end titlepage
126 @c [begin]
127 @ifinfo
128 @node Top, , (dir), (dir)
129 @chapter The GNU Emacs Calculator
131 @noindent
132 @dfn{Calc} is an advanced desk calculator and mathematical tool
133 that runs as part of the GNU Emacs environment.
135 This manual is divided into three major parts: ``Getting Started,''
136 the ``Calc Tutorial,'' and the ``Calc Reference.''  The Tutorial
137 introduces all the major aspects of Calculator use in an easy,
138 hands-on way.  The remainder of the manual is a complete reference to
139 the features of the Calculator.
141 For help in the Emacs Info system (which you are using to read this
142 file), type @kbd{?}.  (You can also type @kbd{h} to run through a
143 longer Info tutorial.)
145 @end ifinfo
146 @menu
147 * Copying::               How you can copy and share Calc.
149 * Getting Started::       General description and overview.
150 * Interactive Tutorial::
151 * Tutorial::              A step-by-step introduction for beginners.
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.
165 * Keypad Mode::           Operating Calc from a keypad.
166 * Embedded Mode::         Working with formulas embedded in a file.
167 * Programming::           Calc as a programmable calculator.
169 * Customizable Variables:: Customizable Variables.
170 * Reporting Bugs::        How to report bugs and make suggestions.
172 * Summary::               Summary of Calc commands and functions.
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
182 @node Copying, Getting Started, Top, Top
183 @unnumbered GNU GENERAL PUBLIC LICENSE
184 @center Version 2, June 1991
186 @c This file is intended to be included in another file.
188 @display
189 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
190 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
192 Everyone is permitted to copy and distribute verbatim copies
193 of this license document, but changing it is not allowed.
194 @end display
196 @unnumberedsec Preamble
198   The licenses for most software are designed to take away your
199 freedom to share and change it.  By contrast, the GNU General Public
200 License is intended to guarantee your freedom to share and change free
201 software---to make sure the software is free for all its users.  This
202 General Public License applies to most of the Free Software
203 Foundation's software and to any other program whose authors commit to
204 using it.  (Some other Free Software Foundation software is covered by
205 the GNU Library General Public License instead.)  You can apply it to
206 your programs, too.
208   When we speak of free software, we are referring to freedom, not
209 price.  Our General Public Licenses are designed to make sure that you
210 have the freedom to distribute copies of free software (and charge for
211 this service if you wish), that you receive source code or can get it
212 if you want it, that you can change the software or use pieces of it
213 in new free programs; and that you know you can do these things.
215   To protect your rights, we need to make restrictions that forbid
216 anyone to deny you these rights or to ask you to surrender the rights.
217 These restrictions translate to certain responsibilities for you if you
218 distribute copies of the software, or if you modify it.
220   For example, if you distribute copies of such a program, whether
221 gratis or for a fee, you must give the recipients all the rights that
222 you have.  You must make sure that they, too, receive or can get the
223 source code.  And you must show them these terms so they know their
224 rights.
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,
228 distribute and/or modify the software.
230   Also, for each author's protection and ours, we want to make certain
231 that everyone understands that there is no warranty for this free
232 software.  If the software is modified by someone else and passed on, we
233 want its recipients to know that what they have is not the original, so
234 that any problems introduced by others will not reflect on the original
235 authors' reputations.
237   Finally, any free program is threatened constantly by software
238 patents.  We wish to avoid the danger that redistributors of a free
239 program will individually obtain patent licenses, in effect making the
240 program proprietary.  To prevent this, we have made it clear that any
241 patent must be licensed for everyone's free use or not licensed at all.
243   The precise terms and conditions for copying, distribution and
244 modification follow.
246 @iftex
247 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
248 @end iftex
249 @ifinfo
250 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
251 @end ifinfo
253 @enumerate 0
254 @item
255 This License applies to any program or other work which contains
256 a notice placed by the copyright holder saying it may be distributed
257 under the terms of this General Public License.  The ``Program'', below,
258 refers to any such program or work, and a ``work based on the Program''
259 means either the Program or any derivative work under copyright law:
260 that is to say, a work containing the Program or a portion of it,
261 either verbatim or with modifications and/or translated into another
262 language.  (Hereinafter, translation is included without limitation in
263 the term ``modification''.)  Each licensee is addressed as ``you''.
265 Activities other than copying, distribution and modification are not
266 covered by this License; they are outside its scope.  The act of
267 running the Program is not restricted, and the output from the Program
268 is covered only if its contents constitute a work based on the
269 Program (independent of having been made by running the Program).
270 Whether that is true depends on what the Program does.
272 @item
273 You may copy and distribute verbatim copies of the Program's
274 source code as you receive it, in any medium, provided that you
275 conspicuously and appropriately publish on each copy an appropriate
276 copyright notice and disclaimer of warranty; keep intact all the
277 notices that refer to this License and to the absence of any warranty;
278 and give any other recipients of the Program a copy of this License
279 along with the Program.
281 You may charge a fee for the physical act of transferring a copy, and
282 you may at your option offer warranty protection in exchange for a fee.
284 @item
285 You may modify your copy or copies of the Program or any portion
286 of it, thus forming a work based on the Program, and copy and
287 distribute such modifications or work under the terms of Section 1
288 above, provided that you also meet all of these conditions:
290 @enumerate a
291 @item
292 You must cause the modified files to carry prominent notices
293 stating that you changed the files and the date of any change.
295 @item
296 You must cause any work that you distribute or publish, that in
297 whole or in part contains or is derived from the Program or any
298 part thereof, to be licensed as a whole at no charge to all third
299 parties under the terms of this License.
301 @item
302 If the modified program normally reads commands interactively
303 when run, you must cause it, when started running for such
304 interactive use in the most ordinary way, to print or display an
305 announcement including an appropriate copyright notice and a
306 notice that there is no warranty (or else, saying that you provide
307 a warranty) and that users may redistribute the program under
308 these conditions, and telling the user how to view a copy of this
309 License.  (Exception: if the Program itself is interactive but
310 does not normally print such an announcement, your work based on
311 the Program is not required to print an announcement.)
312 @end enumerate
314 These requirements apply to the modified work as a whole.  If
315 identifiable sections of that work are not derived from the Program,
316 and can be reasonably considered independent and separate works in
317 themselves, then this License, and its terms, do not apply to those
318 sections when you distribute them as separate works.  But when you
319 distribute the same sections as part of a whole which is a work based
320 on the Program, the distribution of the whole must be on the terms of
321 this License, whose permissions for other licensees extend to the
322 entire whole, and thus to each and every part regardless of who wrote it.
324 Thus, it is not the intent of this section to claim rights or contest
325 your rights to work written entirely by you; rather, the intent is to
326 exercise the right to control the distribution of derivative or
327 collective works based on the Program.
329 In addition, mere aggregation of another work not based on the Program
330 with the Program (or with a work based on the Program) on a volume of
331 a storage or distribution medium does not bring the other work under
332 the scope of this License.
334 @item
335 You may copy and distribute the Program (or a work based on it,
336 under Section 2) in object code or executable form under the terms of
337 Sections 1 and 2 above provided that you also do one of the following:
339 @enumerate a
340 @item
341 Accompany it with the complete corresponding machine-readable
342 source code, which must be distributed under the terms of Sections
343 1 and 2 above on a medium customarily used for software interchange; or,
345 @item
346 Accompany it with a written offer, valid for at least three
347 years, to give any third party, for a charge no more than your
348 cost of physically performing source distribution, a complete
349 machine-readable copy of the corresponding source code, to be
350 distributed under the terms of Sections 1 and 2 above on a medium
351 customarily used for software interchange; or,
353 @item
354 Accompany it with the information you received as to the offer
355 to distribute corresponding source code.  (This alternative is
356 allowed only for noncommercial distribution and only if you
357 received the program in object code or executable form with such
358 an offer, in accord with Subsection b above.)
359 @end enumerate
361 The source code for a work means the preferred form of the work for
362 making modifications to it.  For an executable work, complete source
363 code means all the source code for all modules it contains, plus any
364 associated interface definition files, plus the scripts used to
365 control compilation and installation of the executable.  However, as a
366 special exception, the source code distributed need not include
367 anything that is normally distributed (in either source or binary
368 form) with the major components (compiler, kernel, and so on) of the
369 operating system on which the executable runs, unless that component
370 itself accompanies the executable.
372 If distribution of executable or object code is made by offering
373 access to copy from a designated place, then offering equivalent
374 access to copy the source code from the same place counts as
375 distribution of the source code, even though third parties are not
376 compelled to copy the source along with the object code.
378 @item
379 You may not copy, modify, sublicense, or distribute the Program
380 except as expressly provided under this License.  Any attempt
381 otherwise to copy, modify, sublicense or distribute the Program is
382 void, and will automatically terminate your rights under this License.
383 However, parties who have received copies, or rights, from you under
384 this License will not have their licenses terminated so long as such
385 parties remain in full compliance.
387 @item
388 You are not required to accept this License, since you have not
389 signed it.  However, nothing else grants you permission to modify or
390 distribute the Program or its derivative works.  These actions are
391 prohibited by law if you do not accept this License.  Therefore, by
392 modifying or distributing the Program (or any work based on the
393 Program), you indicate your acceptance of this License to do so, and
394 all its terms and conditions for copying, distributing or modifying
395 the Program or works based on it.
397 @item
398 Each time you redistribute the Program (or any work based on the
399 Program), the recipient automatically receives a license from the
400 original licensor to copy, distribute or modify the Program subject to
401 these terms and conditions.  You may not impose any further
402 restrictions on the recipients' exercise of the rights granted herein.
403 You are not responsible for enforcing compliance by third parties to
404 this License.
406 @item
407 If, as a consequence of a court judgment or allegation of patent
408 infringement or for any other reason (not limited to patent issues),
409 conditions are imposed on you (whether by court order, agreement or
410 otherwise) that contradict the conditions of this License, they do not
411 excuse you from the conditions of this License.  If you cannot
412 distribute so as to satisfy simultaneously your obligations under this
413 License and any other pertinent obligations, then as a consequence you
414 may not distribute the Program at all.  For example, if a patent
415 license would not permit royalty-free redistribution of the Program by
416 all those who receive copies directly or indirectly through you, then
417 the only way you could satisfy both it and this License would be to
418 refrain entirely from distribution of the Program.
420 If any portion of this section is held invalid or unenforceable under
421 any particular circumstance, the balance of the section is intended to
422 apply and the section as a whole is intended to apply in other
423 circumstances.
425 It is not the purpose of this section to induce you to infringe any
426 patents or other property right claims or to contest validity of any
427 such claims; this section has the sole purpose of protecting the
428 integrity of the free software distribution system, which is
429 implemented by public license practices.  Many people have made
430 generous contributions to the wide range of software distributed
431 through that system in reliance on consistent application of that
432 system; it is up to the author/donor to decide if he or she is willing
433 to distribute software through any other system and a licensee cannot
434 impose that choice.
436 This section is intended to make thoroughly clear what is believed to
437 be a consequence of the rest of this License.
439 @item
440 If the distribution and/or use of the Program is restricted in
441 certain countries either by patents or by copyrighted interfaces, the
442 original copyright holder who places the Program under this License
443 may add an explicit geographical distribution limitation excluding
444 those countries, so that distribution is permitted only in or among
445 countries not thus excluded.  In such case, this License incorporates
446 the limitation as if written in the body of this License.
448 @item
449 The Free Software Foundation may publish revised and/or new versions
450 of the General Public License from time to time.  Such new versions will
451 be similar in spirit to the present version, but may differ in detail to
452 address new problems or concerns.
454 Each version is given a distinguishing version number.  If the Program
455 specifies a version number of this License which applies to it and ``any
456 later version'', you have the option of following the terms and conditions
457 either of that version or of any later version published by the Free
458 Software Foundation.  If the Program does not specify a version number of
459 this License, you may choose any version ever published by the Free Software
460 Foundation.
462 @item
463 If you wish to incorporate parts of the Program into other free
464 programs whose distribution conditions are different, write to the author
465 to ask for permission.  For software which is copyrighted by the Free
466 Software Foundation, write to the Free Software Foundation; we sometimes
467 make exceptions for this.  Our decision will be guided by the two goals
468 of preserving the free status of all derivatives of our free software and
469 of promoting the sharing and reuse of software generally.
471 @iftex
472 @heading NO WARRANTY
473 @end iftex
474 @ifinfo
475 @center NO WARRANTY
476 @end ifinfo
478 @item
479 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
480 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
481 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
482 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
483 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
484 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
485 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
486 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
487 REPAIR OR CORRECTION.
489 @item
490 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
491 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
492 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
493 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
494 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
495 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
496 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
497 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
498 POSSIBILITY OF SUCH DAMAGES.
499 @end enumerate
501 @iftex
502 @heading END OF TERMS AND CONDITIONS
503 @end iftex
504 @ifinfo
505 @center END OF TERMS AND CONDITIONS
506 @end ifinfo
508 @page
509 @unnumberedsec Appendix: How to Apply These Terms to Your New Programs
511   If you develop a new program, and you want it to be of the greatest
512 possible use to the public, the best way to achieve this is to make it
513 free software which everyone can redistribute and change under these terms.
515   To do so, attach the following notices to the program.  It is safest
516 to attach them to the start of each source file to most effectively
517 convey the exclusion of warranty; and each file should have at least
518 the ``copyright'' line and a pointer to where the full notice is found.
520 @smallexample
521 @var{one line to give the program's name and a brief idea of what it does.}
522 Copyright (C) @var{yyyy}  @var{name of author}
524 This program is free software; you can redistribute it and/or modify
525 it under the terms of the GNU General Public License as published by
526 the Free Software Foundation; either version 2 of the License, or
527 (at your option) any later version.
529 This program is distributed in the hope that it will be useful,
530 but WITHOUT ANY WARRANTY; without even the implied warranty of
531 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
532 GNU General Public License for more details.
534 You should have received a copy of the GNU General Public License
535 along with this program; if not, write to the Free Software
536 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
537 @end smallexample
539 Also add information on how to contact you by electronic and paper mail.
541 If the program is interactive, make it output a short notice like this
542 when it starts in an interactive mode:
544 @smallexample
545 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
546 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
547 This is free software, and you are welcome to redistribute it
548 under certain conditions; type `show c' for details.
549 @end smallexample
551 The hypothetical commands @samp{show w} and @samp{show c} should show
552 the appropriate parts of the General Public License.  Of course, the
553 commands 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
555 suits your program.
557 You should also get your employer (if you work as a programmer) or your
558 school, if any, to sign a ``copyright disclaimer'' for the program, if
559 necessary.  Here is a sample; alter the names:
561 @example
562 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
563 `Gnomovision' (which makes passes at compilers) written by James Hacker.
565 @var{signature of Ty Coon}, 1 April 1989
566 Ty Coon, President of Vice
567 @end example
569 This General Public License does not permit incorporating your program into
570 proprietary programs.  If your program is a subroutine library, you may
571 consider it more useful to permit linking proprietary applications with the
572 library.  If this is what you want to do, use the GNU Library General
573 Public License instead of this License.
575 @node Getting Started, Tutorial, Copying, Top
576 @chapter Getting Started
577 @noindent
578 This chapter provides a general overview of Calc, the GNU Emacs
579 Calculator:  What it is, how to start it and how to exit from it,
580 and what are the various ways that it can be used.
582 @menu
583 * What is Calc::
584 * About This Manual::
585 * Notations Used in This Manual::
586 * Demonstration of Calc::
587 * Using Calc::
588 * History and Acknowledgements::
589 @end menu
591 @node What is Calc, About This Manual, Getting Started, Getting Started
592 @section What is Calc?
594 @noindent
595 @dfn{Calc} is an advanced calculator and mathematical tool that runs as
596 part of the GNU Emacs environment.  Very roughly based on the HP-28/48
597 series of calculators, its many features include:
599 @itemize @bullet
600 @item
601 Choice of algebraic or RPN (stack-based) entry of calculations.
603 @item
604 Arbitrary precision integers and floating-point numbers.
606 @item
607 Arithmetic on rational numbers, complex numbers (rectangular and polar),
608 error forms with standard deviations, open and closed intervals, vectors
609 and matrices, dates and times, infinities, sets, quantities with units,
610 and algebraic formulas.
612 @item
613 Mathematical operations such as logarithms and trigonometric functions.
615 @item
616 Programmer's features (bitwise operations, non-decimal numbers).
618 @item
619 Financial functions such as future value and internal rate of return.
621 @item
622 Number theoretical features such as prime factorization and arithmetic
623 modulo @var{m} for any @var{m}.
625 @item
626 Algebraic manipulation features, including symbolic calculus.
628 @item
629 Moving data to and from regular editing buffers.
631 @item
632 Embedded mode for manipulating Calc formulas and data directly
633 inside any editing buffer.
635 @item
636 Graphics using GNUPLOT, a versatile (and free) plotting program.
638 @item
639 Easy programming using keyboard macros, algebraic formulas,
640 algebraic rewrite rules, or extended Emacs Lisp.
641 @end itemize
643 Calc tries to include a little something for everyone; as a result it is
644 large and might be intimidating to the first-time user.  If you plan to
645 use Calc only as a traditional desk calculator, all you really need to
646 read is the ``Getting Started'' chapter of this manual and possibly the
647 first few sections of the tutorial.  As you become more comfortable with
648 the program you can learn its additional features.  Calc does not
649 have the scope and depth of a fully-functional symbolic math package,
650 but Calc has the advantages of convenience, portability, and freedom.
652 @node About This Manual, Notations Used in This Manual, What is Calc, Getting Started
653 @section About This Manual
655 @noindent
656 This document serves as a complete description of the GNU Emacs
657 Calculator.  It works both as an introduction for novices, and as
658 a reference for experienced users.  While it helps to have some
659 experience with GNU Emacs in order to get the most out of Calc,
660 this manual ought to be readable even if you don't know or use Emacs
661 regularly.
663 @ifinfo
664 The manual is divided into three major parts:@: the ``Getting
665 Started'' chapter you are reading now, the Calc tutorial (chapter 2),
666 and the Calc reference manual (the remaining chapters and appendices).
667 @end ifinfo
668 @iftex
669 The manual is divided into three major parts:@: the ``Getting
670 Started'' chapter you are reading now, the Calc tutorial (chapter 2),
671 and 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
678 If you are in a hurry to use Calc, there is a brief ``demonstration''
679 below which illustrates the major features of Calc in just a couple of
680 pages.  If you don't have time to go through the full tutorial, this
681 will show you everything you need to know to begin.
682 @xref{Demonstration of Calc}.
684 The tutorial chapter walks you through the various parts of Calc
685 with lots of hands-on examples and explanations.  If you are new
686 to Calc and you have some time, try going through at least the
687 beginning of the tutorial.  The tutorial includes about 70 exercises
688 with answers.  These exercises give you some guided practice with
689 Calc, as well as pointing out some interesting and unusual ways
690 to use its features.
692 The reference section discusses Calc in complete depth.  You can read
693 the reference from start to finish if you want to learn every aspect
694 of Calc.  Or, you can look in the table of contents or the Concept
695 Index to find the parts of the manual that discuss the things you
696 need to know.
698 @cindex Marginal notes
699 Every Calc keyboard command is listed in the Calc Summary, and also
700 in the Key Index.  Algebraic functions, @kbd{M-x} commands, and
701 variables also have their own indices.  
702 @texline Each
703 @infoline In the printed manual, each
704 paragraph that is referenced in the Key or Function Index is marked
705 in the margin with its index entry.
707 @c [fix-ref Help Commands]
708 You can access this manual on-line at any time within Calc by
709 pressing the @kbd{h i} key sequence.  Outside of the Calc window,
710 you can press @kbd{M-# i} to read the manual on-line.  Also, you
711 can jump directly to the Tutorial by pressing @kbd{h t} or @kbd{M-# t},
712 or to the Summary by pressing @kbd{h s} or @kbd{M-# s}.  Within Calc,
713 you can also go to the part of the manual describing any Calc key,
714 function, or variable using @w{@kbd{h k}}, @kbd{h f}, or @kbd{h v},
715 respectively.  @xref{Help Commands}.
717 The Calc manual can be printed, but because the manual is so large, you
718 should only make a printed copy if you really need it.  To print the
719 manual, you will need the @TeX{} typesetting program (this is a free
720 program by Donald Knuth at Stanford University) as well as the
721 @file{texindex} program and @file{texinfo.tex} file, both of which can
722 be obtained from the FSF as part of the @code{texinfo} package.
723 To print the Calc manual in one huge tome, you will need the
724 source code to this manual, @file{calc.texi}, available as part of the
725 Emacs source.  Once you have this file, type @kbd{texi2dvi calc.texi}.
726 Alternatively, change to the @file{man} subdirectory of the Emacs
727 source distribution, and type @kbd{make calc.dvi}. (Don't worry if you
728 get some ``overfull box'' warnings while @TeX{} runs.)
729 The result will be a device-independent output file called
730 @file{calc.dvi}, which you must print in whatever way is right
731 for your system.  On many systems, the command is
733 @example
734 lpr -d calc.dvi
735 @end example
737 @noindent
740 @example
741 dvips calc.dvi
742 @end example
744 @c Printed copies of this manual are also available from the Free Software
745 @c Foundation.
747 @node Notations Used in This Manual, Demonstration of Calc, About This Manual, Getting Started
748 @section Notations Used in This Manual
750 @noindent
751 This section describes the various notations that are used
752 throughout the Calc manual.
754 In keystroke sequences, uppercase letters mean you must hold down
755 the shift key while typing the letter.  Keys pressed with Control
756 held down are shown as @kbd{C-x}.  Keys pressed with Meta held down
757 are shown as @kbd{M-x}.  Other notations are @key{RET} for the
758 Return 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.
760 The @key{DEL} key is called Backspace on some keyboards, it is
761 whatever key you would use to correct a simple typing error when
762 regularly using Emacs.
764 (If you don't have the @key{LFD} or @key{TAB} keys on your keyboard,
765 the @kbd{C-j} and @kbd{C-i} keys are equivalent to them, respectively.
766 If you don't have a Meta key, look for Alt or Extend Char.  You can
767 also press @key{ESC} or @kbd{C-[} first to get the same effect, so
768 that @kbd{M-x}, @kbd{@key{ESC} x}, and @kbd{C-[ x} are all equivalent.)
770 Sometimes the @key{RET} key is not shown when it is ``obvious''
771 that you must press @key{RET} to proceed.  For example, the @key{RET}
772 is usually omitted in key sequences like @kbd{M-x calc-keypad @key{RET}}.
774 Commands are generally shown like this:  @kbd{p} (@code{calc-precision})
775 or @kbd{M-# k} (@code{calc-keypad}).  This means that the command is
776 normally used by pressing the @kbd{p} key or @kbd{M-# k} key sequence,
777 but it also has the full-name equivalent shown, e.g., @kbd{M-x calc-precision}.
779 Commands that correspond to functions in algebraic notation
780 are written:  @kbd{C} (@code{calc-cos}) [@code{cos}].  This means
781 the @kbd{C} key is equivalent to @kbd{M-x calc-cos}, and that
782 the corresponding function in an algebraic-style formula would
783 be @samp{cos(@var{x})}.
785 A few commands don't have key equivalents:  @code{calc-sincos}
786 [@code{sincos}].
788 @node Demonstration of Calc, Using Calc, Notations Used in This Manual, Getting Started
789 @section A Demonstration of Calc
791 @noindent
792 @cindex Demonstration of Calc
793 This section will show some typical small problems being solved with
794 Calc.  The focus is more on demonstration than explanation, but
795 everything you see here will be covered more thoroughly in the
796 Tutorial.
798 To begin, start Emacs if necessary (usually the command @code{emacs}
799 does this), and type @kbd{M-# c} (or @kbd{@key{ESC} # c}) to start the
800 Calculator.  (You can also use @kbd{M-x calc} if this doesn't work.
801 @xref{Starting Calc}, for various ways of starting the Calculator.)
803 Be sure to type all the sample input exactly, especially noting the
804 difference between lower-case and upper-case letters.  Remember,
805 @key{RET}, @key{TAB}, @key{DEL}, and @key{SPC} are the Return, Tab,
806 Delete, and Space keys.
808 @strong{RPN calculation.}  In RPN, you type the input number(s) first,
809 then the command to operate on the numbers.
811 @noindent
812 Type @kbd{2 @key{RET} 3 + Q} to compute 
813 @texline @math{\sqrt{2+3} = 2.2360679775}.
814 @infoline the square root of 2+3, which is 2.2360679775.
816 @noindent
817 Type @kbd{P 2 ^} to compute 
818 @texline @math{\pi^2 = 9.86960440109}.
819 @infoline the value of `pi' squared, 9.86960440109.
821 @noindent
822 Type @key{TAB} to exchange the order of these two results.
824 @noindent
825 Type @kbd{- I H S} to subtract these results and compute the Inverse
826 Hyperbolic sine of the difference, 2.72996136574.
828 @noindent
829 Type @key{DEL} to erase this result.
831 @strong{Algebraic calculation.}  You can also enter calculations using
832 conventional ``algebraic'' notation.  To enter an algebraic formula,
833 use the apostrophe key.
835 @noindent
836 Type @kbd{' sqrt(2+3) @key{RET}} to compute 
837 @texline @math{\sqrt{2+3}}.
838 @infoline the square root of 2+3.
840 @noindent
841 Type @kbd{' pi^2 @key{RET}} to enter 
842 @texline @math{\pi^2}.
843 @infoline `pi' squared.  
844 To evaluate this symbolic formula as a number, type @kbd{=}.
846 @noindent
847 Type @kbd{' arcsinh($ - $$) @key{RET}} to subtract the second-most-recent
848 result from the most-recent and compute the Inverse Hyperbolic sine.
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
852 the next section.)
854 @noindent
855 Click on the @key{2}, @key{ENTER}, @key{3}, @key{+}, and @key{SQRT}
856 ``buttons'' using your left mouse button.
858 @noindent
859 Click on @key{PI}, @key{2}, and @tfn{y^x}.
861 @noindent
862 Click on @key{INV}, then @key{ENTER} to swap the two results.
864 @noindent
865 Click on @key{-}, @key{INV}, @key{HYP}, and @key{SIN}.
867 @noindent
868 Click on @key{<-} to erase the result, then click @key{OFF} to turn
869 the Keypad Calculator off.
871 @strong{Grabbing data.}  Type @kbd{M-# x} if necessary to exit Calc.
872 Now select the following numbers as an Emacs region:  ``Mark'' the
873 front of the list by typing @kbd{C-@key{SPC}} or @kbd{C-@@} there,
874 then move to the other end of the list.  (Either get this list from
875 the on-line copy of this manual, accessed by @w{@kbd{M-# i}}, or just
876 type these numbers into a scratch file.)  Now type @kbd{M-# g} to
877 ``grab'' these numbers into Calc.
879 @example
880 @group
881 1.23  1.97
882 1.6   2
883 1.19  1.08
884 @end group
885 @end example
887 @noindent
888 The result @samp{[1.23, 1.97, 1.6, 2, 1.19, 1.08]} is a Calc ``vector.''
889 Type @w{@kbd{V R +}} to compute the sum of these numbers.
891 @noindent
892 Type @kbd{U} to Undo this command, then type @kbd{V R *} to compute
893 the product of the numbers.
895 @noindent
896 You can also grab data as a rectangular matrix.  Place the cursor on
897 the upper-leftmost @samp{1} and set the mark, then move to just after
898 the lower-right @samp{8} and press @kbd{M-# r}.
900 @noindent
901 Type @kbd{v t} to transpose this 
902 @texline @math{3\times2}
903 @infoline 3x2 
904 matrix into a 
905 @texline @math{2\times3}
906 @infoline 2x3
907 matrix.  Type @w{@kbd{v u}} to unpack the rows into two separate
908 vectors.  Now type @w{@kbd{V R + @key{TAB} V R +}} to compute the sums
909 of the two original columns. (There is also a special
910 grab-and-sum-columns command, @kbd{M-# :}.)
912 @strong{Units conversion.}  Units are entered algebraically.
913 Type @w{@kbd{' 43 mi/hr @key{RET}}} to enter the quantity 43 miles-per-hour.
914 Type @w{@kbd{u c km/hr @key{RET}}}.  Type @w{@kbd{u c m/s @key{RET}}}.
916 @strong{Date arithmetic.}  Type @kbd{t N} to get the current date and
917 time.  Type @kbd{90 +} to find the date 90 days from now.  Type
918 @kbd{' <25 dec 87> @key{RET}} to enter a date, then @kbd{- 7 /} to see how
919 many weeks have passed since then.
921 @strong{Algebra.}  Algebraic entries can also include formulas
922 or equations involving variables.  Type @kbd{@w{' [x + y} = a, x y = 1] @key{RET}}
923 to enter a pair of equations involving three variables.
924 (Note the leading apostrophe in this example; also, note that the space
925 between @samp{x y} is required.)  Type @w{@kbd{a S x,y @key{RET}}} to solve
926 these equations for the variables @expr{x} and @expr{y}.
928 @noindent
929 Type @kbd{d B} to view the solutions in more readable notation.
930 Type @w{@kbd{d C}} to view them in C language notation, @kbd{d T}
931 to view them in the notation for the @TeX{} typesetting system,
932 and @kbd{d L} to view them in the notation for the La@TeX{} typesetting
933 system.  Type @kbd{d N} to return to normal notation.
935 @noindent
936 Type @kbd{7.5}, then @kbd{s l a @key{RET}} to let @expr{a = 7.5} in these formulas.
937 (That's a letter @kbd{l}, not a numeral @kbd{1}.)
939 @iftex
940 @strong{Help functions.}  You can read about any command in the on-line
941 manual.  Type @kbd{M-# c} to return to Calc after each of these
942 commands: @kbd{h k t N} to read about the @kbd{t N} command,
943 @kbd{h f sqrt @key{RET}} to read about the @code{sqrt} function, and
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
948 manual.  Remember to type the letter @kbd{l}, then @kbd{M-# c}, to
949 return here after each of these commands: @w{@kbd{h k t N}} to read
950 about the @w{@kbd{t N}} command, @kbd{h f sqrt @key{RET}} to read about the
951 @code{sqrt} function, and @kbd{h s} to read the Calc summary.
952 @end ifinfo
954 Press @key{DEL} repeatedly to remove any leftover results from the stack.
955 To exit from Calc, press @kbd{q} or @kbd{M-# c} again.
957 @node Using Calc, History and Acknowledgements, Demonstration of Calc, Getting Started
958 @section Using Calc
960 @noindent
961 Calc has several user interfaces that are specialized for
962 different kinds of tasks.  As well as Calc's standard interface,
963 there are Quick mode, Keypad mode, and Embedded mode.
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
975 @node Starting Calc, The Standard Interface, Using Calc, Using Calc
976 @subsection Starting Calc
978 @noindent
979 On most systems, you can type @kbd{M-#} to start the Calculator.
980 The notation @kbd{M-#} is short for Meta-@kbd{#}.  On most
981 keyboards this means holding down the Meta (or Alt) and
982 Shift keys while typing @kbd{3}.
984 @cindex META key
985 Once 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
987 don't even have an @key{ESC} key, you can fake it by holding down
988 Control or @key{CTRL} while typing a left square bracket
989 (that's @kbd{C-[} in Emacs notation).
991 The key @kbd{M-#} is bound to the command @code{calc-dispatch}, 
992 which can be rebound if convenient.  
993 (@xref{Key Bindings,,Customizing Key Bindings,emacs,
994 The GNU Emacs Manual}.)
996 When you press @kbd{M-#}, Emacs waits for you to press a second key to
997 complete the command.  In this case, you will follow @kbd{M-#} with a
998 letter (upper- or lower-case, it doesn't matter for @kbd{M-#}) that says
999 which Calc interface you want to use.
1001 To get Calc's standard interface, type @kbd{M-# c}.  To get
1002 Keypad mode, type @kbd{M-# k}.  Type @kbd{M-# ?} to get a brief
1003 list of the available options, and type a second @kbd{?} to get
1004 a complete list.
1006 To ease typing, @kbd{M-# M-#} (or @kbd{M-# #} if that's easier)
1007 also 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
1010 a special function key set up to act like @kbd{M-#}, hitting that
1011 function key twice is just like hitting @kbd{M-# M-#}.)
1013 If @kbd{M-#} doesn't work for you, you can always type explicit
1014 commands like @kbd{M-x calc} (for the standard user interface) or
1015 @w{@kbd{M-x calc-keypad}} (for Keypad mode).  First type @kbd{M-x}
1016 (that's Meta with the letter @kbd{x}), then, at the prompt,
1017 type the full command (like @kbd{calc-keypad}) and press Return.
1019 The same commands (like @kbd{M-# c} or @kbd{M-# M-#}) that start
1020 the Calculator also turn it off if it is already on.
1022 @node The Standard Interface, Quick Mode Overview, Starting Calc, Using Calc
1023 @subsection The Standard Calc Interface
1025 @noindent
1026 @cindex Standard user interface
1027 Calc's standard interface acts like a traditional RPN calculator,
1028 operated by the normal Emacs keyboard.  When you type @kbd{M-# c}
1029 to start the Calculator, the Emacs screen splits into two windows
1030 with the file you were editing on top and Calc on the bottom.
1032 @smallexample
1033 @group
1036 --**-Emacs: myfile             (Fundamental)----All----------------------
1037 --- Emacs Calculator Mode ---                   |Emacs Calc Mode v2.1 ...
1038 2:  17.3                                        |    17.3
1039 1:  -5                                          |    3
1040     .                                           |    2
1041                                                 |    4
1042                                                 |  * 8
1043                                                 |  ->-5
1044                                                 |
1045 --%%-Calc: 12 Deg       (Calculator)----All----- --%%-Emacs: *Calc Trail*
1046 @end group
1047 @end smallexample
1049 In 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
1051 actually makes two windows side-by-side.  The lefthand one is
1052 called the @dfn{stack window} and the righthand one is called the
1053 @dfn{trail window.}  The stack holds the numbers involved in the
1054 calculation you are currently performing.  The trail holds a complete
1055 record of all calculations you have done.  In a desk calculator with
1056 a printer, the trail corresponds to the paper tape that records what
1057 you do.
1059 In this case, the trail shows that four numbers (17.3, 3, 2, and 4)
1060 were first entered into the Calculator, then the 2 and 4 were
1061 multiplied to get 8, then the 3 and 8 were subtracted to get @mathit{-5}.
1062 (The @samp{>} symbol shows that this was the most recent calculation.)
1063 The net result is the two numbers 17.3 and @mathit{-5} sitting on the stack.
1065 Most Calculator commands deal explicitly with the stack only, but
1066 there is a set of commands that allow you to search back through
1067 the trail and retrieve any previous result.
1069 Calc commands use the digits, letters, and punctuation keys.
1070 Shifted (i.e., upper-case) letters are different from lowercase
1071 letters.  Some letters are @dfn{prefix} keys that begin two-letter
1072 commands.  For example, @kbd{e} means ``enter exponent'' and shifted
1073 @kbd{E} means @expr{e^x}.  With the @kbd{d} (``display modes'') prefix
1074 the letter ``e'' takes on very different meanings:  @kbd{d e} means
1075 ``engineering notation'' and @kbd{d E} means ``@dfn{eqn} language mode.''
1077 There is nothing stopping you from switching out of the Calc
1078 window 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
1080 inside a regular window, Emacs acts just like normal.  When the
1081 cursor is in the Calc stack or trail windows, keys are interpreted
1082 as Calc commands.
1084 When you quit by pressing @kbd{M-# c} a second time, the Calculator
1085 windows go away but the actual Stack and Trail are not gone, just
1086 hidden.  When you press @kbd{M-# c} once again you will get the
1087 same stack and trail contents you had when you last used the
1088 Calculator.
1090 The Calculator does not remember its state between Emacs sessions.
1091 Thus if you quit Emacs and start it again, @kbd{M-# c} will give you
1092 a fresh stack and trail.  There is a command (@kbd{m m}) that lets
1093 you save your favorite mode settings between sessions, though.
1094 One of the things it saves is which user interface (standard or
1095 Keypad) you last used; otherwise, a freshly started Emacs will
1096 always treat @kbd{M-# M-#} the same as @kbd{M-# c}.
1098 The @kbd{q} key is another equivalent way to turn the Calculator off.
1100 If you type @kbd{M-# b} first and then @kbd{M-# c}, you get a
1101 full-screen version of Calc (@code{full-calc}) in which the stack and
1102 trail windows are still side-by-side but are now as tall as the whole
1103 Emacs screen.  When you press @kbd{q} or @kbd{M-# c} again to quit,
1104 the file you were editing before reappears.  The @kbd{M-# b} key
1105 switches back and forth between ``big'' full-screen mode and the
1106 normal partial-screen mode.
1108 Finally, @kbd{M-# o} (@code{calc-other-window}) is like @kbd{M-# c}
1109 except that the Calc window is not selected.  The buffer you were
1110 editing before remains selected instead.  @kbd{M-# o} is a handy
1111 way to switch out of Calc momentarily to edit your file; type
1112 @kbd{M-# c} to switch back into Calc when you are done.
1114 @node Quick Mode Overview, Keypad Mode Overview, The Standard Interface, Using Calc
1115 @subsection Quick Mode (Overview)
1117 @noindent
1118 @dfn{Quick mode} is a quick way to use Calc when you don't need the
1119 full complexity of the stack and trail.  To use it, type @kbd{M-# q}
1120 (@code{quick-calc}) in any regular editing buffer.
1122 Quick mode is very simple:  It prompts you to type any formula in
1123 standard algebraic notation (like @samp{4 - 2/3}) and then displays
1124 the result at the bottom of the Emacs screen (@mathit{3.33333333333}
1125 in this case).  You are then back in the same editing buffer you
1126 were in before, ready to continue editing or to type @kbd{M-# q}
1127 again to do another quick calculation.  The result of the calculation
1128 will also be in the Emacs ``kill ring'' so that a @kbd{C-y} command
1129 at this point will yank the result into your editing buffer.
1131 Calc mode settings affect Quick mode, too, though you will have to
1132 go into regular Calc (with @kbd{M-# c}) to change the mode settings.
1134 @c [fix-ref Quick Calculator mode]
1135 @xref{Quick Calculator}, for further information.
1137 @node Keypad Mode Overview, Standalone Operation, Quick Mode Overview, Using Calc
1138 @subsection Keypad Mode (Overview)
1140 @noindent
1141 @dfn{Keypad mode} is a mouse-based interface to the Calculator.
1142 It is designed for use with terminals that support a mouse.  If you
1143 don't have a mouse, you will have to operate Keypad mode with your
1144 arrow keys (which is probably more trouble than it's worth).
1146 Type @kbd{M-# k} to turn Keypad mode on or off.  Once again you
1147 get two new windows, this time on the righthand side of the screen
1148 instead of at the bottom.  The upper window is the familiar Calc
1149 Stack; the lower window is a picture of a typical calculator keypad.
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
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
1182 @end smallexample
1184 Keypad mode is much easier for beginners to learn, because there
1185 is no need to memorize lots of obscure key sequences.  But not all
1186 commands in regular Calc are available on the Keypad.  You can
1187 always switch the cursor into the Calc stack window to use
1188 standard Calc commands if you need.  Serious Calc users, though,
1189 often find they prefer the standard interface over Keypad mode.
1191 To operate the Calculator, just click on the ``buttons'' of the
1192 keypad using your left mouse button.  To enter the two numbers
1193 shown here you would click @w{@kbd{1 7 .@: 3 ENTER 5 +/- ENTER}}; to
1194 add them together you would then click @kbd{+} (to get 12.3 on
1195 the stack).
1197 If you click the right mouse button, the top three rows of the
1198 keypad change to show other sets of commands, such as advanced
1199 math functions, vector operations, and operations on binary
1200 numbers.
1202 Because Keypad mode doesn't use the regular keyboard, Calc leaves
1203 the cursor in your original editing buffer.  You can type in
1204 this buffer in the usual way while also clicking on the Calculator
1205 keypad.  One advantage of Keypad mode is that you don't need an
1206 explicit command to switch between editing and calculating.
1208 If you press @kbd{M-# b} first, you get a full-screen Keypad mode
1209 (@code{full-calc-keypad}) with three windows:  The keypad in the lower
1210 left, the stack in the lower right, and the trail on top.
1212 @c [fix-ref Keypad Mode]
1213 @xref{Keypad Mode}, for further information.
1215 @node Standalone Operation, Embedded Mode Overview, Keypad Mode Overview, Using Calc
1216 @subsection Standalone Operation
1218 @noindent
1219 @cindex Standalone Operation
1220 If you are not in Emacs at the moment but you wish to use Calc,
1221 you must start Emacs first.  If all you want is to run Calc, you
1222 can give the commands:
1224 @example
1225 emacs -f full-calc
1226 @end example
1228 @noindent
1231 @example
1232 emacs -f full-calc-keypad
1233 @end example
1235 @noindent
1236 which run a full-screen Calculator (as if by @kbd{M-# b M-# c}) or
1237 a full-screen X-based Calculator (as if by @kbd{M-# b M-# k}).
1238 In standalone operation, quitting the Calculator (by pressing
1239 @kbd{q} or clicking on the keypad @key{EXIT} button) quits Emacs
1240 itself.
1242 @node Embedded Mode Overview, Other M-# Commands, Standalone Operation, Using Calc
1243 @subsection Embedded Mode (Overview)
1245 @noindent
1246 @dfn{Embedded mode} is a way to use Calc directly from inside an
1247 editing buffer.  Suppose you have a formula written as part of a
1248 document like this:
1250 @smallexample
1251 @group
1252 The derivative of
1254                                    ln(ln(x))
1257 @end group
1258 @end smallexample
1260 @noindent
1261 and you wish to have Calc compute and format the derivative for
1262 you and store this derivative in the buffer automatically.  To
1263 do this with Embedded mode, first copy the formula down to where
1264 you want the result to be:
1266 @smallexample
1267 @group
1268 The derivative of
1270                                    ln(ln(x))
1274                                    ln(ln(x))
1275 @end group
1276 @end smallexample
1278 Now, move the cursor onto this new formula and press @kbd{M-# e}.
1279 Calc will read the formula (using the surrounding blank lines to
1280 tell how much text to read), then push this formula (invisibly)
1281 onto the Calc stack.  The cursor will stay on the formula in the
1282 editing buffer, but the buffer's mode line will change to look
1283 like the Calc mode line (with mode indicators like @samp{12 Deg}
1284 and so on).  Even though you are still in your editing buffer,
1285 the keyboard now acts like the Calc keyboard, and any new result
1286 you get is copied from the stack back into the buffer.  To take
1287 the derivative, you would type @kbd{a d x @key{RET}}.
1289 @smallexample
1290 @group
1291 The derivative of
1293                                    ln(ln(x))
1297 1 / ln(x) x
1298 @end group
1299 @end smallexample
1301 To make this look nicer, you might want to press @kbd{d =} to center
1302 the formula, and even @kbd{d B} to use Big display mode.
1304 @smallexample
1305 @group
1306 The derivative of
1308                                    ln(ln(x))
1311 % [calc-mode: justify: center]
1312 % [calc-mode: language: big]
1314                                        1
1315                                     -------
1316                                     ln(x) x
1317 @end group
1318 @end smallexample
1320 Calc has added annotations to the file to help it remember the modes
1321 that were used for this formula.  They are formatted like comments
1322 in the @TeX{} typesetting language, just in case you are using @TeX{} or
1323 La@TeX{}. (In this example @TeX{} is not being used, so you might want
1324 to move these comments up to the top of the file or otherwise put them
1325 out of the way.)
1327 As an extra flourish, we can add an equation number using a
1328 righthand label:  Type @kbd{d @} (1) @key{RET}}.
1330 @smallexample
1331 @group
1332 % [calc-mode: justify: center]
1333 % [calc-mode: language: big]
1334 % [calc-mode: right-label: " (1)"]
1336                                        1
1337                                     -------                      (1)
1338                                     ln(x) x
1339 @end group
1340 @end smallexample
1342 To leave Embedded mode, type @kbd{M-# e} again.  The mode line
1343 and keyboard will revert to the way they were before.
1345 The related command @kbd{M-# w} operates on a single word, which
1346 generally means a single number, inside text.  It uses any
1347 non-numeric characters rather than blank lines to delimit the
1348 formula it reads.  Here's an example of its use:
1350 @smallexample
1351 A slope of one-third corresponds to an angle of 1 degrees.
1352 @end smallexample
1354 Place the cursor on the @samp{1}, then type @kbd{M-# w} to enable
1355 Embedded mode on that number.  Now type @kbd{3 /} (to get one-third),
1356 and @kbd{I T} (the Inverse Tangent converts a slope into an angle),
1357 then @w{@kbd{M-# w}} again to exit Embedded mode.
1359 @smallexample
1360 A slope of one-third corresponds to an angle of 18.4349488229 degrees.
1361 @end smallexample
1363 @c [fix-ref Embedded Mode]
1364 @xref{Embedded Mode}, for full details.
1366 @node Other M-# Commands, , Embedded Mode Overview, Using Calc
1367 @subsection Other @kbd{M-#} Commands
1369 @noindent
1370 Two more Calc-related commands are @kbd{M-# g} and @kbd{M-# r},
1371 which ``grab'' data from a selected region of a buffer into the
1372 Calculator.  The region is defined in the usual Emacs way, by
1373 a ``mark'' placed at one end of the region, and the Emacs
1374 cursor or ``point'' placed at the other.
1376 The @kbd{M-# g} command reads the region in the usual left-to-right,
1377 top-to-bottom order.  The result is packaged into a Calc vector
1378 of numbers and placed on the stack.  Calc (in its standard
1379 user interface) is then started.  Type @kbd{v u} if you want
1380 to unpack this vector into separate numbers on the stack.  Also,
1381 @kbd{C-u M-# g} interprets the region as a single number or
1382 formula.
1384 The @kbd{M-# r} command reads a rectangle, with the point and
1385 mark defining opposite corners of the rectangle.  The result
1386 is a matrix of numbers on the Calculator stack.
1388 Complementary to these is @kbd{M-# y}, which ``yanks'' the
1389 value at the top of the Calc stack back into an editing buffer.
1390 If you type @w{@kbd{M-# y}} while in such a buffer, the value is
1391 yanked at the current position.  If you type @kbd{M-# y} while
1392 in the Calc buffer, Calc makes an educated guess as to which
1393 editing buffer you want to use.  The Calc window does not have
1394 to be visible in order to use this command, as long as there
1395 is something on the Calc stack.
1397 Here, for reference, is the complete list of @kbd{M-#} commands.
1398 The shift, control, and meta keys are ignored for the keystroke
1399 following @kbd{M-#}.
1401 @noindent
1402 Commands for turning Calc on and off:
1404 @table @kbd
1405 @item #
1406 Turn Calc on or off, employing the same user interface as last time.
1408 @item C
1409 Turn Calc on or off using its standard bottom-of-the-screen
1410 interface.  If Calc is already turned on but the cursor is not
1411 in the Calc window, move the cursor into the window.
1413 @item O
1414 Same as @kbd{C}, but don't select the new Calc window.  If
1415 Calc is already turned on and the cursor is in the Calc window,
1416 move it out of that window.
1418 @item B
1419 Control whether @kbd{M-# c} and @kbd{M-# k} use the full screen.
1421 @item Q
1422 Use Quick mode for a single short calculation.
1424 @item K
1425 Turn Calc Keypad mode on or off.
1427 @item E
1428 Turn Calc Embedded mode on or off at the current formula.
1430 @item J
1431 Turn Calc Embedded mode on or off, select the interesting part.
1433 @item W
1434 Turn Calc Embedded mode on or off at the current word (number).
1436 @item Z
1437 Turn Calc on in a user-defined way, as defined by a @kbd{Z I} command.
1439 @item X
1440 Quit 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
1447 @noindent
1448 Commands for moving data into and out of the Calculator:
1450 @table @kbd
1451 @item G
1452 Grab the region into the Calculator as a vector.
1454 @item R
1455 Grab the rectangular region into the Calculator as a matrix.
1457 @item :
1458 Grab the rectangular region and compute the sums of its columns.
1460 @item _
1461 Grab the rectangular region and compute the sums of its rows.
1463 @item Y
1464 Yank a value from the Calculator into the current editing buffer.
1465 @end table
1466 @iftex
1467 @sp 2
1468 @end iftex
1470 @noindent
1471 Commands for use with Embedded mode:
1473 @table @kbd
1474 @item A
1475 ``Activate'' the current buffer.  Locate all formulas that
1476 contain @samp{:=} or @samp{=>} symbols and record their locations
1477 so that they can be updated automatically as variables are changed.
1479 @item D
1480 Duplicate the current formula immediately below and select
1481 the duplicate.
1483 @item F
1484 Insert a new formula at the current point.
1486 @item N
1487 Move the cursor to the next active formula in the buffer.
1489 @item P
1490 Move the cursor to the previous active formula in the buffer.
1492 @item U
1493 Update (i.e., as if by the @kbd{=} key) the formula at the current point.
1495 @item `
1496 Edit (as if by @code{calc-edit}) the formula at the current point.
1497 @end table
1498 @iftex
1499 @sp 2
1500 @end iftex
1502 @noindent
1503 Miscellaneous commands:
1505 @table @kbd
1506 @item I
1507 Run the Emacs Info system to read the Calc manual.
1508 (This is the same as @kbd{h i} inside of Calc.)
1510 @item T
1511 Run the Emacs Info system to read the Calc Tutorial.
1513 @item S
1514 Run the Emacs Info system to read the Calc Summary.
1516 @item L
1517 Load Calc entirely into memory.  (Normally the various parts
1518 are loaded only as they are needed.)
1520 @item M
1521 Read a region of written keystroke names (like @kbd{C-n a b c @key{RET}})
1522 and record them as the current keyboard macro.
1524 @item 0
1525 (This is the ``zero'' digit key.)  Reset the Calculator to
1526 its initial state:  Empty stack, and initial mode settings.
1527 @end table
1529 @node History and Acknowledgements, , Using Calc, Getting Started
1530 @section History and Acknowledgements
1532 @noindent
1533 Calc was originally started as a two-week project to occupy a lull
1534 in the author's schedule.  Basically, a friend asked if I remembered
1535 the value of 
1536 @texline @math{2^{32}}.
1537 @infoline @expr{2^32}.  
1538 I 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
1540 question was @samp{4.294967e+09}---with no way to see the full ten
1541 digits even though we knew they were there in the program's memory!  I
1542 was so annoyed, I vowed to write a calculator of my own, once and for
1543 all.
1545 I chose Emacs Lisp, a) because I had always been curious about it
1546 and b) because, being only a text editor extension language after
1547 all, Emacs Lisp would surely reach its limits long before the project
1548 got too far out of hand.
1550 To make a long story short, Emacs Lisp turned out to be a distressingly
1551 solid implementation of Lisp, and the humble task of calculating
1552 turned out to be more open-ended than one might have expected.
1554 Emacs Lisp doesn't have built-in floating point math, so it had to be
1555 simulated in software.  In fact, Emacs integers will only comfortably
1556 fit six decimal digits or so---not enough for a decent calculator.  So
1557 I had to write my own high-precision integer code as well, and once I had
1558 this I figured that arbitrary-size integers were just as easy as large
1559 integers.  Arbitrary floating-point precision was the logical next step.
1560 Also, since the large integer arithmetic was there anyway it seemed only
1561 fair to give the user direct access to it, which in turn made it practical
1562 to support fractions as well as floats.  All these features inspired me
1563 to look around for other data types that might be worth having.
1565 Around this time, my friend Rick Koshi showed me his nifty new HP-28
1566 calculator.  It allowed the user to manipulate formulas as well as
1567 numerical quantities, and it could also operate on matrices.  I
1568 decided that these would be good for Calc to have, too.  And once
1569 things had gone this far, I figured I might as well take a look at
1570 serious algebra systems for further ideas.  Since these systems did
1571 far more than I could ever hope to implement, I decided to focus on
1572 rewrite rules and other programming features so that users could
1573 implement what they needed for themselves.
1575 Rick complained that matrices were hard to read, so I put in code to
1576 format them in a 2D style.  Once these routines were in place, Big mode
1577 was obligatory.  Gee, what other language modes would be useful?
1579 Scott Hemphill and Allen Knutson, two friends with a strong mathematical
1580 bent, contributed ideas and algorithms for a number of Calc features
1581 including modulo forms, primality testing, and float-to-fraction conversion.
1583 Units were added at the eager insistence of Mass Sivilotti.  Later,
1584 Ulrich Mueller at CERN and Przemek Klosowski at NIST provided invaluable
1585 expert assistance with the units table.  As far as I can remember, the
1586 idea of using algebraic formulas and variables to represent units dates
1587 back to an ancient article in Byte magazine about muMath, an early
1588 algebra system for microcomputers.
1590 Many people have contributed to Calc by reporting bugs and suggesting
1591 features, large and small.  A few deserve special mention:  Tim Peters,
1592 who helped develop the ideas that led to the selection commands, rewrite
1593 rules, and many other algebra features; 
1594 @texline Fran\c{c}ois
1595 @infoline Francois
1596 Pinard, who contributed an early prototype of the Calc Summary appendix
1597 as well as providing valuable suggestions in many other areas of Calc;
1598 Carl Witty, whose eagle eyes discovered many typographical and factual
1599 errors in the Calc manual; Tim Kay, who drove the development of
1600 Embedded mode; Ove Ewerlid, who made many suggestions relating to the
1601 algebra commands and contributed some code for polynomial operations;
1602 Randal Schwartz, who suggested the @code{calc-eval} function; Robert
1603 J. Chassell, who suggested the Calc Tutorial and exercises; and Juha
1604 Sarlin, who first worked out how to split Calc into quickly-loading
1605 parts.  Bob Weiner helped immensely with the Lucid Emacs port.
1607 @cindex Bibliography
1608 @cindex Knuth, Art of Computer Programming
1609 @cindex Numerical Recipes
1610 @c Should these be expanded into more complete references?
1611 Among the books used in the development of Calc were Knuth's @emph{Art
1612 of Computer Programming} (especially volume II, @emph{Seminumerical
1613 Algorithms}); @emph{Numerical Recipes} by Press, Flannery, Teukolsky,
1614 and Vetterling; Bevington's @emph{Data Reduction and Error Analysis
1615 for the Physical Sciences}; @emph{Concrete Mathematics} by Graham,
1616 Knuth, and Patashnik; Steele's @emph{Common Lisp, the Language}; the
1617 @emph{CRC Standard Math Tables} (William H. Beyer, ed.); and
1618 Abramowitz and Stegun's venerable @emph{Handbook of Mathematical
1619 Functions}.  Also, of course, Calc could not have been written without
1620 the excellent @emph{GNU Emacs Lisp Reference Manual}, by Bil Lewis and
1621 Dan LaLiberte.
1623 Final thanks go to Richard Stallman, without whose fine implementations
1624 of the Emacs editor, language, and environment, Calc would have been
1625 finished in two weeks.
1627 @c [tutorial]
1629 @ifinfo
1630 @c This node is accessed by the `M-# t' command.
1631 @node Interactive Tutorial, , , Top
1632 @chapter Tutorial
1634 @noindent
1635 Some brief instructions on using the Emacs Info system for this tutorial:
1637 Press the space bar and Delete keys to go forward and backward in a
1638 section by screenfuls (or use the regular Emacs scrolling commands
1639 for this).
1641 Press @kbd{n} or @kbd{p} to go to the Next or Previous section.
1642 If the section has a @dfn{menu}, press a digit key like @kbd{1}
1643 or @kbd{2} to go to a sub-section from the menu.  Press @kbd{u} to
1644 go back up from a sub-section to the menu it is part of.
1646 Exercises in the tutorial all have cross-references to the
1647 appropriate page of the ``answers'' section.  Press @kbd{f}, then
1648 the exercise number, to see the answer to an exercise.  After
1649 you have followed a cross-reference, you can press the letter
1650 @kbd{l} to return to where you were before.
1652 You can press @kbd{?} at any time for a brief summary of Info commands.
1654 Press @kbd{1} now to enter the first section of the Tutorial.
1656 @menu
1657 * Tutorial::
1658 @end menu
1659 @end ifinfo
1661 @node Tutorial, Introduction, Getting Started, Top
1662 @chapter Tutorial
1664 @noindent
1665 This chapter explains how to use Calc and its many features, in
1666 a step-by-step, tutorial way.  You are encouraged to run Calc and
1667 work along with the examples as you read (@pxref{Starting Calc}).
1668 If you are already familiar with advanced calculators, you may wish
1669 @c [not-split]
1670 to 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}.
1674 @c [fix-ref Embedded Mode]
1675 This tutorial describes the standard user interface of Calc only.
1676 The Quick mode and Keypad mode interfaces are fairly
1677 self-explanatory.  @xref{Embedded Mode}, for a description of
1678 the Embedded mode interface.
1680 @ifinfo
1681 The easiest way to read this tutorial on-line is to have two windows on
1682 your Emacs screen, one with Calc and one with the Info system.  (If you
1683 have 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
1685 press @kbd{M-# i} to start the Info system or to switch into its window.
1686 Or, you may prefer to use the tutorial in printed form.
1687 @end ifinfo
1688 @iftex
1689 The easiest way to read this tutorial on-line is to have two windows on
1690 your Emacs screen, one with Calc and one with the Info system.  (If you
1691 have 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
1693 press @kbd{M-# i} to start the Info system or to switch into its window.
1694 @end iftex
1696 This tutorial is designed to be done in sequence.  But the rest of this
1697 manual does not assume you have gone through the tutorial.  The tutorial
1698 does not cover everything in the Calculator, but it touches on most
1699 general areas.
1701 @ifinfo
1702 You may wish to print out a copy of the Calc Summary and keep notes on
1703 it as you learn Calc.  @xref{About This Manual}, to see how to make a
1704 printed summary.  @xref{Summary}.
1705 @end ifinfo
1706 @iftex
1707 The Calc Summary at the end of the reference manual includes some blank
1708 space for your own use.  You may wish to keep notes there as you learn
1709 Calc.
1710 @end iftex
1712 @menu
1713 * Basic Tutorial::
1714 * Arithmetic Tutorial::
1715 * Vector/Matrix Tutorial::
1716 * Types Tutorial::
1717 * Algebra Tutorial::
1718 * Programming Tutorial::
1720 * Answers to Exercises::
1721 @end menu
1723 @node Basic Tutorial, Arithmetic Tutorial, Tutorial, Tutorial
1724 @section Basic Tutorial
1726 @noindent
1727 In this section, we learn how RPN and algebraic-style calculations
1728 work, how to undo and redo an operation done by mistake, and how
1729 to control various modes of the Calculator.
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
1738 @node RPN Tutorial, Algebraic Tutorial, Basic Tutorial, Basic Tutorial
1739 @subsection RPN Calculations and the Stack
1741 @cindex RPN notation
1742 @ifinfo
1743 @noindent
1744 Calc normally uses RPN notation.  You may be familiar with the RPN
1745 system from Hewlett-Packard calculators, FORTH, or PostScript.
1746 (Reverse Polish Notation, RPN, is named after the Polish mathematician
1747 Jan Lukasiewicz.)
1748 @end ifinfo
1749 @tex
1750 \noindent
1751 Calc normally uses RPN notation.  You may be familiar with the RPN
1752 system from Hewlett-Packard calculators, FORTH, or PostScript.
1753 (Reverse Polish Notation, RPN, is named after the Polish mathematician
1754 Jan \L ukasiewicz.)
1755 @end tex
1757 The central component of an RPN calculator is the @dfn{stack}.  A
1758 calculator stack is like a stack of dishes.  New dishes (numbers) are
1759 added at the top of the stack, and numbers are normally only removed
1760 from the top of the stack.
1762 @cindex Operators
1763 @cindex Operands
1764 In an operation like @expr{2+3}, the 2 and 3 are called the @dfn{operands}
1765 and the @expr{+} is the @dfn{operator}.  In an RPN calculator you always
1766 enter the operands first, then the operator.  Each time you type a
1767 number, Calc adds or @dfn{pushes} it onto the top of the Stack.
1768 When you press an operator key like @kbd{+}, Calc @dfn{pops} the appropriate
1769 number of operands from the stack and pushes back the result.
1771 Thus 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
1773 the @key{ENTER} key on traditional RPN calculators.)  Try this now if
1774 you 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).
1776 The first four keystrokes ``push'' the numbers 2 and 3 onto the stack.
1777 The @kbd{+} key ``pops'' the top two numbers from the stack, adds them,
1778 and pushes the result (5) back onto the stack.  Here's how the stack
1779 will look at various points throughout the calculation:
1781 @smallexample
1782 @group
1783     .          1:  2          2:  2          1:  5              .
1784                    .          1:  3              .
1785                                   .
1787   M-# c          2 @key{RET}          3 @key{RET}            +             @key{DEL}
1788 @end group
1789 @end smallexample
1791 The @samp{.} symbol is a marker that represents the top of the stack.
1792 Note that the ``top'' of the stack is really shown at the bottom of
1793 the Stack window.  This may seem backwards, but it turns out to be
1794 less distracting in regular use.
1796 @cindex Stack levels
1797 @cindex Levels of stack
1798 The numbers @samp{1:} and @samp{2:} on the left are @dfn{stack level
1799 numbers}.  Old RPN calculators always had four stack levels called
1800 @expr{x}, @expr{y}, @expr{z}, and @expr{t}.  Calc's stack can grow
1801 as large as you like, so it uses numbers instead of letters.  Some
1802 stack-manipulation commands accept a numeric argument that says
1803 which stack level to work on.  Normal commands like @kbd{+} always
1804 work on the top few levels of the stack.
1806 @c [fix-ref Truncating the Stack]
1807 The Stack buffer is just an Emacs buffer, and you can move around in
1808 it using the regular Emacs motion commands.  But no matter where the
1809 cursor is, even if you have scrolled the @samp{.} marker out of
1810 view, most Calc commands always move the cursor back down to level 1
1811 before doing anything.  It is possible to move the @samp{.} marker
1812 upwards through the stack, temporarily ``hiding'' some numbers from
1813 commands like @kbd{+}.  This is called @dfn{stack truncation} and
1814 we will not cover it in this tutorial; @pxref{Truncating the Stack},
1815 if you are interested.
1817 You 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
1819 other non-numeric key when you are entering a number, the Calculator
1820 automatically enters that number and then does the requested command.
1821 Thus @kbd{2 @key{RET} 3 +} will work just as well.
1823 Examples in this tutorial will often omit @key{RET} even when the
1824 stack displays shown would only happen if you did press @key{RET}:
1826 @smallexample
1827 @group
1828 1:  2          2:  2          1:  5
1829     .          1:  3              .
1830                    .
1832   2 @key{RET}            3              +
1833 @end group
1834 @end smallexample
1836 @noindent
1837 Here, after pressing @kbd{3} the stack would really show @samp{1:  2}
1838 with @samp{Calc:@: 3} in the minibuffer.  In these situations, you can
1839 press the optional @key{RET} to see the stack as the figure shows.
1841 (@bullet{}) @strong{Exercise 1.}  (This tutorial will include exercises
1842 at various points.  Try them if you wish.  Answers to all the exercises
1843 are located at the end of the Tutorial chapter.  Each exercise will
1844 include a cross-reference to its particular answer.  If you are
1845 reading with the Emacs Info system, press @kbd{f} and the
1846 exercise number to go to the answer, then the letter @kbd{l} to
1847 return to where you were.)
1849 @noindent
1850 Here'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
1852 multiplication.)  Figure it out by hand, then try it with Calc to see
1853 if you're right.  @xref{RPN Answer 1, 1}. (@bullet{})
1855 (@bullet{}) @strong{Exercise 2.}  Compute 
1856 @texline @math{(2\times4) + (7\times9.4) + {5\over4}}
1857 @infoline @expr{2*4 + 7*9.5 + 5/4} 
1858 using the stack.  @xref{RPN Answer 2, 2}. (@bullet{})
1860 The @key{DEL} key is called Backspace on some keyboards.  It is
1861 whatever key you would use to correct a simple typing error when
1862 regularly using Emacs.  The @key{DEL} key pops and throws away the
1863 top value on the stack.  (You can still get that value back from
1864 the Trail if you should need it later on.)  There are many places
1865 in this tutorial where we assume you have used @key{DEL} to erase the
1866 results of the previous example at the beginning of a new example.
1867 In the few places where it is really important to use @key{DEL} to
1868 clear away old results, the text will remind you to do so.
1870 (It won't hurt to let things accumulate on the stack, except that
1871 whenever you give a display-mode-changing command Calc will have to
1872 spend a long time reformatting such a large stack.)
1874 Since the @kbd{-} key is also an operator (it subtracts the top two
1875 stack elements), how does one enter a negative number?  Calc uses
1876 the @kbd{_} (underscore) key to act like the minus sign in a number.
1877 So, typing @kbd{-5 @key{RET}} won't work because the @kbd{-} key
1878 will try to do a subtraction, but @kbd{_5 @key{RET}} works just fine.
1880 You can also press @kbd{n}, which means ``change sign.''  It changes
1881 the number at the top of the stack (or the number being entered)
1882 from positive to negative or vice-versa:  @kbd{5 n @key{RET}}.
1884 @cindex Duplicating a stack entry
1885 If you press @key{RET} when you're not entering a number, the effect
1886 is to duplicate the top number on the stack.  Consider this calculation:
1888 @smallexample
1889 @group
1890 1:  3          2:  3          1:  9          2:  9          1:  81
1891     .          1:  3              .          1:  9              .
1892                    .                             .
1894   3 @key{RET}           @key{RET}             *             @key{RET}             *
1895 @end group
1896 @end smallexample
1898 @noindent
1899 (Of course, an easier way to do this would be @kbd{3 @key{RET} 4 ^},
1900 to raise 3 to the fourth power.)
1902 The space-bar key (denoted @key{SPC} here) performs the same function
1903 as @key{RET}; you could replace all three occurrences of @key{RET} in
1904 the above example with @key{SPC} and the effect would be the same.
1906 @cindex Exchanging stack entries
1907 Another stack manipulation key is @key{TAB}.  This exchanges the top
1908 two stack entries.  Suppose you have computed @kbd{2 @key{RET} 3 +}
1909 to get 5, and then you realize what you really wanted to compute
1910 was @expr{20 / (2+3)}.
1912 @smallexample
1913 @group
1914 1:  5          2:  5          2:  20         1:  4
1915     .          1:  20         1:  5              .
1916                    .              .
1918  2 @key{RET} 3 +         20            @key{TAB}             /
1919 @end group
1920 @end smallexample
1922 @noindent
1923 Planning ahead, the calculation would have gone like this:
1925 @smallexample
1926 @group
1927 1:  20         2:  20         3:  20         2:  20         1:  4
1928     .          1:  2          2:  2          1:  5              .
1929                    .          1:  3              .
1930                                   .
1932   20 @key{RET}         2 @key{RET}            3              +              /
1933 @end group
1934 @end smallexample
1936 A 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,
1938 bringing the object in level 3 to the top.
1940 @smallexample
1941 @group
1942 1:  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                                   .              .              .
1947   10 @key{RET}         20 @key{RET}         30 @key{RET}         M-@key{TAB}          M-@key{TAB}
1948 @end group
1949 @end smallexample
1951 (@bullet{}) @strong{Exercise 3.} Suppose the numbers 10, 20, and 30 are
1952 on the stack.  Figure out how to add one to the number in level 2
1953 without affecting the rest of the stack.  Also figure out how to add
1954 one to the number in level 3.  @xref{RPN Answer 3, 3}. (@bullet{})
1956 Operations like @kbd{+}, @kbd{-}, @kbd{*}, @kbd{/}, and @kbd{^} pop two
1957 arguments 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
1959 think of them as simply operating on the top element of the stack.
1961 @smallexample
1962 @group
1963 1:  3          1:  9          2:  9          1:  25         1:  5
1964     .              .          1:  16             .              .
1965                                   .
1967   3 @key{RET}          @key{RET} *        4 @key{RET} @key{RET} *        +              Q
1968 @end group
1969 @end smallexample
1971 @noindent
1972 (Note that capital @kbd{Q} means to hold down the Shift key while
1973 typing @kbd{q}.  Remember, plain unshifted @kbd{q} is the Quit command.)
1975 @cindex Pythagorean Theorem
1976 Here we've used the Pythagorean Theorem to determine the hypotenuse of a
1977 right 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.
1979 We can still enter it by its full name using @kbd{M-x} notation:
1981 @smallexample
1982 @group
1983 1:  3          2:  3          1:  5
1984     .          1:  4              .
1985                    .
1987   3 @key{RET}          4 @key{RET}      M-x calc-hypot
1988 @end group
1989 @end smallexample
1991 All Calculator commands begin with the word @samp{calc-}.  Since it
1992 gets tiring to type this, Calc provides an @kbd{x} key which is just
1993 like the regular Emacs @kbd{M-x} key except that it types the @samp{calc-}
1994 prefix for you:
1996 @smallexample
1997 @group
1998 1:  3          2:  3          1:  5
1999     .          1:  4              .
2000                    .
2002   3 @key{RET}          4 @key{RET}         x hypot
2003 @end group
2004 @end smallexample
2006 What happens if you take the square root of a negative number?
2008 @smallexample
2009 @group
2010 1:  4          1:  -4         1:  (0, 2)
2011     .              .              .
2013   4 @key{RET}            n              Q
2014 @end group
2015 @end smallexample
2017 @noindent
2018 The notation @expr{(a, b)} represents a complex number.
2019 Complex numbers are more traditionally written @expr{a + b i};
2020 Calc can display in this format, too, but for now we'll stick to the
2021 @expr{(a, b)} notation.
2023 If you don't know how complex numbers work, you can safely ignore this
2024 feature.  Complex numbers only arise from operations that would be
2025 errors in a calculator that didn't have complex numbers.  (For example,
2026 taking the square root or logarithm of a negative number produces a
2027 complex result.)
2029 Complex numbers are entered in the notation shown.  The @kbd{(} and
2030 @kbd{,} and @kbd{)} keys manipulate ``incomplete complex numbers.''
2032 @smallexample
2033 @group
2034 1:  ( ...      2:  ( ...      1:  (2, ...    1:  (2, ...    1:  (2, 3)
2035     .          1:  2              .              3              .
2036                    .                             .
2038     (              2              ,              3              )
2039 @end group
2040 @end smallexample
2042 You can perform calculations while entering parts of incomplete objects.
2043 However, an incomplete object cannot actually participate in a calculation:
2045 @smallexample
2046 @group
2047 1:  ( ...      2:  ( ...      3:  ( ...      1:  ( ...      1:  ( ...
2048     .          1:  2          2:  2              5              5
2049                    .          1:  3              .              .
2050                                   .
2051                                                              (error)
2052     (             2 @key{RET}           3              +              +
2053 @end group
2054 @end smallexample
2056 @noindent
2057 Adding 5 to an incomplete object makes no sense, so the last command
2058 produces an error message and leaves the stack the same.
2060 Incomplete objects can't participate in arithmetic, but they can be
2061 moved around by the regular stack commands.
2063 @smallexample
2064 @group
2065 2:  2          3:  2          3:  3          1:  ( ...      1:  (2, 3)
2066 1:  3          2:  3          2:  ( ...          2              .
2067     .          1:  ( ...      1:  2              3
2068                    .              .              .
2070 2 @key{RET} 3 @key{RET}        (            M-@key{TAB}          M-@key{TAB}            )
2071 @end group
2072 @end smallexample
2074 @noindent
2075 Note that the @kbd{,} (comma) key did not have to be used here.
2076 When you press @kbd{)} all the stack entries between the incomplete
2077 entry and the top are collected, so there's never really a reason
2078 to use the comma.  It's up to you.
2080 (@bullet{}) @strong{Exercise 4.}  To enter the complex number @expr{(2, 3)},
2081 your friend Joe typed @kbd{( 2 , @key{SPC} 3 )}.  What happened?
2082 (Joe thought of a clever way to correct his mistake in only two
2083 keystrokes, but it didn't quite work.  Try it to find out why.)
2084 @xref{RPN Answer 4, 4}. (@bullet{})
2086 Vectors are entered the same way as complex numbers, but with square
2087 brackets in place of parentheses.  We'll meet vectors again later in
2088 the tutorial.
2090 Any Emacs command can be given a @dfn{numeric prefix argument} by
2091 typing a series of @key{META}-digits beforehand.  If @key{META} is
2092 awkward for you, you can instead type @kbd{C-u} followed by the
2093 necessary 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
2095 prefix arguments in a variety of ways.  For example, a numeric prefix
2096 on the @kbd{+} operator adds any number of stack entries at once:
2098 @smallexample
2099 @group
2100 1:  10         2:  10         3:  10         3:  10         1:  60
2101     .          1:  20         2:  20         2:  20             .
2102                    .          1:  30         1:  30
2103                                   .              .
2105   10 @key{RET}         20 @key{RET}         30 @key{RET}         C-u 3            +
2106 @end group
2107 @end smallexample
2109 For stack manipulation commands like @key{RET}, a positive numeric
2110 prefix argument operates on the top @var{n} stack entries at once.  A
2111 negative argument operates on the entry in level @var{n} only.  An
2112 argument of zero operates on the entire stack.  In this example, we copy
2113 the second-to-top element of the stack:
2115 @smallexample
2116 @group
2117 1:  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                                                                 .
2123   10 @key{RET}         20 @key{RET}         30 @key{RET}         C-u -2          @key{RET}
2124 @end group
2125 @end smallexample
2127 @cindex Clearing the stack
2128 @cindex Emptying the stack
2129 Another common idiom is @kbd{M-0 @key{DEL}}, which clears the stack.
2130 (The @kbd{M-0} numeric prefix tells @key{DEL} to operate on the
2131 entire stack.)
2133 @node Algebraic Tutorial, Undo Tutorial, RPN Tutorial, Basic Tutorial
2134 @subsection Algebraic-Style Calculations
2136 @noindent
2137 If you are not used to RPN notation, you may prefer to operate the
2138 Calculator in Algebraic mode, which is closer to the way
2139 non-RPN calculators work.  In Algebraic mode, you enter formulas
2140 in traditional @expr{2+3} notation.
2142 You don't really need any special ``mode'' to enter algebraic formulas.
2143 You can enter a formula at any time by pressing the apostrophe (@kbd{'})
2144 key.  Answer the prompt with the desired formula, then press @key{RET}.
2145 The formula is evaluated and the result is pushed onto the RPN stack.
2146 If you don't want to think in RPN at all, you can enter your whole
2147 computation as a formula, read the result from the stack, then press
2148 @key{DEL} to delete it from the stack.
2150 Try pressing the apostrophe key, then @kbd{2+3+4}, then @key{RET}.
2151 The result should be the number 9.
2153 Algebraic formulas use the operators @samp{+}, @samp{-}, @samp{*},
2154 @samp{/}, and @samp{^}.  You can use parentheses to make the order
2155 of evaluation clear.  In the absence of parentheses, @samp{^} is
2156 evaluated first, then @samp{*}, then @samp{/}, then finally
2157 @samp{+} and @samp{-}.  For example, the expression
2159 @example
2160 2 + 3*4*5 / 6*7^8 - 9
2161 @end example
2163 @noindent
2164 is equivalent to
2166 @example
2167 2 + ((3*4*5) / (6*(7^8)) - 9
2168 @end example
2170 @noindent
2171 or, in large mathematical notation,
2173 @ifinfo
2174 @example
2175 @group
2176     3 * 4 * 5
2177 2 + --------- - 9
2178           8
2179      6 * 7
2180 @end group
2181 @end example
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
2190 @noindent
2191 The result of this expression will be the number @mathit{-6.99999826533}.
2193 Calc's order of evaluation is the same as for most computer languages,
2194 except that @samp{*} binds more strongly than @samp{/}, as the above
2195 example shows.  As in normal mathematical notation, the @samp{*} symbol
2196 can often be omitted:  @samp{2 a} is the same as @samp{2*a}.
2198 Operators at the same level are evaluated from left to right, except
2199 that @samp{^} is evaluated from right to left.  Thus, @samp{2-3-4} is
2200 equivalent to @samp{(2-3)-4} or @mathit{-5}, whereas @samp{2^3^4} is equivalent
2201 to @samp{2^(3^4)} (a very large integer; try it!).
2203 If you tire of typing the apostrophe all the time, there is
2204 Algebraic mode, where Calc automatically senses
2205 when you are about to type an algebraic expression.  To enter this
2206 mode, press the two letters @w{@kbd{m a}}.  (An @samp{Alg} indicator
2207 should appear in the Calc window's mode line.)
2209 Press @kbd{m a}, then @kbd{2+3+4} with no apostrophe, then @key{RET}.
2211 In Algebraic mode, when you press any key that would normally begin
2212 entering a number (such as a digit, a decimal point, or the @kbd{_}
2213 key), or if you press @kbd{(} or @kbd{[}, Calc automatically begins
2214 an algebraic entry.
2216 Functions which do not have operator symbols like @samp{+} and @samp{*}
2217 must be entered in formulas using function-call notation.  For example,
2218 the 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
2220 the notation @samp{sqrt(@var{x})}.
2222 Press the apostrophe, then type @kbd{sqrt(5*2) - 3}.  The result should
2223 be @expr{0.16227766017}.
2225 Note that if the formula begins with a function name, you need to use
2226 the apostrophe even if you are in Algebraic mode.  If you type @kbd{arcsin}
2227 out of the blue, the @kbd{a r} will be taken as an Algebraic Rewrite
2228 command, and the @kbd{csin} will be taken as the name of the rewrite
2229 rule to use!
2231 Some people prefer to enter complex numbers and vectors in algebraic
2232 form because they find RPN entry with incomplete objects to be too
2233 distracting, even though they otherwise use Calc as an RPN calculator.
2235 Still in Algebraic mode, type:
2237 @smallexample
2238 @group
2239 1:  (2, 3)     2:  (2, 3)     1:  (8, -1)    2:  (8, -1)    1:  (9, -1)
2240     .          1:  (1, -2)        .          1:  1              .
2241                    .                             .
2243  (2,3) @key{RET}      (1,-2) @key{RET}        *              1 @key{RET}          +
2244 @end group
2245 @end smallexample
2247 Algebraic mode allows us to enter complex numbers without pressing
2248 an apostrophe first, but it also means we need to press @key{RET}
2249 after every entry, even for a simple number like @expr{1}.
2251 (You can type @kbd{C-u m a} to enable a special Incomplete Algebraic
2252 mode in which the @kbd{(} and @kbd{[} keys use algebraic entry even
2253 though regular numeric keys still use RPN numeric entry.  There is also
2254 Total Algebraic mode, started by typing @kbd{m t}, in which all
2255 normal keys begin algebraic entry.  You must then use the @key{META} key
2256 to type Calc commands:  @kbd{M-m t} to get back out of Total Algebraic
2257 mode, @kbd{M-q} to quit, etc.)
2259 If you're still in Algebraic mode, press @kbd{m a} again to turn it off.
2261 Actual non-RPN calculators use a mixture of algebraic and RPN styles.
2262 In general, operators of two numbers (like @kbd{+} and @kbd{*})
2263 use algebraic form, but operators of one number (like @kbd{n} and @kbd{Q})
2264 use RPN form.  Also, a non-RPN calculator allows you to see the
2265 intermediate results of a calculation as you go along.  You can
2266 accomplish this in Calc by performing your calculation as a series
2267 of algebraic entries, using the @kbd{$} sign to tie them together.
2268 In an algebraic formula, @kbd{$} represents the number on the top
2269 of the stack.  Here, we perform the calculation 
2270 @texline @math{\sqrt{2\times4+1}},
2271 @infoline @expr{sqrt(2*4+1)},
2272 which on a traditional calculator would be done by pressing
2273 @kbd{2 * 4 + 1 =} and then the square-root key.
2275 @smallexample
2276 @group
2277 1:  8          1:  9          1:  3
2278     .              .              .
2280   ' 2*4 @key{RET}        $+1 @key{RET}        Q
2281 @end group
2282 @end smallexample
2284 @noindent
2285 Notice that we didn't need to press an apostrophe for the @kbd{$+1},
2286 because the dollar sign always begins an algebraic entry.
2288 (@bullet{}) @strong{Exercise 1.}  How could you get the same effect as
2289 pressing @kbd{Q} but using an algebraic entry instead?  How about
2290 if the @kbd{Q} key on your keyboard were broken?
2291 @xref{Algebraic Answer 1, 1}. (@bullet{})
2293 The notations @kbd{$$}, @kbd{$$$}, and so on stand for higher stack
2294 entries.  For example, @kbd{' $$+$ @key{RET}} is just like typing @kbd{+}.
2296 Algebraic formulas can include @dfn{variables}.  To store in a
2297 variable, 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
2300 on the stack, while @w{@kbd{s t}} removes a number from the stack and
2301 stores it in the variable.)  A variable name should consist of one
2302 or more letters or digits, beginning with a letter.
2304 @smallexample
2305 @group
2306 1:  17             .          1:  a + a^2    1:  306
2307     .                             .              .
2309     17          s t a @key{RET}      ' a+a^2 @key{RET}       =
2310 @end group
2311 @end smallexample
2313 @noindent
2314 The @kbd{=} key @dfn{evaluates} a formula by replacing all its
2315 variables by the values that were stored in them.
2317 For RPN calculations, you can recall a variable's value on the
2318 stack either by entering its name as a formula and pressing @kbd{=},
2319 or by using the @kbd{s r} command.
2321 @smallexample
2322 @group
2323 1:  17         2:  17         3:  17         2:  17         1:  306
2324     .          1:  17         2:  17         1:  289            .
2325                    .          1:  2              .
2326                                   .
2328   s r a @key{RET}     ' a @key{RET} =         2              ^              +
2329 @end group
2330 @end smallexample
2332 If you press a single digit for a variable name (as in @kbd{s t 3}, you
2333 get one of ten @dfn{quick variables} @code{q0} through @code{q9}.
2334 They 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
2336 simply @kbd{s 3} as a shorthand for @kbd{s s 3}, and likewise for
2337 @kbd{t 3} and @w{@kbd{r 3}}.
2339 Any variables in an algebraic formula for which you have not stored
2340 values are left alone, even when you evaluate the formula.
2342 @smallexample
2343 @group
2344 1:  2 a + 2 b     1:  34 + 2 b
2345     .                 .
2347  ' 2a+2b @key{RET}          =
2348 @end group
2349 @end smallexample
2351 Calls to function names which are undefined in Calc are also left
2352 alone, as are calls for which the value is undefined.
2354 @smallexample
2355 @group
2356 1:  2 + log10(0) + log10(x) + log10(5, 6) + foo(3)
2357     .
2359  ' log10(100) + log10(0) + log10(x) + log10(5,6) + foo(3) @key{RET}
2360 @end group
2361 @end smallexample
2363 @noindent
2364 In this example, the first call to @code{log10} works, but the other
2365 calls are not evaluated.  In the second call, the logarithm is
2366 undefined for that value of the argument; in the third, the argument
2367 is symbolic, and in the fourth, there are too many arguments.  In the
2368 fifth case, there is no function called @code{foo}.  You will see a
2369 ``Wrong number of arguments'' message referring to @samp{log10(5,6)}.
2370 Press the @kbd{w} (``why'') key to see any other messages that may
2371 have arisen from the last calculation.  In this case you will get
2372 ``logarithm of zero,'' then ``number expected: @code{x}''.  Calc
2373 automatically displays the first message only if the message is
2374 sufficiently important; for example, Calc considers ``wrong number
2375 of arguments'' and ``logarithm of zero'' to be important enough to
2376 report automatically, while a message like ``number expected: @code{x}''
2377 will only show up if you explicitly press the @kbd{w} key.
2379 (@bullet{}) @strong{Exercise 2.}  Joe entered the formula @samp{2 x y},
2380 stored 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)},
2382 expecting @samp{10 (1+y)}, but it didn't work.  Why not?
2383 @xref{Algebraic Answer 2, 2}. (@bullet{})
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{})
2389 One interesting way to work with variables is to use the
2390 @dfn{evaluates-to} (@samp{=>}) operator.  It works like this:
2391 Enter a formula algebraically in the usual way, but follow
2392 the formula with an @samp{=>} symbol.  (There is also an @kbd{s =}
2393 command which builds an @samp{=>} formula using the stack.)  On
2394 the stack, you will see two copies of the formula with an @samp{=>}
2395 between them.  The lefthand formula is exactly like you typed it;
2396 the righthand formula has been evaluated as if by typing @kbd{=}.
2398 @smallexample
2399 @group
2400 2:  2 + 3 => 5                     2:  2 + 3 => 5
2401 1:  2 a + 2 b => 34 + 2 b          1:  2 a + 2 b => 20 + 2 b
2402     .                                  .
2404 ' 2+3 => @key{RET}  ' 2a+2b @key{RET} s =          10 s t a @key{RET}
2405 @end group
2406 @end smallexample
2408 @noindent
2409 Notice that the instant we stored a new value in @code{a}, all
2410 @samp{=>} operators already on the stack that referred to @expr{a}
2411 were updated to use the new value.  With @samp{=>}, you can push a
2412 set of formulas on the stack, then change the variables experimentally
2413 to see the effects on the formulas' values.
2415 You can also ``unstore'' a variable when you are through with it:
2417 @smallexample
2418 @group
2419 2:  2 + 5 => 5
2420 1:  2 a + 2 b => 2 a + 2 b
2421     .
2423     s u a @key{RET}
2424 @end group
2425 @end smallexample
2427 We will encounter formulas involving variables and functions again
2428 when we discuss the algebra and calculus features of the Calculator.
2430 @node Undo Tutorial, Modes Tutorial, Algebraic Tutorial, Basic Tutorial
2431 @subsection Undo and Redo
2433 @noindent
2434 If you make a mistake, you can usually correct it by pressing shift-@kbd{U},
2435 the ``undo'' command.  First, clear the stack (@kbd{M-0 @key{DEL}}) and exit
2436 and restart Calc (@kbd{M-# M-# M-# M-#}) to make sure things start off
2437 with a clean slate.  Now:
2439 @smallexample
2440 @group
2441 1:  2          2:  2          1:  8          2:  2          1:  6
2442     .          1:  3              .          1:  3              .
2443                    .                             .
2445    2 @key{RET}           3              ^              U              *
2446 @end group
2447 @end smallexample
2449 You can undo any number of times.  Calc keeps a complete record of
2450 all you have done since you last opened the Calc window.  After the
2451 above example, you could type:
2453 @smallexample
2454 @group
2455 1:  6          2:  2          1:  2              .              .
2456     .          1:  3              .
2457                    .
2458                                                              (error)
2459                    U              U              U              U
2460 @end group
2461 @end smallexample
2463 You can also type @kbd{D} to ``redo'' a command that you have undone
2464 mistakenly.
2466 @smallexample
2467 @group
2468     .          1:  2          2:  2          1:  6          1:  6
2469                    .          1:  3              .              .
2470                                   .
2471                                                              (error)
2472                    D              D              D              D
2473 @end group
2474 @end smallexample
2476 @noindent
2477 It was not possible to redo past the @expr{6}, since that was placed there
2478 by something other than an undo command.
2480 @cindex Time travel
2481 You 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
2483 backward and do something (like @kbd{*}) then, as any science fiction
2484 reader knows, you have changed your future and you cannot go forward
2485 again.  Thus, the inability to redo past the @expr{6} even though there
2486 was an earlier undo command.
2488 You can always recall an earlier result using the Trail.  We've ignored
2489 the trail so far, but it has been faithfully recording everything we
2490 did since we loaded the Calculator.  If the Trail is not displayed,
2491 press @kbd{t d} now to turn it on.
2493 Let's try grabbing an earlier result.  The @expr{8} we computed was
2494 undone 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
2497 entry.  If there isn't, press @kbd{t ]} to reset the trail pointer.
2498 Now, press @w{@kbd{t p}} to move the arrow onto the line containing
2499 @expr{8}, and press @w{@kbd{t y}} to ``yank'' that number back onto the
2500 stack.
2502 If you press @kbd{t ]} again, you will see that even our Yank command
2503 went into the trail.
2505 Let's go further back in time.  Earlier in the tutorial we computed
2506 a huge integer using the formula @samp{2^3^4}.  We don't remember
2507 what it was, but the first digits were ``241''.  Press @kbd{t r}
2508 (which stands for trail-search-reverse), then type @kbd{241}.
2509 The trail cursor will jump back to the next previous occurrence of
2510 the string ``241'' in the trail.  This is just a regular Emacs
2511 incremental search; you can now press @kbd{C-s} or @kbd{C-r} to
2512 continue the search forwards or backwards as you like.
2514 To finish the search, press @key{RET}.  This halts the incremental
2515 search and leaves the trail pointer at the thing we found.  Now we
2516 can type @kbd{t y} to yank that number onto the stack.  If we hadn't
2517 remembered the ``241'', we could simply have searched for @kbd{2^3^4},
2518 then pressed @kbd{@key{RET} t n} to halt and then move to the next item.
2520 You may have noticed that all the trail-related commands begin with
2521 the letter @kbd{t}.  (The store-and-recall commands, on the other hand,
2522 all began with @kbd{s}.)  Calc has so many commands that there aren't
2523 enough keys for all of them, so various commands are grouped into
2524 two-letter sequences where the first letter is called the @dfn{prefix}
2525 key.  If you type a prefix key by accident, you can press @kbd{C-g}
2526 to cancel it.  (In fact, you can press @kbd{C-g} to cancel almost
2527 anything in Emacs.)  To get help on a prefix key, press that key
2528 followed by @kbd{?}.  Some prefixes have several lines of help,
2529 so you need to press @kbd{?} repeatedly to see them all.  
2530 You can also type @kbd{h h} to see all the help at once.
2532 Try pressing @kbd{t ?} now.  You will see a line of the form,
2534 @smallexample
2535 trail/time: Display; Fwd, Back; Next, Prev, Here, [, ]; Yank:  [MORE]  t-
2536 @end smallexample
2538 @noindent
2539 The word ``trail'' indicates that the @kbd{t} prefix key contains
2540 trail-related commands.  Each entry on the line shows one command,
2541 with a single capital letter showing which letter you press to get
2542 that 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{?}
2544 again to see more @kbd{t}-prefix commands.  Notice that the commands
2545 are roughly divided (by semicolons) into related groups.
2547 When you are in the help display for a prefix key, the prefix is
2548 still active.  If you press another key, like @kbd{y} for example,
2549 it will be interpreted as a @kbd{t y} command.  If all you wanted
2550 was to look at the help messages, press @kbd{C-g} afterwards to cancel
2551 the prefix.
2553 One more way to correct an error is by editing the stack entries.
2554 The actual Stack buffer is marked read-only and must not be edited
2555 directly, but you can press @kbd{`} (the backquote or accent grave)
2556 to edit a stack entry.
2558 Try entering @samp{3.141439} now.  If this is supposed to represent
2559 @cpi{}, it's got several errors.  Press @kbd{`} to edit this number.
2560 Now use the normal Emacs cursor motion and editing keys to change
2561 the second 4 to a 5, and to transpose the 3 and the 9.  When you
2562 press @key{RET}, the number on the stack will be replaced by your
2563 new number.  This works for formulas, vectors, and all other types
2564 of values you can put on the stack.  The @kbd{`} key also works
2565 during entry of a number or algebraic formula.
2567 @node Modes Tutorial, , Undo Tutorial, Basic Tutorial
2568 @subsection Mode-Setting Commands
2570 @noindent
2571 Calc has many types of @dfn{modes} that affect the way it interprets
2572 your commands or the way it displays data.  We have already seen one
2573 mode, namely Algebraic mode.  There are many others, too; we'll
2574 try some of the most common ones here.
2576 Perhaps the most fundamental mode in Calc is the current @dfn{precision}.
2577 Notice the @samp{12} on the Calc window's mode line:
2579 @smallexample
2580 --%%-Calc: 12 Deg       (Calculator)----All------
2581 @end smallexample
2583 @noindent
2584 Most of the symbols there are Emacs things you don't need to worry
2585 about, but the @samp{12} and the @samp{Deg} are mode indicators.
2586 The @samp{12} means that calculations should always be carried to
2587 12 significant figures.  That is why, when we type @kbd{1 @key{RET} 7 /},
2588 we get @expr{0.142857142857} with exactly 12 digits, not counting
2589 leading and trailing zeros.
2591 You can set the precision to anything you like by pressing @kbd{p},
2592 then entering a suitable number.  Try pressing @kbd{p 30 @key{RET}},
2593 then doing @kbd{1 @key{RET} 7 /} again:
2595 @smallexample
2596 @group
2597 1:  0.142857142857
2598 2:  0.142857142857142857142857142857
2599     .
2600 @end group
2601 @end smallexample
2603 Although the precision can be set arbitrarily high, Calc always
2604 has to have @emph{some} value for the current precision.  After
2605 all, the true value @expr{1/7} is an infinitely repeating decimal;
2606 Calc has to stop somewhere.
2608 Of course, calculations are slower the more digits you request.
2609 Press @w{@kbd{p 12}} now to set the precision back down to the default.
2611 Calculations always use the current precision.  For example, even
2612 though we have a 30-digit value for @expr{1/7} on the stack, if
2613 we use it in a calculation in 12-digit mode it will be rounded
2614 down to 12 digits before it is used.  Try it; press @key{RET} to
2615 duplicate the number, then @w{@kbd{1 +}}.  Notice that the @key{RET}
2616 key didn't round the number, because it doesn't do any calculation.
2617 But the instant we pressed @kbd{+}, the number was rounded down.
2619 @smallexample
2620 @group
2621 1:  0.142857142857
2622 2:  0.142857142857142857142857142857
2623 3:  1.14285714286
2624     .
2625 @end group
2626 @end smallexample
2628 @noindent
2629 In fact, since we added a digit on the left, we had to lose one
2630 digit on the right from even the 12-digit value of @expr{1/7}.
2632 How did we get more than 12 digits when we computed @samp{2^3^4}?  The
2633 answer is that Calc makes a distinction between @dfn{integers} and
2634 @dfn{floating-point} numbers, or @dfn{floats}.  An integer is a number
2635 that 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
2637 itself.  If you asked for @samp{2^10000} (don't try this!), you would
2638 have to wait a long time but you would eventually get an exact answer.
2639 If you ask for @samp{2.^10000}, you will quickly get an answer which is
2640 correct only to 12 places.  The decimal point tells Calc that it should
2641 use floating-point arithmetic to get the answer, not exact integer
2642 arithmetic.
2644 You can use the @kbd{F} (@code{calc-floor}) command to convert a
2645 floating-point value to an integer, and @kbd{c f} (@code{calc-float})
2646 to convert an integer to floating-point form.
2648 Let's try entering that last calculation:
2650 @smallexample
2651 @group
2652 1:  2.         2:  2.         1:  1.99506311689e3010
2653     .          1:  10000          .
2654                    .
2656   2.0 @key{RET}          10000 @key{RET}      ^
2657 @end group
2658 @end smallexample
2660 @noindent
2661 @cindex Scientific notation, entry of
2662 Notice the letter @samp{e} in there.  It represents ``times ten to the
2663 power of,'' and is used by Calc automatically whenever writing the
2664 number out fully would introduce more extra zeros than you probably
2665 want to see.  You can enter numbers in this notation, too.
2667 @smallexample
2668 @group
2669 1:  2.         2:  2.         1:  1.99506311678e3010
2670     .          1:  10000.         .
2671                    .
2673   2.0 @key{RET}          1e4 @key{RET}        ^
2674 @end group
2675 @end smallexample
2677 @cindex Round-off errors
2678 @noindent
2679 Hey, the answer is different!  Look closely at the middle columns
2680 of the two examples.  In the first, the stack contained the
2681 exact integer @expr{10000}, but in the second it contained
2682 a floating-point value with a decimal point.  When you raise a
2683 number to an integer power, Calc uses repeated squaring and
2684 multiplication to get the answer.  When you use a floating-point
2685 power, Calc uses logarithms and exponentials.  As you can see,
2686 a slight error crept in during one of these methods.  Which
2687 one should we trust?  Let's raise the precision a bit and find
2688 out:
2690 @smallexample
2691 @group
2692     .          1:  2.         2:  2.         1:  1.995063116880828e3010
2693                    .          1:  10000.         .
2694                                   .
2696  p 16 @key{RET}        2. @key{RET}           1e4            ^    p 12 @key{RET}
2697 @end group
2698 @end smallexample
2700 @noindent
2701 @cindex Guard digits
2702 Presumably, it doesn't matter whether we do this higher-precision
2703 calculation using an integer or floating-point power, since we
2704 have added enough ``guard digits'' to trust the first 12 digits
2705 no matter what.  And the verdict is@dots{}  Integer powers were more
2706 accurate; in fact, the result was only off by one unit in the
2707 last place.
2709 @cindex Guard digits
2710 Calc does many of its internal calculations to a slightly higher
2711 precision, but it doesn't always bump the precision up enough.
2712 In each case, Calc added about two digits of precision during
2713 its calculation and then rounded back down to 12 digits
2714 afterward.  In one case, it was enough; in the other, it
2715 wasn't.  If you really need @var{x} digits of precision, it
2716 never hurts to do the calculation with a few extra guard digits.
2718 What if we want guard digits but don't want to look at them?
2719 We can set the @dfn{float format}.  Calc supports four major
2720 formats for floating-point numbers, called @dfn{normal},
2721 @dfn{fixed-point}, @dfn{scientific notation}, and @dfn{engineering
2722 notation}.  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
2724 supply a numeric prefix argument which says how many digits
2725 should be displayed.  As an example, let's put a few numbers
2726 onto the stack and try some different display modes.  First,
2727 use @kbd{M-0 @key{DEL}} to clear the stack, then enter the four
2728 numbers shown here:
2730 @smallexample
2731 @group
2732 4:  12345      4:  12345      4:  12345      4:  12345      4:  12345
2733 3:  12345.     3:  12300.     3:  1.2345e4   3:  1.23e4     3:  12345.000
2734 2:  123.45     2:  123.       2:  1.2345e2   2:  1.23e2     2:  123.450
2735 1:  12.345     1:  12.3       1:  1.2345e1   1:  1.23e1     1:  12.345
2736     .              .              .              .              .
2738    d n          M-3 d n          d s          M-3 d s        M-3 d f
2739 @end group
2740 @end smallexample
2742 @noindent
2743 Notice that when we typed @kbd{M-3 d n}, the numbers were rounded down
2744 to three significant digits, but then when we typed @kbd{d s} all
2745 five significant figures reappeared.  The float format does not
2746 affect how numbers are stored, it only affects how they are
2747 displayed.  Only the current precision governs the actual rounding
2748 of numbers in the Calculator's memory.
2750 Engineering notation, not shown here, is like scientific notation
2751 except the exponent (the power-of-ten part) is always adjusted to be
2752 a multiple of three (as in ``kilo,'' ``micro,'' etc.).  As a result
2753 there will be one, two, or three digits before the decimal point.
2755 Whenever you change a display-related mode, Calc redraws everything
2756 in the stack.  This may be slow if there are many things on the stack,
2757 so Calc allows you to type shift-@kbd{H} before any mode command to
2758 prevent it from updating the stack.  Anything Calc displays after the
2759 mode-changing command will appear in the new format.
2761 @smallexample
2762 @group
2763 4:  12345      4:  12345      4:  12345      4:  12345      4:  12345
2764 3:  12345.000  3:  12345.000  3:  12345.000  3:  1.2345e4   3:  12345.
2765 2:  123.450    2:  123.450    2:  1.2345e1   2:  1.2345e1   2:  123.45
2766 1:  12.345     1:  1.2345e1   1:  1.2345e2   1:  1.2345e2   1:  12.345
2767     .              .              .              .              .
2769     H d s          @key{DEL} U          @key{TAB}            d @key{SPC}          d n
2770 @end group
2771 @end smallexample
2773 @noindent
2774 Here the @kbd{H d s} command changes to scientific notation but without
2775 updating the screen.  Deleting the top stack entry and undoing it back
2776 causes it to show up in the new format; swapping the top two stack
2777 entries reformats both entries.  The @kbd{d @key{SPC}} command refreshes the
2778 whole stack.  The @kbd{d n} command changes back to the normal float
2779 format; since it doesn't have an @kbd{H} prefix, it also updates all
2780 the stack entries to be in @kbd{d n} format.
2782 Notice that the integer @expr{12345} was not affected by any
2783 of the float formats.  Integers are integers, and are always
2784 displayed exactly.
2786 @cindex Large numbers, readability
2787 Large integers have their own problems.  Let's look back at
2788 the result of @kbd{2^3^4}.
2790 @example
2791 2417851639229258349412352
2792 @end example
2794 @noindent
2795 Quick---how many digits does this have?  Try typing @kbd{d g}:
2797 @example
2798 2,417,851,639,229,258,349,412,352
2799 @end example
2801 @noindent
2802 Now how many digits does this have?  It's much easier to tell!
2803 We can actually group digits into clumps of any size.  Some
2804 people prefer @kbd{M-5 d g}:
2806 @example
2807 24178,51639,22925,83494,12352
2808 @end example
2810 Let's see what happens to floating-point numbers when they are grouped.
2811 First, type @kbd{p 25 @key{RET}} to make sure we have enough precision
2812 to get ourselves into trouble.  Now, type @kbd{1e13 /}:
2814 @example
2815 24,17851,63922.9258349412352
2816 @end example
2818 @noindent
2819 The 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):
2822 @example
2823 24,17851,63922.92583,49412,352
2824 @end example
2826 If you find it hard to tell the decimal point from the commas, try
2827 changing the grouping character to a space with @kbd{d , @key{SPC}}:
2829 @example
2830 24 17851 63922.92583 49412 352
2831 @end example
2833 Type @kbd{d , ,} to restore the normal grouping character, then
2834 @kbd{d g} again to turn grouping off.  Also, press @kbd{p 12} to
2835 restore the default precision.
2837 Press @kbd{U} enough times to get the original big integer back.
2838 (Notice that @kbd{U} does not undo each mode-setting command; if
2839 you want to undo a mode-setting command, you have to do it yourself.)
2840 Now, type @kbd{d r 16 @key{RET}}:
2842 @example
2843 16#200000000000000000000
2844 @end example
2846 @noindent
2847 The number is now displayed in @dfn{hexadecimal}, or ``base-16'' form.
2848 Suddenly it looks pretty simple; this should be no surprise, since we
2849 got this number by computing a power of two, and 16 is a power of 2.
2850 In fact, we can use @w{@kbd{d r 2 @key{RET}}} to see it in actual binary
2851 form:
2853 @example
2854 2#1000000000000000000000000000000000000000000000000000000 @dots{}
2855 @end example
2857 @noindent
2858 We don't have enough space here to show all the zeros!  They won't
2859 fit on a typical screen, either, so you will have to use horizontal
2860 scrolling to see them all.  Press @kbd{<} and @kbd{>} to scroll the
2861 stack window left and right by half its width.  Another way to view
2862 something large is to press @kbd{`} (back-quote) to edit the top of
2863 stack in a separate window.  (Press @kbd{C-c C-c} when you are done.)
2865 You can enter non-decimal numbers using the @kbd{#} symbol, too.
2866 Let's see what the hexadecimal number @samp{5FE} looks like in
2867 binary.  Type @kbd{16#5FE} (the letters can be typed in upper or
2868 lower case; they will always appear in upper case).  It will also
2869 help to turn grouping on with @kbd{d g}:
2871 @example
2872 2#101,1111,1110
2873 @end example
2875 Notice that @kbd{d g} groups by fours by default if the display radix
2876 is binary or hexadecimal, but by threes if it is decimal, octal, or any
2877 other radix.
2879 Now let's see that number in decimal; type @kbd{d r 10}:
2881 @example
2882 1,534
2883 @end example
2885 Numbers are not @emph{stored} with any particular radix attached.  They're
2886 just numbers; they can be entered in any radix, and are always displayed
2887 in whatever radix you've chosen with @kbd{d r}.  The current radix applies
2888 to integers, fractions, and floats.
2890 @cindex Roundoff errors, in non-decimal numbers
2891 (@bullet{}) @strong{Exercise 1.}  Your friend Joe tried to enter one-third
2892 as @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
2894 that 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,
2896 saw @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{})
2900 @cindex Scientific notation, in non-decimal numbers
2901 (@bullet{}) @strong{Exercise 2.}  Scientific notation works in non-decimal
2902 modes in the natural way (the exponent is a power of the radix instead of
2903 a power of ten, although the exponent itself is always written in decimal).
2904 Thus @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}.
2906 What is wrong with this picture?  What could we write instead that would
2907 work better?  @xref{Modes Answer 2, 2}. (@bullet{})
2909 The @kbd{m} prefix key has another set of modes, relating to the way
2910 Calc interprets your inputs and does computations.  Whereas @kbd{d}-prefix
2911 modes generally affect the way things look, @kbd{m}-prefix modes affect
2912 the way they are actually computed.
2914 The most popular @kbd{m}-prefix mode is the @dfn{angular mode}.  Notice
2915 the @samp{Deg} indicator in the mode line.  This means that if you use
2916 a command that interprets a number as an angle, it will assume the
2917 angle is measured in degrees.  For example,
2919 @smallexample
2920 @group
2921 1:  45         1:  0.707106781187   1:  0.500000000001    1:  0.5
2922     .              .                    .                     .
2924     45             S                    2 ^                   c 1
2925 @end group
2926 @end smallexample
2928 @noindent
2929 The shift-@kbd{S} command computes the sine of an angle.  The sine
2930 of 45 degrees is 
2931 @texline @math{\sqrt{2}/2};
2932 @infoline @expr{sqrt(2)/2}; 
2933 squaring this yields @expr{2/4 = 0.5}.  However, there has been a slight
2934 roundoff error because the representation of 
2935 @texline @math{\sqrt{2}/2}
2936 @infoline @expr{sqrt(2)/2} 
2937 wasn't exact.  The @kbd{c 1} command is a handy way to clean up numbers
2938 in this case; it temporarily reduces the precision by one digit while it
2939 re-rounds the number on the top of the stack.
2941 @cindex Roundoff errors, examples
2942 (@bullet{}) @strong{Exercise 3.}  Your friend Joe computed the sine
2943 of 45 degrees as shown above, then, hoping to avoid an inexact
2944 result, he increased the precision to 16 digits before squaring.
2945 What happened?  @xref{Modes Answer 3, 3}. (@bullet{})
2947 To do this calculation in radians, we would type @kbd{m r} first.
2948 (The indicator changes to @samp{Rad}.)  45 degrees corresponds to
2949 @cpiover{4} radians.  To get @cpi{}, press the @kbd{P} key.  (Once
2950 again, this is a shifted capital @kbd{P}.  Remember, unshifted
2951 @kbd{p} sets the precision.)
2953 @smallexample
2954 @group
2955 1:  3.14159265359   1:  0.785398163398   1:  0.707106781187
2956     .                   .                .
2958     P                   4 /       m r    S
2959 @end group
2960 @end smallexample
2962 Likewise, inverse trigonometric functions generate results in
2963 either radians or degrees, depending on the current angular mode.
2965 @smallexample
2966 @group
2967 1:  0.707106781187   1:  0.785398163398   1:  45.
2968     .                    .                    .
2970     .5 Q        m r      I S        m d       U I S
2971 @end group
2972 @end smallexample
2974 @noindent
2975 Here we compute the Inverse Sine of 
2976 @texline @math{\sqrt{0.5}},
2977 @infoline @expr{sqrt(0.5)}, 
2978 first in radians, then in degrees.
2980 Use @kbd{c d} and @kbd{c r} to convert a number from radians to degrees
2981 and vice-versa.
2983 @smallexample
2984 @group
2985 1:  45         1:  0.785398163397     1:  45.
2986     .              .                      .
2988     45             c r                    c d
2989 @end group
2990 @end smallexample
2992 Another interesting mode is @dfn{Fraction mode}.  Normally,
2993 dividing two integers produces a floating-point result if the
2994 quotient can't be expressed as an exact integer.  Fraction mode
2995 causes integer division to produce a fraction, i.e., a rational
2996 number, instead.
2998 @smallexample
2999 @group
3000 2:  12         1:  1.33333333333    1:  4:3
3001 1:  9              .                    .
3002     .
3004  12 @key{RET} 9          /          m f       U /      m f
3005 @end group
3006 @end smallexample
3008 @noindent
3009 In the first case, we get an approximate floating-point result.
3010 In the second case, we get an exact fractional result (four-thirds).
3012 You can enter a fraction at any time using @kbd{:} notation.
3013 (Calc uses @kbd{:} instead of @kbd{/} as the fraction separator
3014 because @kbd{/} is already used to divide the top two stack
3015 elements.)  Calculations involving fractions will always
3016 produce exact fractional results; Fraction mode only says
3017 what to do when dividing two integers.
3019 @cindex Fractions vs. floats
3020 @cindex Floats vs. fractions
3021 (@bullet{}) @strong{Exercise 4.}  If fractional arithmetic is exact,
3022 why would you ever use floating-point numbers instead?
3023 @xref{Modes Answer 4, 4}. (@bullet{})
3025 Typing @kbd{m f} doesn't change any existing values in the stack.
3026 In the above example, we had to Undo the division and do it over
3027 again when we changed to Fraction mode.  But if you use the
3028 evaluates-to operator you can get commands like @kbd{m f} to
3029 recompute for you.
3031 @smallexample
3032 @group
3033 1:  12 / 9 => 1.33333333333    1:  12 / 9 => 1.333    1:  12 / 9 => 4:3
3034     .                              .                      .
3036    ' 12/9 => @key{RET}                   p 4 @key{RET}                m f
3037 @end group
3038 @end smallexample
3040 @noindent
3041 In this example, the righthand side of the @samp{=>} operator
3042 on the stack is recomputed when we change the precision, then
3043 again when we change to Fraction mode.  All @samp{=>} expressions
3044 on the stack are recomputed every time you change any mode that
3045 might affect their values.
3047 @node Arithmetic Tutorial, Vector/Matrix Tutorial, Basic Tutorial, Tutorial
3048 @section Arithmetic Tutorial
3050 @noindent
3051 In this section, we explore the arithmetic and scientific functions
3052 available in the Calculator.
3054 The standard arithmetic commands are @kbd{+}, @kbd{-}, @kbd{*}, @kbd{/},
3055 and @kbd{^}.  Each normally takes two numbers from the top of the stack
3056 and pushes back a result.  The @kbd{n} and @kbd{&} keys perform
3057 change-sign and reciprocal operations, respectively.
3059 @smallexample
3060 @group
3061 1:  5          1:  0.2        1:  5.         1:  -5.        1:  5.
3062     .              .              .              .              .
3064     5              &              &              n              n
3065 @end group
3066 @end smallexample
3068 @cindex Binary operators
3069 You can apply a ``binary operator'' like @kbd{+} across any number of
3070 stack entries by giving it a numeric prefix.  You can also apply it
3071 pairwise to several stack elements along with the top one if you use
3072 a negative prefix.
3074 @smallexample
3075 @group
3076 3:  2          1:  9          3:  2          4:  2          3:  12
3077 2:  3              .          2:  3          3:  3          2:  13
3078 1:  4                         1:  4          2:  4          1:  14
3079     .                             .          1:  10             .
3080                                                  .
3082 2 @key{RET} 3 @key{RET} 4     M-3 +           U              10          M-- M-3 +
3083 @end group
3084 @end smallexample
3086 @cindex Unary operators
3087 You can apply a ``unary operator'' like @kbd{&} to the top @var{n}
3088 stack entries with a numeric prefix, too.
3090 @smallexample
3091 @group
3092 3:  2          3:  0.5                3:  0.5
3093 2:  3          2:  0.333333333333     2:  3.
3094 1:  4          1:  0.25               1:  4.
3095     .              .                      .
3097 2 @key{RET} 3 @key{RET} 4      M-3 &                  M-2 &
3098 @end group
3099 @end smallexample
3101 Notice that the results here are left in floating-point form.
3102 We can convert them back to integers by pressing @kbd{F}, the
3103 ``floor'' function.  This function rounds down to the next lower
3104 integer.  There is also @kbd{R}, which rounds to the nearest
3105 integer.
3107 @smallexample
3108 @group
3109 7:  2.         7:  2          7:  2
3110 6:  2.4        6:  2          6:  2
3111 5:  2.5        5:  2          5:  3
3112 4:  2.6        4:  2          4:  3
3113 3:  -2.        3:  -2         3:  -2
3114 2:  -2.4       2:  -3         2:  -2
3115 1:  -2.6       1:  -3         1:  -3
3116     .              .              .
3118                   M-7 F        U M-7 R
3119 @end group
3120 @end smallexample
3122 Since dividing-and-flooring (i.e., ``integer quotient'') is such a
3123 common operation, Calc provides a special command for that purpose, the
3124 backslash @kbd{\}.  Another common arithmetic operator is @kbd{%}, which
3125 computes the remainder that would arise from a @kbd{\} operation, i.e.,
3126 the ``modulo'' of two numbers.  For example,
3128 @smallexample
3129 @group
3130 2:  1234       1:  12         2:  1234       1:  34
3131 1:  100            .          1:  100            .
3132     .                             .
3134 1234 @key{RET} 100       \              U              %
3135 @end group
3136 @end smallexample
3138 These commands actually work for any real numbers, not just integers.
3140 @smallexample
3141 @group
3142 2:  3.1415     1:  3          2:  3.1415     1:  0.1415
3143 1:  1              .          1:  1              .
3144     .                             .
3146 3.1415 @key{RET} 1       \              U              %
3147 @end group
3148 @end smallexample
3150 (@bullet{}) @strong{Exercise 1.}  The @kbd{\} command would appear to be a
3151 frill, since you could always do the same thing with @kbd{/ F}.  Think
3152 of a situation where this is not true---@kbd{/ F} would be inadequate.
3153 Now think of a way you could get around the problem if Calc didn't
3154 provide a @kbd{\} command.  @xref{Arithmetic Answer 1, 1}. (@bullet{})
3156 We've already seen the @kbd{Q} (square root) and @kbd{S} (sine)
3157 commands.  Other commands along those lines are @kbd{C} (cosine),
3158 @kbd{T} (tangent), @kbd{E} (@expr{e^x}) and @kbd{L} (natural
3159 logarithm).  These can be modified by the @kbd{I} (inverse) and
3160 @kbd{H} (hyperbolic) prefix keys.
3162 Let's compute the sine and cosine of an angle, and verify the
3163 identity 
3164 @texline @math{\sin^2x + \cos^2x = 1}.
3165 @infoline @expr{sin(x)^2 + cos(x)^2 = 1}.  
3166 We'll arbitrarily pick @mathit{-64} degrees as a good value for @expr{x}.
3167 With the angular mode set to degrees (type @w{@kbd{m d}}), do:
3169 @smallexample
3170 @group
3171 2:  -64        2:  -64        2:  -0.89879   2:  -0.89879   1:  1.
3172 1:  -64        1:  -0.89879   1:  -64        1:  0.43837        .
3173     .              .              .              .
3175  64 n @key{RET} @key{RET}      S              @key{TAB}            C              f h
3176 @end group
3177 @end smallexample
3179 @noindent
3180 (For brevity, we're showing only five digits of the results here.
3181 You can of course do these calculations to any precision you like.)
3183 Remember, @kbd{f h} is the @code{calc-hypot}, or square-root of sum
3184 of squares, command.
3186 Another identity is 
3187 @texline @math{\displaystyle\tan x = {\sin x \over \cos x}}.
3188 @infoline @expr{tan(x) = sin(x) / cos(x)}.
3189 @smallexample
3190 @group
3192 2:  -0.89879   1:  -2.0503    1:  -64.
3193 1:  0.43837        .              .
3194     .
3196     U              /              I T
3197 @end group
3198 @end smallexample
3200 A physical interpretation of this calculation is that if you move
3201 @expr{0.89879} units downward and @expr{0.43837} units to the right,
3202 your direction of motion is @mathit{-64} degrees from horizontal.  Suppose
3203 we move in the opposite direction, up and to the left:
3205 @smallexample
3206 @group
3207 2:  -0.89879   2:  0.89879    1:  -2.0503    1:  -64.
3208 1:  0.43837    1:  -0.43837       .              .
3209     .              .
3211     U U            M-2 n          /              I T
3212 @end group
3213 @end smallexample
3215 @noindent
3216 How can the angle be the same?  The answer is that the @kbd{/} operation
3217 loses information about the signs of its inputs.  Because the quotient
3218 is negative, we know exactly one of the inputs was negative, but we
3219 can't tell which one.  There is an @kbd{f T} [@code{arctan2}] function which
3220 computes the inverse tangent of the quotient of a pair of numbers.
3221 Since you feed it the two original numbers, it has enough information
3222 to give you a full 360-degree answer.
3224 @smallexample
3225 @group
3226 2:  0.89879    1:  116.       3:  116.       2:  116.       1:  180.
3227 1:  -0.43837       .          2:  -0.89879   1:  -64.           .
3228     .                         1:  0.43837        .
3229                                   .
3231     U U            f T         M-@key{RET} M-2 n       f T            -
3232 @end group
3233 @end smallexample
3235 @noindent
3236 The resulting angles differ by 180 degrees; in other words, they
3237 point in opposite directions, just as we would expect.
3239 The @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
3241 restores the arguments of the last command to the stack without removing
3242 the command's result.  It is useful in situations like this one,
3243 where we need to do several operations on the same inputs.  We could
3244 have accomplished the same thing by using @kbd{M-2 @key{RET}} to duplicate
3245 the 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.
3248 A similar identity is supposed to hold for hyperbolic sines and cosines,
3249 except that it is the @emph{difference}
3250 @texline @math{\cosh^2x - \sinh^2x}
3251 @infoline @expr{cosh(x)^2 - sinh(x)^2} 
3252 that always equals one.  Let's try to verify this identity.
3254 @smallexample
3255 @group
3256 2:  -64        2:  -64        2:  -64        2:  9.7192e54  2:  9.7192e54
3257 1:  -64        1:  -3.1175e27 1:  9.7192e54  1:  -64        1:  9.7192e54
3258     .              .              .              .              .
3260  64 n @key{RET} @key{RET}      H C            2 ^            @key{TAB}            H S 2 ^
3261 @end group
3262 @end smallexample
3264 @noindent
3265 @cindex Roundoff errors, examples
3266 Something's obviously wrong, because when we subtract these numbers
3267 the answer will clearly be zero!  But if you think about it, if these
3268 numbers @emph{did} differ by one, it would be in the 55th decimal
3269 place.  The difference we seek has been lost entirely to roundoff
3270 error.
3272 We could verify this hypothesis by doing the actual calculation with,
3273 say, 60 decimal places of precision.  This will be slow, but not
3274 enormously so.  Try it if you wish; sure enough, the answer is
3275 0.99999, reasonably close to 1.
3277 Of course, a more reasonable way to verify the identity is to use
3278 a more reasonable value for @expr{x}!
3280 @cindex Common logarithm
3281 Some Calculator commands use the Hyperbolic prefix for other purposes.
3282 The logarithm and exponential functions, for example, work to the base
3283 @expr{e} normally but use base-10 instead if you use the Hyperbolic
3284 prefix.
3286 @smallexample
3287 @group
3288 1:  1000       1:  6.9077     1:  1000       1:  3
3289     .              .              .              .
3291     1000           L              U              H L
3292 @end group
3293 @end smallexample
3295 @noindent
3296 First, we mistakenly compute a natural logarithm.  Then we undo
3297 and compute a common logarithm instead.
3299 The @kbd{B} key computes a general base-@var{b} logarithm for any
3300 value of @var{b}.
3302 @smallexample
3303 @group
3304 2:  1000       1:  3          1:  1000.      2:  1000.      1:  6.9077
3305 1:  10             .              .          1:  2.71828        .
3306     .                                            .
3308  1000 @key{RET} 10       B              H E            H P            B
3309 @end group
3310 @end smallexample
3312 @noindent
3313 Here we first use @kbd{B} to compute the base-10 logarithm, then use
3314 the ``hyperbolic'' exponential as a cheap hack to recover the number
3315 1000, then use @kbd{B} again to compute the natural logarithm.  Note
3316 that @kbd{P} with the hyperbolic prefix pushes the constant @expr{e}
3317 onto the stack.
3319 You may have noticed that both times we took the base-10 logarithm
3320 of 1000, we got an exact integer result.  Calc always tries to give
3321 an exact rational result for calculations involving rational numbers
3322 where possible.  But when we used @kbd{H E}, the result was a
3323 floating-point number for no apparent reason.  In fact, if we had
3324 computed @kbd{10 @key{RET} 3 ^} we @emph{would} have gotten an
3325 exact integer 1000.  But the @kbd{H E} command is rigged to generate
3326 a floating-point result all of the time so that @kbd{1000 H E} will
3327 not waste time computing a thousand-digit integer when all you
3328 probably wanted was @samp{1e1000}.
3330 (@bullet{}) @strong{Exercise 2.}  Find a pair of integer inputs to
3331 the @kbd{B} command for which Calc could find an exact rational
3332 result but doesn't.  @xref{Arithmetic Answer 2, 2}. (@bullet{})
3334 The Calculator also has a set of functions relating to combinatorics
3335 and statistics.  You may be familiar with the @dfn{factorial} function,
3336 which computes the product of all the integers up to a given number.
3338 @smallexample
3339 @group
3340 1:  100        1:  93326215443...    1:  100.       1:  9.3326e157
3341     .              .                     .              .
3343     100            !                     U c f          !
3344 @end group
3345 @end smallexample
3347 @noindent
3348 Recall, the @kbd{c f} command converts the integer or fraction at the
3349 top of the stack to floating-point format.  If you take the factorial
3350 of a floating-point number, you get a floating-point result
3351 accurate to the current precision.  But if you give @kbd{!} an
3352 exact integer, you get an exact integer result (158 digits long
3353 in this case).
3355 If you take the factorial of a non-integer, Calc uses a generalized
3356 factorial function defined in terms of Euler's Gamma function
3357 @texline @math{\Gamma(n)}
3358 @infoline @expr{gamma(n)}
3359 (which is itself available as the @kbd{f g} command).
3361 @smallexample
3362 @group
3363 3:  4.         3:  24.               1:  5.5        1:  52.342777847
3364 2:  4.5        2:  52.3427777847         .              .
3365 1:  5.         1:  120.
3366     .              .
3368                    M-3 !              M-0 @key{DEL} 5.5       f g
3369 @end group
3370 @end smallexample
3372 @noindent
3373 Here we verify the identity 
3374 @texline @math{n! = \Gamma(n+1)}.
3375 @infoline @expr{@var{n}!@: = gamma(@var{n}+1)}.
3377 The binomial coefficient @var{n}-choose-@var{m}
3378 @texline or @math{\displaystyle {n \choose m}}
3379 is defined by
3380 @texline @math{\displaystyle {n! \over m! \, (n-m)!}}
3381 @infoline @expr{n!@: / m!@: (n-m)!}
3382 for all reals @expr{n} and @expr{m}.  The intermediate results in this
3383 formula 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
3385 large intermediate values.
3387 The @kbd{k} prefix key defines several common functions out of
3388 combinatorics and number theory.  Here we compute the binomial
3389 coefficient 30-choose-20, then determine its prime factorization.
3391 @smallexample
3392 @group
3393 2:  30         1:  30045015   1:  [3, 3, 5, 7, 11, 13, 23, 29]
3394 1:  20             .              .
3395     .
3397  30 @key{RET} 20         k c            k f
3398 @end group
3399 @end smallexample
3401 @noindent
3402 You can verify these prime factors by using @kbd{v u} to ``unpack''
3403 this vector into 8 separate stack entries, then @kbd{M-8 *} to
3404 multiply them back together.  The result is the original number,
3405 30045015.
3407 @cindex Hash tables
3408 Suppose a program you are writing needs a hash table with at least
3409 10000 entries.  It's best to use a prime number as the actual size
3410 of a hash table.  Calc can compute the next prime number after 10000:
3412 @smallexample
3413 @group
3414 1:  10000      1:  10007      1:  9973
3415     .              .              .
3417     10000          k n            I k n
3418 @end group
3419 @end smallexample
3421 @noindent
3422 Just for kicks we've also computed the next prime @emph{less} than
3423 10000.
3425 @c [fix-ref Financial Functions]
3426 @xref{Financial Functions}, for a description of the Calculator
3427 commands that deal with business and financial calculations (functions
3428 like @code{pv}, @code{rate}, and @code{sln}).
3430 @c [fix-ref Binary Number Functions]
3431 @xref{Binary Functions}, to read about the commands for operating
3432 on binary numbers (like @code{and}, @code{xor}, and @code{lsh}).
3434 @node Vector/Matrix Tutorial, Types Tutorial, Arithmetic Tutorial, Tutorial
3435 @section Vector/Matrix Tutorial
3437 @noindent
3438 A @dfn{vector} is a list of numbers or other Calc data objects.
3439 Calc provides a large set of commands that operate on vectors.  Some
3440 are familiar operations from vector analysis.  Others simply treat
3441 a vector as a list of objects.
3443 @menu
3444 * Vector Analysis Tutorial::
3445 * Matrix Tutorial::
3446 * List Tutorial::
3447 @end menu
3449 @node Vector Analysis Tutorial, Matrix Tutorial, Vector/Matrix Tutorial, Vector/Matrix Tutorial
3450 @subsection Vector Analysis
3452 @noindent
3453 If you add two vectors, the result is a vector of the sums of the
3454 elements, taken pairwise.
3456 @smallexample
3457 @group
3458 1:  [1, 2, 3]     2:  [1, 2, 3]     1:  [8, 8, 3]
3459     .             1:  [7, 6, 0]         .
3460                       .
3462     [1,2,3]  s 1      [7 6 0]  s 2      +
3463 @end group
3464 @end smallexample
3466 @noindent
3467 Note that we can separate the vector elements with either commas or
3468 spaces.  This is true whether we are using incomplete vectors or
3469 algebraic entry.  The @kbd{s 1} and @kbd{s 2} commands save these
3470 vectors so we can easily reuse them later.
3472 If you multiply two vectors, the result is the sum of the products
3473 of the elements taken pairwise.  This is called the @dfn{dot product}
3474 of the vectors.
3476 @smallexample
3477 @group
3478 2:  [1, 2, 3]     1:  19
3479 1:  [7, 6, 0]         .
3480     .
3482     r 1 r 2           *
3483 @end group
3484 @end smallexample
3486 @cindex Dot product
3487 The dot product of two vectors is equal to the product of their
3488 lengths times the cosine of the angle between them.  (Here the vector
3489 is interpreted as a line from the origin @expr{(0,0,0)} to the
3490 specified point in three-dimensional space.)  The @kbd{A}
3491 (absolute value) command can be used to compute the length of a
3492 vector.
3494 @smallexample
3495 @group
3496 3:  19            3:  19          1:  0.550782    1:  56.579
3497 2:  [1, 2, 3]     2:  3.741657        .               .
3498 1:  [7, 6, 0]     1:  9.219544
3499     .                 .
3501     M-@key{RET}             M-2 A          * /             I C
3502 @end group
3503 @end smallexample
3505 @noindent
3506 First we recall the arguments to the dot product command, then
3507 we compute the absolute values of the top two stack entries to
3508 obtain the lengths of the vectors, then we divide the dot product
3509 by the product of the lengths to get the cosine of the angle.
3510 The inverse cosine finds that the angle between the vectors
3511 is about 56 degrees.
3513 @cindex Cross product
3514 @cindex Perpendicular vectors
3515 The @dfn{cross product} of two vectors is a vector whose length
3516 is the product of the lengths of the inputs times the sine of the
3517 angle between them, and whose direction is perpendicular to both
3518 input vectors.  Unlike the dot product, the cross product is
3519 defined only for three-dimensional vectors.  Let's double-check
3520 our computation of the angle using the cross product.
3522 @smallexample
3523 @group
3524 2:  [1, 2, 3]  3:  [-18, 21, -8]  1:  [-0.52, 0.61, -0.23]  1:  56.579
3525 1:  [7, 6, 0]  2:  [1, 2, 3]          .                         .
3526     .          1:  [7, 6, 0]
3527                    .
3529     r 1 r 2        V C  s 3  M-@key{RET}    M-2 A * /                 A I S
3530 @end group
3531 @end smallexample
3533 @noindent
3534 First we recall the original vectors and compute their cross product,
3535 which we also store for later reference.  Now we divide the vector
3536 by the product of the lengths of the original vectors.  The length of
3537 this vector should be the sine of the angle; sure enough, it is!
3539 @c [fix-ref General Mode Commands]
3540 Vector-related commands generally begin with the @kbd{v} prefix key.
3541 Some are uppercase letters and some are lowercase.  To make it easier
3542 to type these commands, the shift-@kbd{V} prefix key acts the same as
3543 the @kbd{v} key.  (@xref{General Mode Commands}, for a way to make all
3544 prefix keys have this property.)
3546 If we take the dot product of two perpendicular vectors we expect
3547 to get zero, since the cosine of 90 degrees is zero.  Let's check
3548 that the cross product is indeed perpendicular to both inputs:
3550 @smallexample
3551 @group
3552 2:  [1, 2, 3]      1:  0          2:  [7, 6, 0]      1:  0
3553 1:  [-18, 21, -8]      .          1:  [-18, 21, -8]      .
3554     .                                 .
3556     r 1 r 3            *          @key{DEL} r 2 r 3            *
3557 @end group
3558 @end smallexample
3560 @cindex Normalizing a vector
3561 @cindex Unit vectors
3562 (@bullet{}) @strong{Exercise 1.}  Given a vector on the top of the
3563 stack, what keystrokes would you use to @dfn{normalize} the
3564 vector, i.e., to reduce its length to one without changing its
3565 direction?  @xref{Vector Answer 1, 1}. (@bullet{})
3567 (@bullet{}) @strong{Exercise 2.}  Suppose a certain particle can be
3568 at any of several positions along a ruler.  You have a list of
3569 those positions in the form of a vector, and another list of the
3570 probabilities for the particle to be at the corresponding positions.
3571 Find the average position of the particle.
3572 @xref{Vector Answer 2, 2}. (@bullet{})
3574 @node Matrix Tutorial, List Tutorial, Vector Analysis Tutorial, Vector/Matrix Tutorial
3575 @subsection Matrices
3577 @noindent
3578 A @dfn{matrix} is just a vector of vectors, all the same length.
3579 This means you can enter a matrix using nested brackets.  You can
3580 also use the semicolon character to enter a matrix.  We'll show
3581 both methods here:
3583 @smallexample
3584 @group
3585 1:  [ [ 1, 2, 3 ]             1:  [ [ 1, 2, 3 ]
3586       [ 4, 5, 6 ] ]                 [ 4, 5, 6 ] ]
3587     .                             .
3589   [[1 2 3] [4 5 6]]             ' [1 2 3; 4 5 6] @key{RET}
3590 @end group
3591 @end smallexample
3593 @noindent
3594 We'll be using this matrix again, so type @kbd{s 4} to save it now.
3596 Note that semicolons work with incomplete vectors, but they work
3597 better in algebraic entry.  That's why we use the apostrophe in
3598 the second example.
3600 When two matrices are multiplied, the lefthand matrix must have
3601 the same number of columns as the righthand matrix has rows.
3602 Row @expr{i}, column @expr{j} of the result is effectively the
3603 dot product of row @expr{i} of the left matrix by column @expr{j}
3604 of the right matrix.
3606 If we try to duplicate this matrix and multiply it by itself,
3607 the dimensions are wrong and the multiplication cannot take place:
3609 @smallexample
3610 @group
3611 1:  [ [ 1, 2, 3 ]   * [ [ 1, 2, 3 ]
3612       [ 4, 5, 6 ] ]     [ 4, 5, 6 ] ]
3613     .
3615     @key{RET} *
3616 @end group
3617 @end smallexample
3619 @noindent
3620 Though rather hard to read, this is a formula which shows the product
3621 of two matrices.  The @samp{*} function, having invalid arguments, has
3622 been left in symbolic form.
3624 We can multiply the matrices if we @dfn{transpose} one of them first.
3626 @smallexample
3627 @group
3628 2:  [ [ 1, 2, 3 ]       1:  [ [ 14, 32 ]      1:  [ [ 17, 22, 27 ]
3629       [ 4, 5, 6 ] ]           [ 32, 77 ] ]          [ 22, 29, 36 ]
3630 1:  [ [ 1, 4 ]              .                       [ 27, 36, 45 ] ]
3631       [ 2, 5 ]                                    .
3632       [ 3, 6 ] ]
3633     .
3635     U v t                   *                     U @key{TAB} *
3636 @end group
3637 @end smallexample
3639 Matrix multiplication is not commutative; indeed, switching the
3640 order of the operands can even change the dimensions of the result
3641 matrix, as happened here!
3643 If you multiply a plain vector by a matrix, it is treated as a
3644 single row or column depending on which side of the matrix it is
3645 on.  The result is a plain vector which should also be interpreted
3646 as a row or column as appropriate.
3648 @smallexample
3649 @group
3650 2:  [ [ 1, 2, 3 ]      1:  [14, 32]
3651       [ 4, 5, 6 ] ]        .
3652 1:  [1, 2, 3]
3653     .
3655     r 4 r 1                *
3656 @end group
3657 @end smallexample
3659 Multiplying in the other order wouldn't work because the number of
3660 rows in the matrix is different from the number of elements in the
3661 vector.
3663 (@bullet{}) @strong{Exercise 1.}  Use @samp{*} to sum along the rows
3664 of the above 
3665 @texline @math{2\times3}
3666 @infoline 2x3 
3667 matrix to get @expr{[6, 15]}.  Now use @samp{*} to sum along the columns
3668 to get @expr{[5, 7, 9]}. 
3669 @xref{Matrix Answer 1, 1}. (@bullet{})
3671 @cindex Identity matrix
3672 An @dfn{identity matrix} is a square matrix with ones along the
3673 diagonal and zeros elsewhere.  It has the property that multiplication
3674 by an identity matrix, on the left or on the right, always produces
3675 the original matrix.
3677 @smallexample
3678 @group
3679 1:  [ [ 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                            .
3686     r 4                    v i 3 @key{RET}              *
3687 @end group
3688 @end smallexample
3690 If a matrix is square, it is often possible to find its @dfn{inverse},
3691 that is, a matrix which, when multiplied by the original matrix, yields
3692 an identity matrix.  The @kbd{&} (reciprocal) key also computes the
3693 inverse of a matrix.
3695 @smallexample
3696 @group
3697 1:  [ [ 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     .                      .
3702     r 4 r 2 |  s 5         &
3703 @end group
3704 @end smallexample
3706 @noindent
3707 The vertical bar @kbd{|} @dfn{concatenates} numbers, vectors, and
3708 matrices together.  Here we have used it to add a new row onto
3709 our matrix to make it square.
3711 We can multiply these two matrices in either order to get an identity.
3713 @smallexample
3714 @group
3715 1:  [ [ 1., 0., 0. ]      1:  [ [ 1., 0., 0. ]
3716       [ 0., 1., 0. ]            [ 0., 1., 0. ]
3717       [ 0., 0., 1. ] ]          [ 0., 0., 1. ] ]
3718     .                         .
3720     M-@key{RET}  *                  U @key{TAB} *
3721 @end group
3722 @end smallexample
3724 @cindex Systems of linear equations
3725 @cindex Linear equations, systems of
3726 Matrix inverses are related to systems of linear equations in algebra.
3727 Suppose we had the following set of equations:
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}
3750 \afterdisplayh
3751 @end tex
3753 @noindent
3754 This can be cast into the matrix equation,
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 }
3772 \afterdisplay
3773 @end tex
3775 We can solve this system of equations by multiplying both sides by the
3776 inverse of the matrix.  Calc can do this all in one step:
3778 @smallexample
3779 @group
3780 2:  [6, 2, 3]          1:  [-12.6, 15.2, -3.93333]
3781 1:  [ [ 1, 2, 3 ]          .
3782       [ 4, 5, 6 ]
3783       [ 7, 6, 0 ] ]
3784     .
3786     [6,2,3] r 5            /
3787 @end group
3788 @end smallexample
3790 @noindent
3791 The result is the @expr{[a, b, c]} vector that solves the equations.
3792 (Dividing by a square matrix is equivalent to multiplying by its
3793 inverse.)
3795 Let's verify this solution:
3797 @smallexample
3798 @group
3799 2:  [ [ 1, 2, 3 ]                1:  [6., 2., 3.]
3800       [ 4, 5, 6 ]                    .
3801       [ 7, 6, 0 ] ]
3802 1:  [-12.6, 15.2, -3.93333]
3803     .
3805     r 5  @key{TAB}                         *
3806 @end group
3807 @end smallexample
3809 @noindent
3810 Note that we had to be careful about the order in which we multiplied
3811 the matrix and vector.  If we multiplied in the other order, Calc would
3812 assume the vector was a row vector in order to make the dimensions
3813 come out right, and the answer would be incorrect.  If you
3814 don't feel safe letting Calc take either interpretation of your
3815 vectors, use explicit 
3816 @texline @math{N\times1}
3817 @infoline Nx1
3819 @texline @math{1\times N}
3820 @infoline 1xN
3821 matrices instead.  In this case, you would enter the original column
3822 vector as @samp{[[6], [2], [3]]} or @samp{[6; 2; 3]}.
3824 (@bullet{}) @strong{Exercise 2.}  Algebraic entry allows you to make
3825 vectors and matrices that include variables.  Solve the following
3826 system of equations to get expressions for @expr{x} and @expr{y}
3827 in terms of @expr{a} and @expr{b}.
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}
3843 \afterdisplay
3844 @end tex
3846 @noindent
3847 @xref{Matrix Answer 2, 2}. (@bullet{})
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''
3852 if it has more equations than variables.  It is often the case that
3853 there are no values for the variables that will satisfy all the
3854 equations at once, but it is still useful to find a set of values
3855 which ``nearly'' satisfy all the equations.  In terms of matrix equations,
3856 you can't solve @expr{A X = B} directly because the matrix @expr{A}
3857 is not square for an over-determined system.  Matrix inversion works
3858 only for square matrices.  One common trick is to multiply both sides
3859 on the left by the transpose of @expr{A}:
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
3867 Now 
3868 @texline @math{A^T A}
3869 @infoline @expr{trn(A)*A} 
3870 is 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''
3872 solution, which can be regarded as the ``closest'' solution to the set
3873 of equations.  Use Calc to solve the following over-determined
3874 system:
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}
3899 \afterdisplayh
3900 @end tex
3902 @noindent
3903 @xref{Matrix Answer 3, 3}. (@bullet{})
3905 @node List Tutorial, , Matrix Tutorial, Vector/Matrix Tutorial
3906 @subsection Vectors as Lists
3908 @noindent
3909 @cindex Lists
3910 Although Calc has a number of features for manipulating vectors and
3911 matrices as mathematical objects, you can also treat vectors as
3912 simple lists of values.  For example, we saw that the @kbd{k f}
3913 command returns a vector which is a list of the prime factors of a
3914 number.
3916 You can pack and unpack stack entries into vectors:
3918 @smallexample
3919 @group
3920 3:  10         1:  [10, 20, 30]     3:  10
3921 2:  20             .                2:  20
3922 1:  30                              1:  30
3923     .                                   .
3925                    M-3 v p              v u
3926 @end group
3927 @end smallexample
3929 You can also build vectors out of consecutive integers, or out
3930 of many copies of a given value:
3932 @smallexample
3933 @group
3934 1:  [1, 2, 3, 4]    2:  [1, 2, 3, 4]    2:  [1, 2, 3, 4]
3935     .               1:  17              1:  [17, 17, 17, 17]
3936                         .                   .
3938     v x 4 @key{RET}           17                  v b 4 @key{RET}
3939 @end group
3940 @end smallexample
3942 You can apply an operator to every element of a vector using the
3943 @dfn{map} command.
3945 @smallexample
3946 @group
3947 1:  [17, 34, 51, 68]   1:  [289, 1156, 2601, 4624]  1:  [17, 34, 51, 68]
3948     .                      .                            .
3950     V M *                  2 V M ^                      V M Q
3951 @end group
3952 @end smallexample
3954 @noindent
3955 In the first step, we multiply the vector of integers by the vector
3956 of 17's elementwise.  In the second step, we raise each element to
3957 the power two.  (The general rule is that both operands must be
3958 vectors of the same length, or else one must be a vector and the
3959 other a plain number.)  In the final step, we take the square root
3960 of each element.
3962 (@bullet{}) @strong{Exercise 1.}  Compute a vector of powers of two
3963 from 
3964 @texline @math{2^{-4}}
3965 @infoline @expr{2^-4} 
3966 to @expr{2^4}.  @xref{List Answer 1, 1}. (@bullet{})
3968 You can also @dfn{reduce} a binary operator across a vector.
3969 For example, reducing @samp{*} computes the product of all the
3970 elements in the vector:
3972 @smallexample
3973 @group
3974 1:  123123     1:  [3, 7, 11, 13, 41]      1:  123123
3975     .              .                           .
3977     123123         k f                         V R *
3978 @end group
3979 @end smallexample
3981 @noindent
3982 In this example, we decompose 123123 into its prime factors, then
3983 multiply those factors together again to yield the original number.
3985 We could compute a dot product ``by hand'' using mapping and
3986 reduction:
3988 @smallexample
3989 @group
3990 2:  [1, 2, 3]     1:  [7, 12, 0]     1:  19
3991 1:  [7, 6, 0]         .                  .
3992     .
3994     r 1 r 2           V M *              V R +
3995 @end group
3996 @end smallexample
3998 @noindent
3999 Recalling two vectors from the previous section, we compute the
4000 sum of pairwise products of the elements to get the same answer
4001 for the dot product as before.
4003 A slight variant of vector reduction is the @dfn{accumulate} operation,
4004 @kbd{V U}.  This produces a vector of the intermediate results from
4005 a corresponding reduction.  Here we compute a table of factorials:
4007 @smallexample
4008 @group
4009 1:  [1, 2, 3, 4, 5, 6]    1:  [1, 2, 6, 24, 120, 720]
4010     .                         .
4012     v x 6 @key{RET}                 V U *
4013 @end group
4014 @end smallexample
4016 Calc allows vectors to grow as large as you like, although it gets
4017 rather slow if vectors have more than about a hundred elements.
4018 Actually, most of the time is spent formatting these large vectors
4019 for display, not calculating on them.  Try the following experiment
4020 (if your computer is very fast you may need to substitute a larger
4021 vector size).
4023 @smallexample
4024 @group
4025 1:  [1, 2, 3, 4, ...      1:  [2, 3, 4, 5, ...
4026     .                         .
4028     v x 500 @key{RET}               1 V M +
4029 @end group
4030 @end smallexample
4032 Now press @kbd{v .} (the letter @kbd{v}, then a period) and try the
4033 experiment again.  In @kbd{v .} mode, long vectors are displayed
4034 ``abbreviated'' like this:
4036 @smallexample
4037 @group
4038 1:  [1, 2, 3, ..., 500]   1:  [2, 3, 4, ..., 501]
4039     .                         .
4041     v x 500 @key{RET}               1 V M +
4042 @end group
4043 @end smallexample
4045 @noindent
4046 (where now the @samp{...} is actually part of the Calc display).
4047 You will find both operations are now much faster.  But notice that
4048 even in @w{@kbd{v .}} mode, the full vectors are still shown in the Trail.
4049 Type @w{@kbd{t .}} to cause the trail to abbreviate as well, and try the
4050 experiment one more time.  Operations on long vectors are now quite
4051 fast!  (But of course if you use @kbd{t .} you will lose the ability
4052 to get old vectors back using the @kbd{t y} command.)
4054 An easy way to view a full vector when @kbd{v .} mode is active is
4055 to press @kbd{`} (back-quote) to edit the vector; editing always works
4056 with the full, unabbreviated value.
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
4063 As a larger example, let's try to fit a straight line to some data,
4064 using the method of least squares.  (Calc has a built-in command for
4065 least-squares curve fitting, but we'll do it by hand here just to
4066 practice working with vectors.)  Suppose we have the following list
4067 of values in a file we have loaded into Emacs:
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
4093 @noindent
4094 If you are reading this tutorial in printed form, you will find it
4095 easiest to press @kbd{M-# i} to enter the on-line Info version of
4096 the manual and find this table there.  (Press @kbd{g}, then type
4097 @kbd{List Tutorial}, to jump straight to this section.)
4099 Position the cursor at the upper-left corner of this table, just
4100 to the left of the @expr{1.34}.  Press @kbd{C-@@} to set the mark.
4101 (On your system this may be @kbd{C-2}, @kbd{C-@key{SPC}}, or @kbd{NUL}.)
4102 Now position the cursor to the lower-right, just after the @expr{1.354}.
4103 You have now defined this region as an Emacs ``rectangle.''  Still
4104 in the Info buffer, type @kbd{M-# r}.  This command
4105 (@code{calc-grab-rectangle}) will pop you back into the Calculator, with
4106 the contents of the rectangle you specified in the form of a matrix.
4108 @smallexample
4109 @group
4110 1:  [ [ 1.34, 0.234 ]
4111       [ 1.41, 0.298 ]
4112       @dots{}
4113 @end group
4114 @end smallexample
4116 @noindent
4117 (You may wish to use @kbd{v .} mode to abbreviate the display of this
4118 large matrix.)
4120 We want to treat this as a pair of lists.  The first step is to
4121 transpose this matrix into a pair of rows.  Remember, a matrix is
4122 just a vector of vectors.  So we can unpack the matrix into a pair
4123 of row vectors on the stack.
4125 @smallexample
4126 @group
4127 1:  [ [ 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     .                                      .
4131     v t                                    v u
4132 @end group
4133 @end smallexample
4135 @noindent
4136 Let's store these in quick variables 1 and 2, respectively.
4138 @smallexample
4139 @group
4140 1:  [1.34, 1.41, 1.49, ... ]        .
4141     .
4143     t 2                             t 1
4144 @end group
4145 @end smallexample
4147 @noindent
4148 (Recall that @kbd{t 2} is a variant of @kbd{s 2} that removes the
4149 stored value from the stack.)
4151 In a least squares fit, the slope @expr{m} is given by the formula
4153 @ifinfo
4154 @example
4155 m = (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
4166 @noindent
4167 where 
4168 @texline @math{\sum x}
4169 @infoline @expr{sum(x)} 
4170 represents the sum of all the values of @expr{x}.  While there is an
4171 actual @code{sum} function in Calc, it's easier to sum a vector using a
4172 simple reduction.  First, let's compute the four different sums that
4173 this formula uses.
4175 @smallexample
4176 @group
4177 1:  41.63                 1:  98.0003
4178     .                         .
4180  r 1 V R +   t 3           r 1 2 V M ^ V R +   t 4
4182 @end group
4183 @end smallexample
4184 @noindent
4185 @smallexample
4186 @group
4187 1:  13.613                1:  33.36554
4188     .                         .
4190  r 2 V R +   t 5           r 1 r 2 V M * V R +   t 6
4191 @end group
4192 @end smallexample
4194 @ifinfo
4195 @noindent
4196 These are @samp{sum(x)}, @samp{sum(x^2)}, @samp{sum(y)}, and @samp{sum(x y)},
4197 respectively.  (We could have used @kbd{*} to compute @samp{sum(x^2)} and
4198 @samp{sum(x y)}.)
4199 @end ifinfo
4200 @tex
4201 \turnoffactive
4202 These are $\sum x$, $\sum x^2$, $\sum y$, and $\sum x y$,
4203 respectively.  (We could have used \kbd{*} to compute $\sum x^2$ and
4204 $\sum x y$.)
4205 @end tex
4207 Finally, we also need @expr{N}, the number of data points.  This is just
4208 the length of either of our lists.
4210 @smallexample
4211 @group
4212 1:  19
4213     .
4215  r 1 v l   t 7
4216 @end group
4217 @end smallexample
4219 @noindent
4220 (That's @kbd{v} followed by a lower-case @kbd{l}.)
4222 Now we grind through the formula:
4224 @smallexample
4225 @group
4226 1:  633.94526  2:  633.94526  1:  67.23607
4227     .          1:  566.70919      .
4228                    .
4230  r 7 r 6 *      r 3 r 5 *         -
4232 @end group
4233 @end smallexample
4234 @noindent
4235 @smallexample
4236 @group
4237 2:  67.23607   3:  67.23607   2:  67.23607   1:  0.52141679
4238 1:  1862.0057  2:  1862.0057  1:  128.9488       .
4239     .          1:  1733.0569      .
4240                    .
4242  r 7 r 4 *      r 3 2 ^           -              /   t 8
4243 @end group
4244 @end smallexample
4246 That gives us the slope @expr{m}.  The y-intercept @expr{b} can now
4247 be found with the simple formula,
4249 @ifinfo
4250 @example
4251 b = (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
4262 @smallexample
4263 @group
4264 1:  13.613     2:  13.613     1:  -8.09358   1:  -0.425978
4265     .          1:  21.70658       .              .
4266                    .
4268    r 5            r 8 r 3 *       -              r 7 /   t 9
4269 @end group
4270 @end smallexample
4272 Let's ``plot'' this straight line approximation, 
4273 @texline @math{y \approx m x + b},
4274 @infoline @expr{m x + b}, 
4275 and compare it with the original data.
4277 @smallexample
4278 @group
4279 1:  [0.699, 0.735, ... ]    1:  [0.273, 0.309, ... ]
4280     .                           .
4282     r 1 r 8 *                   r 9 +    s 0
4283 @end group
4284 @end smallexample
4286 @noindent
4287 Notice that multiplying a vector by a constant, and adding a constant
4288 to a vector, can be done without mapping commands since these are
4289 common operations from vector algebra.  As far as Calc is concerned,
4290 we've just been doing geometry in 19-dimensional space!
4292 We can subtract this vector from our original @expr{y} vector to get
4293 a feel for the error of our fit.  Let's find the maximum error:
4295 @smallexample
4296 @group
4297 1:  [0.0387, 0.0112, ... ]   1:  [0.0387, 0.0112, ... ]   1:  0.0897
4298     .                            .                            .
4300     r 2 -                        V M A                        V R X
4301 @end group
4302 @end smallexample
4304 @noindent
4305 First we compute a vector of differences, then we take the absolute
4306 values of these differences, then we reduce the @code{max} function
4307 across 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
4309 operation, the letters @kbd{X} and @kbd{N} are also accepted for
4310 @code{max} and @code{min} in this context.  In general, you answer
4311 the @kbd{V M} or @kbd{V R} prompt with the actual key sequence that
4312 invokes the function you want.  You could have typed @kbd{V R f x} or
4313 even @kbd{V R x max @key{RET}} if you had preferred.)
4315 If your system has the GNUPLOT program, you can see graphs of your
4316 data and your straight line to see how well they match.  (If you have
4317 GNUPLOT 3.0 or higher, the following instructions will work regardless
4318 of the kind of display you have.  Some GNUPLOT 2.0, non-X-windows systems
4319 may require additional steps to view the graphs.)
4321 Let's start by plotting the original data.  Recall the ``@var{x}'' and ``@var{y}''
4322 vectors onto the stack and press @kbd{g f}.  This ``fast'' graphing
4323 command does everything you need to do for simple, straightforward
4324 plotting of data.
4326 @smallexample
4327 @group
4328 2:  [1.34, 1.41, 1.49, ... ]
4329 1:  [0.234, 0.298, 0.402, ... ]
4330     .
4332     r 1 r 2    g f
4333 @end group
4334 @end smallexample
4336 If all goes well, you will shortly get a new window containing a graph
4337 of the data.  (If not, contact your GNUPLOT or Calc installer to find
4338 out what went wrong.)  In the X window system, this will be a separate
4339 graphics window.  For other kinds of displays, the default is to
4340 display the graph in Emacs itself using rough character graphics.
4341 Press @kbd{q} when you are done viewing the character graphics.
4343 Next, 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
4347 replaced by a buffer named @samp{*Gnuplot Commands*}.  The tutorial
4348 will reappear when you terminate GNUPLOT by typing @kbd{g q}.) 
4349 @end ifinfo
4351 @smallexample
4352 @group
4353 2:  [1.34, 1.41, 1.49, ... ]
4354 1:  [0.273, 0.309, 0.351, ... ]
4355     .
4357     @key{DEL} r 0    g a  g p
4358 @end group
4359 @end smallexample
4361 It's not very useful to get symbols to mark the data points on this
4362 second curve; you can type @kbd{g S g p} to remove them.  Type @kbd{g q}
4363 when you are done to remove the X graphics window and terminate GNUPLOT.
4365 (@bullet{}) @strong{Exercise 2.}  An earlier exercise showed how to do
4366 least squares fitting to a general system of equations.  Our 19 data
4367 points are really 19 equations of the form @expr{y_i = m x_i + b} for
4368 different pairs of @expr{(x_i,y_i)}.  Use the matrix-transpose method
4369 to solve for @expr{m} and @expr{b}, duplicating the above result.
4370 @xref{List Answer 2, 2}. (@bullet{})
4372 @cindex Geometric mean
4373 (@bullet{}) @strong{Exercise 3.}  If the input data do not form a
4374 rectangle, you can use @w{@kbd{M-# g}} (@code{calc-grab-region})
4375 to grab the data the way Emacs normally works with regions---it reads
4376 left-to-right, top-to-bottom, treating line breaks the same as spaces.
4377 Use 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.)
4380 @example
4381 2.3  6  22  15.1  7
4382   15  14  7.5
4383   2.5
4384 @end example
4386 @noindent
4387 The @kbd{M-# g} command accepts numbers separated by spaces or commas,
4388 with or without surrounding vector brackets.
4389 @xref{List Answer 3, 3}. (@bullet{})
4391 @ifinfo
4392 As another example, a theorem about binomial coefficients tells
4393 us that the alternating sum of binomial coefficients
4394 @var{n}-choose-0 minus @var{n}-choose-1 plus @var{n}-choose-2, and so
4395 on up to @var{n}-choose-@var{n},
4396 always comes out to zero.  Let's verify this
4397 for @expr{n=6}.
4398 @end ifinfo
4399 @tex
4400 As another example, a theorem about binomial coefficients tells
4401 us that the alternating sum of binomial coefficients
4402 ${n \choose 0} - {n \choose 1} + {n \choose 2} - \cdots \pm {n \choose n}$
4403 always comes out to zero.  Let's verify this
4404 for \cite{n=6}.
4405 @end tex
4407 @smallexample
4408 @group
4409 1:  [1, 2, 3, 4, 5, 6, 7]     1:  [0, 1, 2, 3, 4, 5, 6]
4410     .                             .
4412     v x 7 @key{RET}                     1 -
4414 @end group
4415 @end smallexample
4416 @noindent
4417 @smallexample
4418 @group
4419 1:  [1, -6, 15, -20, 15, -6, 1]          1:  0
4420     .                                        .
4422     V M ' (-1)^$ choose(6,$) @key{RET}             V R +
4423 @end group
4424 @end smallexample
4426 The @kbd{V M '} command prompts you to enter any algebraic expression
4427 to define the function to map over the vector.  The symbol @samp{$}
4428 inside this expression represents the argument to the function.
4429 The Calculator applies this formula to each element of the vector,
4430 substituting each element's value for the @samp{$} sign(s) in turn.
4432 To define a two-argument function, use @samp{$$} for the first
4433 argument and @samp{$} for the second:  @kbd{V M ' $$-$ @key{RET}} is
4434 equivalent to @kbd{V M -}.  This is analogous to regular algebraic
4435 entry, where @samp{$$} would refer to the next-to-top stack entry
4436 and @samp{$} would refer to the top stack entry, and @kbd{' $$-$ @key{RET}}
4437 would act exactly like @kbd{-}.
4439 Notice that the @kbd{V M '} command has recorded two things in the
4440 trail:  The result, as usual, and also a funny-looking thing marked
4441 @samp{oper} that represents the operator function you typed in.
4442 The function is enclosed in @samp{< >} brackets, and the argument is
4443 denoted by a @samp{#} sign.  If there were several arguments, they
4444 would 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
4446 trail.)  This object is a ``nameless function''; you can use nameless
4447 @w{@samp{< >}} notation to answer the @kbd{V M '} prompt if you like.
4448 Nameless function notation has the interesting, occasionally useful
4449 property that a nameless function is not actually evaluated until
4450 it 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
4452 of the vector, but @kbd{V M ' <#+random(2.0)>} evaluates the
4453 @samp{random(2.0)} separately for each vector element.
4455 Another group of operators that are often useful with @kbd{V M} are
4456 the relational operators:  @kbd{a =}, for example, compares two numbers
4457 and 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.
4460 Other useful vector operations include @kbd{v v}, to reverse a
4461 vector end-for-end; @kbd{V S}, to sort the elements of a vector
4462 into increasing order; and @kbd{v r} and @w{@kbd{v c}}, to extract
4463 one row or column of a matrix, or (in both cases) to extract one
4464 element of a plain vector.  With a negative argument, @kbd{v r}
4465 and @kbd{v c} instead delete one row, column, or vector element.
4467 @cindex Divisor functions
4468 (@bullet{}) @strong{Exercise 4.}  The @expr{k}th @dfn{divisor function}
4469 @tex
4470 $\sigma_k(n)$
4471 @end tex
4472 is the sum of the @expr{k}th powers of all the divisors of an
4473 integer @expr{n}.  Figure out a method for computing the divisor
4474 function for reasonably small values of @expr{n}.  As a test,
4475 the 0th and 1st divisor functions of 30 are 8 and 72, respectively.
4476 @xref{List Answer 4, 4}. (@bullet{})
4478 @cindex Square-free numbers
4479 @cindex Duplicate values in a list
4480 (@bullet{}) @strong{Exercise 5.}  The @kbd{k f} command produces a
4481 list of prime factors for a number.  Sometimes it is important to
4482 know that a number is @dfn{square-free}, i.e., that no prime occurs
4483 more than once in its list of prime factors.  Find a sequence of
4484 keystrokes to tell if a number is square-free; your method should
4485 leave 1 on the stack if it is, or 0 if it isn't.
4486 @xref{List Answer 5, 5}. (@bullet{})
4488 @cindex Triangular lists
4489 (@bullet{}) @strong{Exercise 6.}  Build a list of lists that looks
4490 like the following diagram.  (You may wish to use the @kbd{v /}
4491 command to enable multi-line display of vectors.)
4493 @smallexample
4494 @group
4495 1:  [ [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] ]
4501 @end group
4502 @end smallexample
4504 @noindent
4505 @xref{List Answer 6, 6}. (@bullet{})
4507 (@bullet{}) @strong{Exercise 7.}  Build the following list of lists.
4509 @smallexample
4510 @group
4511 1:  [ [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] ]
4517 @end group
4518 @end smallexample
4520 @noindent
4521 @xref{List Answer 7, 7}. (@bullet{})
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
4526 @texline @math{J_1(x)}
4527 @infoline @expr{J1} 
4528 function @samp{besJ(1,x)} for @expr{x} from 0 to 5 in steps of 0.25.
4529 Find the value of @expr{x} (from among the above set of values) for
4530 which @samp{besJ(1,x)} is a maximum.  Use an ``automatic'' method,
4531 i.e., just reading along the list by hand to find the largest value
4532 is not allowed!  (There is an @kbd{a X} command which does this kind
4533 of thing automatically; @pxref{Numerical Solutions}.)
4534 @xref{List Answer 8, 8}. (@bullet{})
4536 @cindex Digits, vectors of
4537 (@bullet{}) @strong{Exercise 9.}  You are given an integer in the range
4538 @texline @math{0 \le N < 10^m}
4539 @infoline @expr{0 <= N < 10^m} 
4540 for @expr{m=12} (i.e., an integer of less than
4541 twelve digits).  Convert this integer into a vector of @expr{m}
4542 digits, each in the range from 0 to 9.  In vector-of-digits notation,
4543 add one to this integer to produce a vector of @expr{m+1} digits
4544 (since there could be a carry out of the most significant digit).
4545 Convert this vector back into a regular integer.  A good integer
4546 to try is 25129925999.  @xref{List Answer 9, 9}. (@bullet{})
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
4550 happened?  How would you do this test?  @xref{List Answer 10, 10}. (@bullet{})
4552 (@bullet{}) @strong{Exercise 11.}  The area of a circle of radius one
4553 is @cpi{}.  The area of the 
4554 @texline @math{2\times2}
4555 @infoline 2x2
4556 square that encloses that circle is 4.  So if we throw @var{n} darts at
4557 random points in the square, about @cpiover{4} of them will land inside
4558 the circle.  This gives us an entertaining way to estimate the value of 
4559 @cpi{}.  The @w{@kbd{k r}}
4560 command picks a random number between zero and the value on the stack.
4561 We could get a random floating-point number between @mathit{-1} and 1 by typing
4562 @w{@kbd{2.0 k r 1 -}}.  Build a vector of 100 random @expr{(x,y)} points in
4563 this square, then use vector mapping and reduction to count how many
4564 points lie inside the unit circle.  Hint:  Use the @kbd{v b} command.
4565 @xref{List Answer 11, 11}. (@bullet{})
4567 @cindex Matchstick problem
4568 (@bullet{}) @strong{Exercise 12.}  The @dfn{matchstick problem} provides
4569 another way to calculate @cpi{}.  Say you have an infinite field
4570 of vertical lines with a spacing of one inch.  Toss a one-inch matchstick
4571 onto the field.  The probability that the matchstick will land crossing
4572 a line turns out to be 
4573 @texline @math{2/\pi}.
4574 @infoline @expr{2/pi}.  
4575 Toss 100 matchsticks to estimate @cpi{}.  (If you want still more fun,
4576 the probability that the GCD (@w{@kbd{k g}}) of two large integers is
4577 one turns out to be 
4578 @texline @math{6/\pi^2}.
4579 @infoline @expr{6/pi^2}.
4580 That provides yet another way to estimate @cpi{}.)
4581 @xref{List Answer 12, 12}. (@bullet{})
4583 (@bullet{}) @strong{Exercise 13.}  An algebraic entry of a string in
4584 double-quote marks, @samp{"hello"}, creates a vector of the numerical
4585 (ASCII) codes of the characters (here, @expr{[104, 101, 108, 108, 111]}).
4586 Sometimes it is convenient to compute a @dfn{hash code} of a string,
4587 which is just an integer that represents the value of that string.
4588 Two equal strings have the same hash code; two different strings
4589 @dfn{probably} have different hash codes.  (For example, Calc has
4590 over 400 function names, but Emacs can quickly find the definition for
4591 any given name because it has sorted the functions into ``buckets'' by
4592 their hash codes.  Sometimes a few names will hash into the same bucket,
4593 but it is easier to search among a few names than among all the names.)
4594 One popular hash function is computed as follows:  First set @expr{h = 0}.
4595 Then, for each character from the string in turn, set @expr{h = 3h + c_i}
4596 where @expr{c_i} is the character's ASCII code.  If we have 511 buckets,
4597 we then take the hash code modulo 511 to get the bucket number.  Develop a
4598 simple command or commands for converting string vectors into hash codes.
4599 The hash code for @samp{"Testing, 1, 2, 3"} is 1960915098, which modulo
4600 511 is 121.  @xref{List Answer 13, 13}. (@bullet{})
4602 (@bullet{}) @strong{Exercise 14.}  The @kbd{H V R} and @kbd{H V U}
4603 commands do nested function evaluations.  @kbd{H V U} takes a starting
4604 value and a number of steps @var{n} from the stack; it then applies the
4605 function you give to the starting value 0, 1, 2, up to @var{n} times
4606 and returns a vector of the results.  Use this command to create a
4607 ``random walk'' of 50 steps.  Start with the two-dimensional point
4608 @expr{(0,0)}; then take one step a random distance between @mathit{-1} and 1
4609 in both @expr{x} and @expr{y}; then take another step, and so on.  Use the
4610 @kbd{g f} command to display this random walk.  Now modify your random
4611 walk 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
4613 sine of an angle.)  @xref{List Answer 14, 14}. (@bullet{})
4615 @node Types Tutorial, Algebra Tutorial, Vector/Matrix Tutorial, Tutorial
4616 @section Types Tutorial
4618 @noindent
4619 Calc understands a variety of data types as well as simple numbers.
4620 In this section, we'll experiment with each of these types in turn.
4622 The numbers we've been using so far have mainly been either @dfn{integers}
4623 or @dfn{floats}.  We saw that floats are usually a good approximation to
4624 the mathematical concept of real numbers, but they are only approximations
4625 and are susceptible to roundoff error.  Calc also supports @dfn{fractions},
4626 which can exactly represent any rational number.
4628 @smallexample
4629 @group
4630 1:  3628800    2:  3628800    1:  518400:7   1:  518414:7   1:  7:518414
4631     .          1:  49             .              .              .
4632                    .
4634     10 !           49 @key{RET}         :              2 +            &
4635 @end group
4636 @end smallexample
4638 @noindent
4639 The @kbd{:} command divides two integers to get a fraction; @kbd{/}
4640 would normally divide integers to get a floating-point result.
4641 Notice we had to type @key{RET} between the @kbd{49} and the @kbd{:}
4642 since the @kbd{:} would otherwise be interpreted as part of a
4643 fraction beginning with 49.
4645 You can convert between floating-point and fractional format using
4646 @kbd{c f} and @kbd{c F}:
4648 @smallexample
4649 @group
4650 1:  1.35027217629e-5    1:  7:518414
4651     .                       .
4653     c f                     c F
4654 @end group
4655 @end smallexample
4657 The @kbd{c F} command replaces a floating-point number with the
4658 ``simplest'' fraction whose floating-point representation is the
4659 same, to within the current precision.
4661 @smallexample
4662 @group
4663 1:  3.14159265359   1:  1146408:364913   1:  3.1416   1:  355:113
4664     .                   .                    .            .
4666     P                   c F      @key{DEL}       p 5 @key{RET} P      c F
4667 @end group
4668 @end smallexample
4670 (@bullet{}) @strong{Exercise 1.}  A calculation has produced the
4671 result 1.26508260337.  You suspect it is the square root of the
4672 product of @cpi{} and some rational number.  Is it?  (Be sure
4673 to allow for roundoff error!)  @xref{Types Answer 1, 1}. (@bullet{})
4675 @dfn{Complex numbers} can be stored in both rectangular and polar form.
4677 @smallexample
4678 @group
4679 1:  -9     1:  (0, 3)    1:  (3; 90.)   1:  (6; 90.)   1:  (2.4495; 45.)
4680     .          .             .              .              .
4682     9 n        Q             c p            2 *            Q
4683 @end group
4684 @end smallexample
4686 @noindent
4687 The square root of @mathit{-9} is by default rendered in rectangular form
4688 (@w{@expr{0 + 3i}}), but we can convert it to polar form (3 with a
4689 phase angle of 90 degrees).  All the usual arithmetic and scientific
4690 operations are defined on both types of complex numbers.
4692 Another generalized kind of number is @dfn{infinity}.  Infinity
4693 isn't really a number, but it can sometimes be treated like one.
4694 Calc uses the symbol @code{inf} to represent positive infinity,
4695 i.e., a value greater than any real number.  Naturally, you can
4696 also write @samp{-inf} for minus infinity, a value less than any
4697 real number.  The word @code{inf} can only be input using
4698 algebraic entry.
4700 @smallexample
4701 @group
4702 2:  inf        2:  -inf       2:  -inf       2:  -inf       1:  nan
4703 1:  -17        1:  -inf       1:  -inf       1:  inf            .
4704     .              .              .              .
4706 ' inf @key{RET} 17 n     *  @key{RET}         72 +           A              +
4707 @end group
4708 @end smallexample
4710 @noindent
4711 Since infinity is infinitely large, multiplying it by any finite
4712 number (like @mathit{-17}) has no effect, except that since @mathit{-17}
4713 is negative, it changes a plus infinity to a minus infinity.
4714 (``A huge positive number, multiplied by @mathit{-17}, yields a huge
4715 negative number.'')  Adding any finite number to infinity also
4716 leaves it unchanged.  Taking an absolute value gives us plus
4717 infinity again.  Finally, we add this plus infinity to the minus
4718 infinity we had earlier.  If you work it out, you might expect
4719 the answer to be @mathit{-72} for this.  But the 72 has been completely
4720 lost next to the infinities; by the time we compute @w{@samp{inf - inf}}
4721 the finite difference between them, if any, is undetectable.
4722 So we say the result is @dfn{indeterminate}, which Calc writes
4723 with the symbol @code{nan} (for Not A Number).
4725 Dividing by zero is normally treated as an error, but you can get
4726 Calc to write an answer in terms of infinity by pressing @kbd{m i}
4727 to turn on Infinite mode.
4729 @smallexample
4730 @group
4731 3:  nan        2:  nan        2:  nan        2:  nan        1:  nan
4732 2:  1          1:  1 / 0      1:  uinf       1:  uinf           .
4733 1:  0              .              .              .
4734     .
4736   1 @key{RET} 0          /       m i    U /            17 n *         +
4737 @end group
4738 @end smallexample
4740 @noindent
4741 Dividing by zero normally is left unevaluated, but after @kbd{m i}
4742 it instead gives an infinite result.  The answer is actually
4743 @code{uinf}, ``undirected infinity.''  If you look at a graph of
4744 @expr{1 / x} around @w{@expr{x = 0}}, you'll see that it goes toward
4745 plus infinity as you approach zero from above, but toward minus
4746 infinity as you approach from below.  Since we said only @expr{1 / 0},
4747 Calc knows that the answer is infinite but not in which direction.
4748 That's what @code{uinf} means.  Notice that multiplying @code{uinf}
4749 by a negative number still leaves plain @code{uinf}; there's no
4750 point in saying @samp{-uinf} because the sign of @code{uinf} is
4751 unknown anyway.  Finally, we add @code{uinf} to our @code{nan},
4752 yielding @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
4756 that matter, with anything else.
4758 (@bullet{}) @strong{Exercise 2.}  Predict what Calc will answer
4759 for 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{})
4764 (@bullet{}) @strong{Exercise 3.}  We saw that @samp{inf - inf = nan},
4765 which stands for an unknown value.  Can @code{nan} stand for
4766 a complex number?  Can it stand for infinity?
4767 @xref{Types Answer 3, 3}. (@bullet{})
4769 @dfn{HMS forms} represent a value in terms of hours, minutes, and
4770 seconds.
4772 @smallexample
4773 @group
4774 1:  2@@ 30' 0"     1:  3@@ 30' 0"     2:  3@@ 30' 0"     1:  2.
4775     .                 .             1:  1@@ 45' 0."        .
4776                                         .
4778   2@@ 30' @key{RET}          1 +               @key{RET} 2 /           /
4779 @end group
4780 @end smallexample
4782 HMS forms can also be used to hold angles in degrees, minutes, and
4783 seconds.
4785 @smallexample
4786 @group
4787 1:  0.5        1:  26.56505   1:  26@@ 33' 54.18"    1:  0.44721
4788     .              .              .                     .
4790     0.5            I T            c h                   S
4791 @end group
4792 @end smallexample
4794 @noindent
4795 First we convert the inverse tangent of 0.5 to degrees-minutes-seconds
4796 form, then we take the sine of that angle.  Note that the trigonometric
4797 functions will accept HMS forms directly as input.
4799 @cindex Beatles
4800 (@bullet{}) @strong{Exercise 4.}  The Beatles' @emph{Abbey Road} is
4801 47 minutes and 26 seconds long, and contains 17 songs.  What is the
4802 average length of a song on @emph{Abbey Road}?  If the Extended Disco
4803 Version of @emph{Abbey Road} added 20 seconds to the length of each
4804 song, how long would the album be?  @xref{Types Answer 4, 4}. (@bullet{})
4806 A @dfn{date form} represents a date, or a date and time.  Dates must
4807 be entered using algebraic entry.  Date forms are surrounded by
4808 @samp{< >} symbols; most standard formats for dates are recognized.
4810 @smallexample
4811 @group
4812 2:  <Sun Jan 13, 1991>                    1:  2.25
4813 1:  <6:00pm Thu Jan 10, 1991>                 .
4814     .
4816 ' <13 Jan 1991>, <1/10/91, 6pm> @key{RET}           -
4817 @end group
4818 @end smallexample
4820 @noindent
4821 In this example, we enter two dates, then subtract to find the
4822 number of days between them.  It is also possible to add an
4823 HMS form or a number (of days) to a date form to get another
4824 date form.
4826 @smallexample
4827 @group
4828 1:  <4:45:59pm Mon Jan 14, 1991>     1:  <2:50:59am Thu Jan 17, 1991>
4829     .                                    .
4831     t N                                  2 + 10@@ 5' +
4832 @end group
4833 @end smallexample
4835 @c [fix-ref Date Arithmetic]
4836 @noindent
4837 The @kbd{t N} (``now'') command pushes the current date and time on the
4838 stack; then we add two days, ten hours and five minutes to the date and
4839 time.  Other date-and-time related commands include @kbd{t J}, which
4840 does Julian day conversions, @kbd{t W}, which finds the beginning of
4841 the week in which a date form lies, and @kbd{t I}, which increments a
4842 date by one or several months.  @xref{Date Arithmetic}, for more.
4844 (@bullet{}) @strong{Exercise 5.}  How many days until the next
4845 Friday the 13th?  @xref{Types Answer 5, 5}. (@bullet{})
4847 (@bullet{}) @strong{Exercise 6.}  How many leap years will there be
4848 between now and the year 10001 A.D.?  @xref{Types Answer 6, 6}. (@bullet{})
4850 @cindex Slope and angle of a line
4851 @cindex Angle and slope of a line
4852 An @dfn{error form} represents a mean value with an attached standard
4853 deviation, or error estimate.  Suppose our measurements indicate that
4854 a certain telephone pole is about 30 meters away, with an estimated
4855 error of 1 meter, and 8 meters tall, with an estimated error of 0.2
4856 meters.  What is the slope of a line from here to the top of the
4857 pole, and what is the equivalent angle in degrees?
4859 @smallexample
4860 @group
4861 1:  8 +/- 0.2    2:  8 +/- 0.2   1:  0.266 +/- 0.011   1:  14.93 +/- 0.594
4862     .            1:  30 +/- 1        .                     .
4863                      .
4865     8 p .2 @key{RET}       30 p 1          /                     I T
4866 @end group
4867 @end smallexample
4869 @noindent
4870 This means that the angle is about 15 degrees, and, assuming our
4871 original error estimates were valid standard deviations, there is about
4872 a 60% chance that the result is correct within 0.59 degrees.
4874 @cindex Torus, volume of
4875 (@bullet{}) @strong{Exercise 7.}  The volume of a torus (a donut shape) is
4876 @texline @math{2 \pi^2 R r^2}
4877 @infoline @w{@expr{2 pi^2 R r^2}} 
4878 where @expr{R} is the radius of the circle that
4879 defines the center of the tube and @expr{r} is the radius of the tube
4880 itself.  Suppose @expr{R} is 20 cm and @expr{r} is 4 cm, each known to
4881 within 5 percent.  What is the volume and the relative uncertainty of
4882 the volume?  @xref{Types Answer 7, 7}. (@bullet{})
4884 An @dfn{interval form} represents a range of values.  While an
4885 error form is best for making statistical estimates, intervals give
4886 you exact bounds on an answer.  Suppose we additionally know that
4887 our telephone pole is definitely between 28 and 31 meters away,
4888 and that it is between 7.7 and 8.1 meters tall.
4890 @smallexample
4891 @group
4892 1:  [7.7 .. 8.1]  2:  [7.7 .. 8.1]  1:  [0.24 .. 0.28]  1:  [13.9 .. 16.1]
4893     .             1:  [28 .. 31]        .                   .
4894                       .
4896   [ 7.7 .. 8.1 ]    [ 28 .. 31 ]        /                   I T
4897 @end group
4898 @end smallexample
4900 @noindent
4901 If our bounds were correct, then the angle to the top of the pole
4902 is sure to lie in the range shown.
4904 The square brackets around these intervals indicate that the endpoints
4905 themselves are allowable values.  In other words, the distance to the
4906 telephone pole is between 28 and 31, @emph{inclusive}.  You can also
4907 make an interval that is exclusive of its endpoints by writing
4908 parentheses instead of square brackets.  You can even make an interval
4909 which is inclusive (``closed'') on one end and exclusive (``open'') on
4910 the other.
4912 @smallexample
4913 @group
4914 1:  [1 .. 10)    1:  (0.1 .. 1]   2:  (0.1 .. 1]   1:  (0.2 .. 3)
4915     .                .            1:  [2 .. 3)         .
4916                                       .
4918   [ 1 .. 10 )        &              [ 2 .. 3 )         *
4919 @end group
4920 @end smallexample
4922 @noindent
4923 The Calculator automatically keeps track of which end values should
4924 be open and which should be closed.  You can also make infinite or
4925 semi-infinite intervals by using @samp{-inf} or @samp{inf} for one
4926 or both endpoints.
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
4930 about @samp{@w{1 /} @w{[0 .. 10]}} (where the interval actually includes
4931 zero)?  What about @samp{@w{1 /} @w{(-10 .. 10)}}?
4932 @xref{Types Answer 8, 8}. (@bullet{})
4934 (@bullet{}) @strong{Exercise 9.}  Two easy ways of squaring a number
4935 are @kbd{@key{RET} *} and @w{@kbd{2 ^}}.  Normally these produce the same
4936 answer.  Would you expect this still to hold true for interval forms?
4937 If not, which of these will result in a larger interval?
4938 @xref{Types Answer 9, 9}. (@bullet{})
4940 A @dfn{modulo form} is used for performing arithmetic modulo @var{m}.
4941 For example, arithmetic involving time is generally done modulo 12
4942 or 24 hours.
4944 @smallexample
4945 @group
4946 1:  17 mod 24    1:  3 mod 24     1:  21 mod 24    1:  9 mod 24
4947     .                .                .                .
4949     17 M 24 @key{RET}      10 +             n                5 /
4950 @end group
4951 @end smallexample
4953 @noindent
4954 In this last step, Calc has divided by 5 modulo 24; i.e., it has found a
4955 new number which, when multiplied by 5 modulo 24, produces the original
4956 number, 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. 
4960 @smallexample
4961 @group
4962 1:  10 mod 24    1:  16 mod 24    1:  1000000...   1:  16
4963     .                .                .                .
4965     10 M 24 @key{RET}      100 ^            10 @key{RET} 100 ^     24 %
4966 @end group
4967 @end smallexample
4969 @noindent
4970 These two calculations get the same answer, but the first one is
4971 much more efficient because it avoids the huge intermediate value
4972 that arises in the second one.
4974 @cindex Fermat, primality test of
4975 (@bullet{}) @strong{Exercise 10.}  A theorem of Pierre de Fermat
4976 says that 
4977 @texline @w{@math{x^{n-1} \bmod n = 1}}
4978 @infoline @expr{x^(n-1) mod n = 1}
4979 if @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
4982 informally if a number is prime by trying this formula for several
4983 values of @expr{x}.  Use this test to tell whether the following numbers
4984 are prime: 811749613, 15485863.  @xref{Types Answer 10, 10}. (@bullet{})
4986 It is possible to use HMS forms as parts of error forms, intervals,
4987 modulo forms, or as the phase part of a polar complex number.
4988 For example, the @code{calc-time} command pushes the current time
4989 of day on the stack as an HMS/modulo form.
4991 @smallexample
4992 @group
4993 1:  17@@ 34' 45" mod 24@@ 0' 0"     1:  6@@ 22' 15" mod 24@@ 0' 0"
4994     .                                 .
4996     x time @key{RET}                        n
4997 @end group
4998 @end smallexample
5000 @noindent
5001 This calculation tells me it is six hours and 22 minutes until midnight.
5003 (@bullet{}) @strong{Exercise 11.}  A rule of thumb is that one year
5004 is about 
5005 @texline @math{\pi \times 10^7}
5006 @infoline @w{@expr{pi * 10^7}} 
5007 seconds.  What time will it be that many seconds from right now?
5008 @xref{Types Answer 11, 11}. (@bullet{})
5010 (@bullet{}) @strong{Exercise 12.}  You are preparing to order packaging
5011 for the CD release of the Extended Disco Version of @emph{Abbey Road}.
5012 You are told that the songs will actually be anywhere from 20 to 60
5013 seconds longer than the originals.  One CD can hold about 75 minutes
5014 of music.  Should you order single or double packages?
5015 @xref{Types Answer 12, 12}. (@bullet{})
5017 Another 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
5019 application of algebraic expressions, where we use variables with
5020 suggestive names like @samp{cm} and @samp{in} to represent units
5021 like centimeters and inches.
5023 @smallexample
5024 @group
5025 1:  2 in        1:  5.08 cm      1:  0.027778 fath   1:  0.0508 m
5026     .               .                .                   .
5028     ' 2in @key{RET}       u c cm @key{RET}       u c fath @key{RET}        u b
5029 @end group
5030 @end smallexample
5032 @noindent
5033 We enter the quantity ``2 inches'' (actually an algebraic expression
5034 which means two times the variable @samp{in}), then we convert it
5035 first to centimeters, then to fathoms, then finally to ``base'' units,
5036 which in this case means meters.
5038 @smallexample
5039 @group
5040 1:  9 acre     1:  3 sqrt(acre)   1:  190.84 m   1:  190.84 m + 30 cm
5041     .              .                  .              .
5043  ' 9 acre @key{RET}      Q                  u s            ' $+30 cm @key{RET}
5045 @end group
5046 @end smallexample
5047 @noindent
5048 @smallexample
5049 @group
5050 1:  191.14 m     1:  36536.3046 m^2    1:  365363046 cm^2
5051     .                .                     .
5053     u s              2 ^                   u c cgs
5054 @end group
5055 @end smallexample
5057 @noindent
5058 Since units expressions are really just formulas, taking the square
5059 root of @samp{acre} is undefined.  After all, @code{acre} might be an
5060 algebraic variable that you will someday assign a value.  We use the
5061 ``units-simplify'' command to simplify the expression with variables
5062 being interpreted as unit names.
5064 In the final step, we have converted not to a particular unit, but to a
5065 units system.  The ``cgs'' system uses centimeters instead of meters
5066 as its standard unit of length.
5068 There is a wide variety of units defined in the Calculator.
5070 @smallexample
5071 @group
5072 1:  55 mph     1:  88.5139 kph   1:   88.5139 km / hr   1:  8.201407e-8 c
5073     .              .                  .                     .
5075  ' 55 mph @key{RET}      u c kph @key{RET}        u c km/hr @key{RET}         u c c @key{RET}
5076 @end group
5077 @end smallexample
5079 @noindent
5080 We express a speed first in miles per hour, then in kilometers per
5081 hour, then again using a slightly more explicit notation, then
5082 finally in terms of fractions of the speed of light.
5084 Temperature conversions are a bit more tricky.  There are two ways to
5085 interpret ``20 degrees Fahrenheit''---it could mean an actual
5086 temperature, or it could mean a change in temperature.  For normal
5087 units there is no difference, but temperature units have an offset
5088 as well as a scale factor and so there must be two explicit commands
5089 for them.
5091 @smallexample
5092 @group
5093 1:  20 degF       1:  11.1111 degC     1:  -20:3 degC    1:  -6.666 degC
5094     .                 .                    .                 .
5096   ' 20 degF @key{RET}       u c degC @key{RET}         U u t degC @key{RET}    c f
5097 @end group
5098 @end smallexample
5100 @noindent
5101 First we convert a change of 20 degrees Fahrenheit into an equivalent
5102 change in degrees Celsius (or Centigrade).  Then, we convert the
5103 absolute temperature 20 degrees Fahrenheit into Celsius.  Since
5104 this comes out as an exact fraction, we then convert to floating-point
5105 for easier comparison with the other result.
5107 For simple unit conversions, you can put a plain number on the stack.
5108 Then @kbd{u c} and @kbd{u t} will prompt for both old and new units.
5109 When you use this method, you're responsible for remembering which
5110 numbers are in which units:
5112 @smallexample
5113 @group
5114 1:  55         1:  88.5139              1:  8.201407e-8
5115     .              .                        .
5117     55             u c mph @key{RET} kph @key{RET}      u c km/hr @key{RET} c @key{RET}
5118 @end group
5119 @end smallexample
5121 To 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
5123 at the units table.
5125 (@bullet{}) @strong{Exercise 13.}  How many seconds are there really
5126 in a year?  @xref{Types Answer 13, 13}. (@bullet{})
5128 @cindex Speed of light
5129 (@bullet{}) @strong{Exercise 14.}  Supercomputer designs are limited by
5130 the speed of light (and of electricity, which is nearly as fast).
5131 Suppose a computer has a 4.1 ns (nanosecond) clock cycle, and its
5132 cabinet is one meter across.  Is speed of light going to be a
5133 significant factor in its design?  @xref{Types Answer 14, 14}. (@bullet{})
5135 (@bullet{}) @strong{Exercise 15.}  Sam the Slug normally travels about
5136 five yards in an hour.  He has obtained a supply of Power Pills; each
5137 Power Pill he eats doubles his speed.  How many Power Pills can he
5138 swallow and still travel legally on most US highways?
5139 @xref{Types Answer 15, 15}. (@bullet{})
5141 @node Algebra Tutorial, Programming Tutorial, Types Tutorial, Tutorial
5142 @section Algebra and Calculus Tutorial
5144 @noindent
5145 This section shows how to use Calc's algebra facilities to solve
5146 equations, do simple calculus problems, and manipulate algebraic
5147 formulas.
5149 @menu
5150 * Basic Algebra Tutorial::
5151 * Rewrites Tutorial::
5152 @end menu
5154 @node Basic Algebra Tutorial, Rewrites Tutorial, Algebra Tutorial, Algebra Tutorial
5155 @subsection Basic Algebra
5157 @noindent
5158 If you enter a formula in Algebraic mode that refers to variables,
5159 the formula itself is pushed onto the stack.  You can manipulate
5160 formulas as regular data objects.
5162 @smallexample
5163 @group
5164 1:  2 x^2 - 6       1:  6 - 2 x^2       1:  (6 - 2 x^2) (3 x^2 + y)
5165     .                   .                   .
5167     ' 2x^2-6 @key{RET}        n                   ' 3x^2+y @key{RET} *
5168 @end group
5169 @end smallexample
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})?
5173 Why or why not?  @xref{Algebra Answer 1, 1}. (@bullet{})
5175 There are also commands for doing common algebraic operations on
5176 formulas.  Continuing with the formula from the last example,
5178 @smallexample
5179 @group
5180 1:  18 x^2 + 6 y - 6 x^4 - 2 x^2 y    1:  (18 - 2 y) x^2 - 6 x^4 + 6 y
5181     .                                     .
5183     a x                                   a c x @key{RET}
5184 @end group
5185 @end smallexample
5187 @noindent
5188 First we ``expand'' using the distributive law, then we ``collect''
5189 terms involving like powers of @expr{x}.
5191 Let's find the value of this expression when @expr{x} is 2 and @expr{y}
5192 is one-half.
5194 @smallexample
5195 @group
5196 1:  17 x^2 - 6 x^4 + 3      1:  -25
5197     .                           .
5199     1:2 s l y @key{RET}               2 s l x @key{RET}
5200 @end group
5201 @end smallexample
5203 @noindent
5204 The @kbd{s l} command means ``let''; it takes a number from the top of
5205 the stack and temporarily assigns it as the value of the variable
5206 you specify.  It then evaluates (as if by the @kbd{=} key) the
5207 next expression on the stack.  After this command, the variable goes
5208 back to its original value, if any.
5210 (An earlier exercise in this tutorial involved storing a value in the
5211 variable @code{x}; if this value is still there, you will have to
5212 unstore it with @kbd{s u x @key{RET}} before the above example will work
5213 properly.)
5215 @cindex Maximum of a function using Calculus
5216 Let's find the maximum value of our original expression when @expr{y}
5217 is one-half and @expr{x} ranges over all possible values.  We can
5218 do this by taking the derivative with respect to @expr{x} and examining
5219 values of @expr{x} for which the derivative is zero.  If the second
5220 derivative of the function at that value of @expr{x} is negative,
5221 the function has a local maximum there.
5223 @smallexample
5224 @group
5225 1:  17 x^2 - 6 x^4 + 3      1:  34 x - 24 x^3
5226     .                           .
5228     U @key{DEL}  s 1                  a d x @key{RET}   s 2
5229 @end group
5230 @end smallexample
5232 @noindent
5233 Well, the derivative is clearly zero when @expr{x} is zero.  To find
5234 the other root(s), let's divide through by @expr{x} and then solve:
5236 @smallexample
5237 @group
5238 1:  (34 x - 24 x^3) / x    1:  34 x / x - 24 x^3 / x    1:  34 - 24 x^2
5239     .                          .                            .
5241     ' x @key{RET} /                  a x                          a s
5243 @end group
5244 @end smallexample
5245 @noindent
5246 @smallexample
5247 @group
5248 1:  34 - 24 x^2 = 0        1:  x = 1.19023
5249     .                          .
5251     0 a =  s 3                 a S x @key{RET}
5252 @end group
5253 @end smallexample
5255 @noindent
5256 Notice the use of @kbd{a s} to ``simplify'' the formula.  When the
5257 default algebraic simplifications don't do enough, you can use
5258 @kbd{a s} to tell Calc to spend more time on the job.
5260 Now we compute the second derivative and plug in our values of @expr{x}:
5262 @smallexample
5263 @group
5264 1:  1.19023        2:  1.19023         2:  1.19023
5265     .              1:  34 x - 24 x^3   1:  34 - 72 x^2
5266                        .                   .
5268     a .                r 2                 a d x @key{RET} s 4
5269 @end group
5270 @end smallexample
5272 @noindent
5273 (The @kbd{a .} command extracts just the righthand side of an equation.
5274 Another method would have been to use @kbd{v u} to unpack the equation
5275 @w{@samp{x = 1.19}} to @samp{x} and @samp{1.19}, then use @kbd{M-- M-2 @key{DEL}}
5276 to delete the @samp{x}.)
5278 @smallexample
5279 @group
5280 2:  34 - 72 x^2   1:  -68.         2:  34 - 72 x^2     1:  34
5281 1:  1.19023           .            1:  0                   .
5282     .                                  .
5284     @key{TAB}               s l x @key{RET}        U @key{DEL} 0             s l x @key{RET}
5285 @end group
5286 @end smallexample
5288 @noindent
5289 The first of these second derivatives is negative, so we know the function
5290 has a maximum value at @expr{x = 1.19023}.  (The function also has a
5291 local @emph{minimum} at @expr{x = 0}.)
5293 When 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
5295 two solutions.  The reason is that @w{@kbd{a S}} normally returns a
5296 single ``principal'' solution.  If it needs to come up with an
5297 arbitrary sign (as occurs in the quadratic formula) it picks @expr{+}.
5298 If it needs an arbitrary integer, it picks zero.  We can get a full
5299 solution by pressing @kbd{H} (the Hyperbolic flag) before @kbd{a S}.
5301 @smallexample
5302 @group
5303 1:  34 - 24 x^2 = 0    1:  x = 1.19023 s1      1:  x = -1.19023
5304     .                      .                       .
5306     r 3                    H a S x @key{RET}  s 5        1 n  s l s1 @key{RET}
5307 @end group
5308 @end smallexample
5310 @noindent
5311 Calc has invented the variable @samp{s1} to represent an unknown sign;
5312 it is supposed to be either @mathit{+1} or @mathit{-1}.  Here we have used
5313 the ``let'' command to evaluate the expression when the sign is negative.
5314 If we plugged this into our second derivative we would get the same,
5315 negative, answer, so @expr{x = -1.19023} is also a maximum.
5317 To find the actual maximum value, we must plug our two values of @expr{x}
5318 into the original formula.
5320 @smallexample
5321 @group
5322 2:  17 x^2 - 6 x^4 + 3    1:  24.08333 s1^2 - 12.04166 s1^4 + 3
5323 1:  x = 1.19023 s1            .
5324     .
5326     r 1 r 5                   s l @key{RET}
5327 @end group
5328 @end smallexample
5330 @noindent
5331 (Here we see another way to use @kbd{s l}; if its input is an equation
5332 with a variable on the lefthand side, then @kbd{s l} treats the equation
5333 like an assignment to that variable if you don't give a variable name.)
5335 It'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:
5338 @smallexample
5339 @group
5340 2:  [-1, 1]              1:  [15.04166, 15.04166]
5341 1:  24.08333 s1^2 ...        .
5342     .
5344   [ 1 n , 1 ] @key{TAB}            V M $ @key{RET}
5345 @end group
5346 @end smallexample
5348 @noindent
5349 Here we have used a vector mapping operation to evaluate the function
5350 at several values of @samp{s1} at once.  @kbd{V M $} is like @kbd{V M '}
5351 except that it takes the formula from the top of the stack.  The
5352 formula is interpreted as a function to apply across the vector at the
5353 next-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
5355 different arguments.  It prompts you for an @dfn{argument list}, giving
5356 the list of all variables in the formula in alphabetical order as the
5357 default list.  In this case the default is @samp{(s1)}, which is just
5358 what we want so we simply press @key{RET} at the prompt.
5360 If there had been several different values, we could have used
5361 @w{@kbd{V R X}} to find the global maximum.
5363 Calc 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
5365 automates the job we just did by hand.  Applied to our original
5366 cubic polynomial, it would produce the vector of solutions
5367 @expr{[1.19023, -1.19023, 0]}.  (There is also an @kbd{a X} command
5368 which finds a local maximum of a function.  It uses a numerical search
5369 method rather than examining the derivatives, and thus requires you
5370 to provide some kind of initial guess to show it where to look.)
5372 (@bullet{}) @strong{Exercise 2.}  Given a vector of the roots of a
5373 polynomial (such as the output of an @kbd{a P} command), what
5374 sequence of commands would you use to reconstruct the original
5375 polynomial?  (The answer will be unique to within a constant
5376 multiple; choose the solution where the leading coefficient is one.)
5377 @xref{Algebra Answer 2, 2}. (@bullet{})
5379 The @kbd{m s} command enables Symbolic mode, in which formulas
5380 like @samp{sqrt(5)} that can't be evaluated exactly are left in
5381 symbolic form rather than giving a floating-point approximate answer.
5382 Fraction mode (@kbd{m f}) is also useful when doing algebra.
5384 @smallexample
5385 @group
5386 2:  34 x - 24 x^3        2:  34 x - 24 x^3
5387 1:  34 x - 24 x^3        1:  [sqrt(51) / 6, sqrt(51) / -6, 0]
5388     .                        .
5390     r 2  @key{RET}     m s  m f    a P x @key{RET}
5391 @end group
5392 @end smallexample
5394 One more mode that makes reading formulas easier is Big mode.
5396 @smallexample
5397 @group
5398                3
5399 2:  34 x - 24 x
5401       ____   ____
5402      V 51   V 51
5403 1:  [-----, -----, 0]
5404        6     -6
5406     .
5408     d B
5409 @end group
5410 @end smallexample
5412 Here things like powers, square roots, and quotients and fractions
5413 are displayed in a two-dimensional pictorial form.  Calc has other
5414 language modes as well, such as C mode, FORTRAN mode, @TeX{} mode
5415 and La@TeX{} mode.
5417 @smallexample
5418 @group
5419 2:  34*x - 24*pow(x, 3)               2:  34*x - 24*x**3
5420 1:  @{sqrt(51) / 6, sqrt(51) / -6, 0@}  1:  /sqrt(51) / 6, sqrt(51) / -6, 0/
5421     .                                     .
5423     d C                                   d F
5425 @end group
5426 @end smallexample
5427 @noindent
5428 @smallexample
5429 @group
5430 3:  34 x - 24 x^3
5431 2:  [@{\sqrt@{51@} \over 6@}, @{\sqrt@{51@} \over -6@}, 0]
5432 1:  @{2 \over 3@} \sqrt@{5@}
5433     .
5435     d T   ' 2 \sqrt@{5@} \over 3 @key{RET}
5436 @end group
5437 @end smallexample
5439 @noindent
5440 As you can see, language modes affect both entry and display of
5441 formulas.  They affect such things as the names used for built-in
5442 functions, the set of arithmetic operators and their precedences,
5443 and notations for vectors and matrices.
5445 Notice that @samp{sqrt(51)} may cause problems with older
5446 implementations of C and FORTRAN, which would require something more
5447 like @samp{sqrt(51.0)}.  It is always wise to check over the formulas
5448 produced by the various language modes to make sure they are fully
5449 correct.
5451 Type @kbd{m s}, @kbd{m f}, and @kbd{d N} to reset these modes.  (You
5452 may prefer to remain in Big mode, but all the examples in the tutorial
5453 are shown in normal mode.)
5455 @cindex Area under a curve
5456 What is the area under the portion of this curve from @expr{x = 1} to @expr{2}?
5457 This is simply the integral of the function:
5459 @smallexample
5460 @group
5461 1:  17 x^2 - 6 x^4 + 3     1:  5.6666 x^3 - 1.2 x^5 + 3 x
5462     .                          .
5464     r 1                        a i x
5465 @end group
5466 @end smallexample
5468 @noindent
5469 We want to evaluate this at our two values for @expr{x} and subtract.
5470 One way to do it is again with vector mapping and reduction:
5472 @smallexample
5473 @group
5474 2:  [2, 1]            1:  [12.93333, 7.46666]    1:  5.46666
5475 1:  5.6666 x^3 ...        .                          .
5477    [ 2 , 1 ] @key{TAB}          V M $ @key{RET}                  V R -
5478 @end group
5479 @end smallexample
5481 (@bullet{}) @strong{Exercise 3.}  Find the integral from 1 to @expr{y}
5482 of 
5483 @texline @math{x \sin \pi x}
5484 @infoline @w{@expr{x sin(pi x)}} 
5485 (where the sine is calculated in radians).  Find the values of the
5486 integral for integers @expr{y} from 1 to 5.  @xref{Algebra Answer 3,
5487 3}. (@bullet{})
5489 Calc's integrator can do many simple integrals symbolically, but many
5490 others are beyond its capabilities.  Suppose we wish to find the area
5491 under the curve 
5492 @texline @math{\sin x \ln x}
5493 @infoline @expr{sin(x) ln(x)} 
5494 over 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
5496 long time but would be unable to find a solution.  In fact, there is no
5497 closed-form solution to this integral.  Now what do we do?
5499 @cindex Integration, numerical
5500 @cindex Numerical integration
5501 One approach would be to do the integral numerically.  It is not hard
5502 to do this by hand using vector mapping and reduction.  It is rather
5503 slow, though, since the sine and logarithm functions take a long time.
5504 We can save some time by reducing the working precision.
5506 @smallexample
5507 @group
5508 3:  10                  1:  [1, 1.1, 1.2,  ...  , 1.8, 1.9]
5509 2:  1                       .
5510 1:  0.1
5511     .
5513  10 @key{RET} 1 @key{RET} .1 @key{RET}        C-u v x
5514 @end group
5515 @end smallexample
5517 @noindent
5518 (Note that we have used the extended version of @kbd{v x}; we could
5519 also have used plain @kbd{v x} as follows:  @kbd{v x 10 @key{RET} 9 + .1 *}.)
5521 @smallexample
5522 @group
5523 2:  [1, 1.1, ... ]              1:  [0., 0.084941, 0.16993, ... ]
5524 1:  sin(x) ln(x)                    .
5525     .
5527     ' sin(x) ln(x) @key{RET}  s 1    m r  p 5 @key{RET}   V M $ @key{RET}
5529 @end group
5530 @end smallexample
5531 @noindent
5532 @smallexample
5533 @group
5534 1:  3.4195     0.34195
5535     .          .
5537     V R +      0.1 *
5538 @end group
5539 @end smallexample
5541 @noindent
5542 (If you got wildly different results, did you remember to switch
5543 to Radians mode?)
5545 Here we have divided the curve into ten segments of equal width;
5546 approximating these segments as rectangular boxes (i.e., assuming
5547 the curve is nearly flat at that resolution), we compute the areas
5548 of the boxes (height times width), then sum the areas.  (It is
5549 faster to sum first, then multiply by the width, since the width
5550 is the same for every box.)
5552 The true value of this integral turns out to be about 0.374, so
5553 we're not doing too well.  Let's try another approach.
5555 @smallexample
5556 @group
5557 1:  sin(x) ln(x)    1:  0.84147 x - 0.84147 + 0.11957 (x - 1)^2 - ...
5558     .                   .
5560     r 1                 a t x=1 @key{RET} 4 @key{RET}
5561 @end group
5562 @end smallexample
5564 @noindent
5565 Here we have computed the Taylor series expansion of the function
5566 about the point @expr{x=1}.  We can now integrate this polynomial
5567 approximation, since polynomials are easy to integrate.
5569 @smallexample
5570 @group
5571 1:  0.42074 x^2 + ...    1:  [-0.0446, -0.42073]      1:  0.3761
5572     .                        .                            .
5574     a i x @key{RET}            [ 2 , 1 ] @key{TAB}  V M $ @key{RET}         V R -
5575 @end group
5576 @end smallexample
5578 @noindent
5579 Better!  By increasing the precision and/or asking for more terms
5580 in the Taylor series, we can get a result as accurate as we like.
5581 (Taylor series converge better away from singularities in the
5582 function such as the one at @code{ln(0)}, so it would also help to
5583 expand the series about the points @expr{x=2} or @expr{x=1.5} instead
5584 of @expr{x=1}.)
5586 @cindex Simpson's rule
5587 @cindex Integration by Simpson's rule
5588 (@bullet{}) @strong{Exercise 4.}  Our first method approximated the
5589 curve by stairsteps of width 0.1; the total area was then the sum
5590 of the areas of the rectangles under these stairsteps.  Our second
5591 method approximated the function by a polynomial, which turned out
5592 to be a better approximation than stairsteps.  A third method is
5593 @dfn{Simpson's rule}, which is like the stairstep method except
5594 that the steps are not required to be flat.  Simpson's rule boils
5595 down to the formula,
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
5613 @noindent
5614 where @expr{n} (which must be even) is the number of slices and @expr{h}
5615 is the width of each slice.  These are 10 and 0.1 in our example.
5616 For reference, here is the corresponding formula for the stairstep
5617 method:
5619 @ifinfo
5620 @example
5621 h * (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
5633 Compute the integral from 1 to 2 of 
5634 @texline @math{\sin x \ln x}
5635 @infoline @expr{sin(x) ln(x)} 
5636 using Simpson's rule with 10 slices.  
5637 @xref{Algebra Answer 4, 4}. (@bullet{})
5639 Calc has a built-in @kbd{a I} command for doing numerical integration.
5640 It uses @dfn{Romberg's method}, which is a more sophisticated cousin
5641 of Simpson's rule.  In particular, it knows how to keep refining the
5642 result until the current precision is satisfied.
5644 @c [fix-ref Selecting Sub-Formulas]
5645 Aside from the commands we've seen so far, Calc also provides a
5646 large set of commands for operating on parts of formulas.  You
5647 indicate the desired sub-formula by placing the cursor on any part
5648 of the formula before giving a @dfn{selection} command.  Selections won't
5649 be covered in the tutorial; @pxref{Selecting Subformulas}, for
5650 details and examples.
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)).
5655 @node Rewrites Tutorial, , Basic Algebra Tutorial, Algebra Tutorial
5656 @subsection Rewrite Rules
5658 @noindent
5659 No matter how many built-in commands Calc provided for doing algebra,
5660 there would always be something you wanted to do that Calc didn't have
5661 in its repertoire.  So Calc also provides a @dfn{rewrite rule} system
5662 that you can use to define your own algebraic manipulations.
5664 Suppose we want to simplify this trigonometric formula:
5666 @smallexample
5667 @group
5668 1:  1 / cos(x) - sin(x) tan(x)
5669     .
5671     ' 1/cos(x) - sin(x) tan(x) @key{RET}   s 1
5672 @end group
5673 @end smallexample
5675 @noindent
5676 If 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
5678 denominator.  There is no Calc command to do the former; the @kbd{a n}
5679 algebra command will do the latter but we'll do both with rewrite
5680 rules just for practice.
5682 Rewrite rules are written with the @samp{:=} symbol.
5684 @smallexample
5685 @group
5686 1:  1 / cos(x) - sin(x)^2 / cos(x)
5687     .
5689     a r tan(a) := sin(a)/cos(a) @key{RET}
5690 @end group
5691 @end smallexample
5693 @noindent
5694 (The ``assignment operator'' @samp{:=} has several uses in Calc.  All
5695 by itself the formula @samp{tan(a) := sin(a)/cos(a)} doesn't do anything,
5696 but when it is given to the @kbd{a r} command, that command interprets
5697 it as a rewrite rule.)
5699 The lefthand side, @samp{tan(a)}, is called the @dfn{pattern} of the
5700 rewrite rule.  Calc searches the formula on the stack for parts that
5701 match the pattern.  Variables in a rewrite pattern are called
5702 @dfn{meta-variables}, and when matching the pattern each meta-variable
5703 can match any sub-formula.  Here, the meta-variable @samp{a} matched
5704 the actual variable @samp{x}.
5706 When the pattern part of a rewrite rule matches a part of the formula,
5707 that part is replaced by the righthand side with all the meta-variables
5708 substituted with the things they matched.  So the result is
5709 @samp{sin(x) / cos(x)}.  Calc's normal algebraic simplifications then
5710 mix this in with the rest of the original formula.
5712 To merge over a common denominator, we can use another simple rule:
5714 @smallexample
5715 @group
5716 1:  (1 - sin(x)^2) / cos(x)
5717     .
5719     a r a/x + b/x := (a+b)/x @key{RET}
5720 @end group
5721 @end smallexample
5723 This rule points out several interesting features of rewrite patterns.
5724 First, if a meta-variable appears several times in a pattern, it must
5725 match the same thing everywhere.  This rule detects common denominators
5726 because the same meta-variable @samp{x} is used in both of the
5727 denominators.
5729 Second, meta-variable names are independent from variables in the
5730 target formula.  Notice that the meta-variable @samp{x} here matches
5731 the subformula @samp{cos(x)}; Calc never confuses the two meanings of
5732 @samp{x}.
5734 And third, rewrite patterns know a little bit about the algebraic
5735 properties of formulas.  The pattern called for a sum of two quotients;
5736 Calc 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)}.
5739 @c [fix-ref Algebraic Properties of Rewrite Rules]
5740 We could just as easily have written @samp{a/x - b/x := (a-b)/x} for
5741 the rule.  It would have worked just the same in all cases.  (If we
5742 really wanted the rule to apply only to @samp{+} or only to @samp{-},
5743 we could have used the @code{plain} symbol.  @xref{Algebraic Properties
5744 of Rewrite Rules}, for some examples of this.)
5746 One 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
5748 the identity in a way that matches our formula.  The obvious rule
5749 would be @samp{@w{1 - sin(x)^2} := cos(x)^2}, but a little thought shows
5750 that the rule @samp{sin(x)^2 := 1 - cos(x)^2} will also work.  The
5751 latter rule has a more general pattern so it will work in many other
5752 situations, too.
5754 @smallexample
5755 @group
5756 1:  (1 + cos(x)^2 - 1) / cos(x)           1:  cos(x)
5757     .                                         .
5759     a r sin(x)^2 := 1 - cos(x)^2 @key{RET}          a s
5760 @end group
5761 @end smallexample
5763 You may ask, what's the point of using the most general rule if you
5764 have to type it in every time anyway?  The answer is that Calc allows
5765 you to store a rewrite rule in a variable, then give the variable
5766 name in the @kbd{a r} command.  In fact, this is the preferred way to
5767 use rewrites.  For one, if you need a rule once you'll most likely
5768 need it again later.  Also, if the rule doesn't work quite right you
5769 can simply Undo, edit the variable, and run the rule again without
5770 having to retype it.
5772 @smallexample
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}
5778 1:  1 / cos(x) - sin(x) tan(x)     1:  cos(x)
5779     .                                  .
5781     r 1                a r tsc @key{RET}  a r merge @key{RET}  a r sinsqr @key{RET}  a s
5782 @end group
5783 @end smallexample
5785 To edit a variable, type @kbd{s e} and the variable name, use regular
5786 Emacs editing commands as necessary, then type @kbd{C-c C-c} to store
5787 the edited value back into the variable. 
5788 You can also use @w{@kbd{s e}} to create a new variable if you wish.
5790 Notice that the first time you use each rule, Calc puts up a ``compiling''
5791 message briefly.  The pattern matcher converts rules into a special
5792 optimized pattern-matching language rather than using them directly.
5793 This allows @kbd{a r} to apply even rather complicated rules very
5794 efficiently.  If the rule is stored in a variable, Calc compiles it
5795 only once and stores the compiled form along with the variable.  That's
5796 another good reason to store your rules in variables rather than
5797 entering them on the fly.
5799 (@bullet{}) @strong{Exercise 1.}  Type @kbd{m s} to get Symbolic
5800 mode, then enter the formula @samp{@w{(2 + sqrt(2))} / @w{(1 + sqrt(2))}}.
5801 Using a rewrite rule, simplify this formula by multiplying the top and
5802 bottom by the conjugate @w{@samp{1 - sqrt(2)}}.  The result will have
5803 to be expanded by the distributive law; do this with another
5804 rewrite.  @xref{Rewrites Answer 1, 1}. (@bullet{})
5806 The @kbd{a r} command can also accept a vector of rewrite rules, or
5807 a variable containing a vector of rules.
5809 @smallexample
5810 @group
5811 1:  [tsc, merge, sinsqr]          1:  [tan(x) := sin(x) / cos(x), ... ]
5812     .                                 .
5814     ' [tsc,merge,sinsqr] @key{RET}          =
5816 @end group
5817 @end smallexample
5818 @noindent
5819 @smallexample
5820 @group
5821 1:  1 / cos(x) - sin(x) tan(x)    1:  cos(x)
5822     .                                 .
5824     s t trig @key{RET}  r 1                 a r trig @key{RET}  a s
5825 @end group
5826 @end smallexample
5828 @c [fix-ref Nested Formulas with Rewrite Rules]
5829 Calc tries all the rules you give against all parts of the formula,
5830 repeating until no further change is possible.  (The exact order in
5831 which things are tried is rather complex, but for simple rules like
5832 the ones we've used here the order doesn't really matter.
5833 @xref{Nested Formulas with Rewrite Rules}.)
5835 Calc actually repeats only up to 100 times, just in case your rule set
5836 has gotten into an infinite loop.  You can give a numeric prefix argument
5837 to @kbd{a r} to specify any limit.  In particular, @kbd{M-1 a r} does
5838 only one rewrite at a time.
5840 @smallexample
5841 @group
5842 1:  1 / cos(x) - sin(x)^2 / cos(x)    1:  (1 - sin(x)^2) / cos(x)
5843     .                                     .
5845     r 1  M-1 a r trig @key{RET}                 M-1 a r trig @key{RET}
5846 @end group
5847 @end smallexample
5849 You can type @kbd{M-0 a r} if you want no limit at all on the number
5850 of rewrites that occur.
5852 Rewrite rules can also be @dfn{conditional}.  Simply follow the rule
5853 with a @samp{::} symbol and the desired condition.  For example,
5855 @smallexample
5856 @group
5857 1:  exp(2 pi i) + exp(3 pi i) + exp(4 pi i)
5858     .
5860     ' exp(2 pi i) + exp(3 pi i) + exp(4 pi i) @key{RET}
5862 @end group
5863 @end smallexample
5864 @noindent
5865 @smallexample
5866 @group
5867 1:  1 + exp(3 pi i) + 1
5868     .
5870     a r exp(k pi i) := 1 :: k % 2 = 0 @key{RET}
5871 @end group
5872 @end smallexample
5874 @noindent
5875 (Recall, @samp{k % 2} is the remainder from dividing @samp{k} by 2,
5876 which will be zero only when @samp{k} is an even integer.)
5878 An interesting point is that the variables @samp{pi} and @samp{i}
5879 were matched literally rather than acting as meta-variables.
5880 This is because they are special-constant variables.  The special
5881 constants @samp{e}, @samp{phi}, and so on also match literally.
5882 A common error with rewrite
5883 rules is to write, say, @samp{f(a,b,c,d,e) := g(a+b+c+d+e)}, expecting
5884 to match any @samp{f} with five arguments but in fact matching
5885 only when the fifth argument is literally @samp{e}!
5887 @cindex Fibonacci numbers
5888 @ignore
5889 @starindex
5890 @end ignore
5891 @tindex fib
5892 Rewrite rules provide an interesting way to define your own functions.
5893 Suppose we want to define @samp{fib(n)} to produce the @var{n}th
5894 Fibonacci number.  The first two Fibonacci numbers are each 1;
5895 later numbers are formed by summing the two preceding numbers in
5896 the sequence.  This is easy to express in a set of three rules:
5898 @smallexample
5899 @group
5900 ' [fib(1) := 1, fib(2) := 1, fib(n) := fib(n-1) + fib(n-2)] @key{RET}  s t fib
5902 1:  fib(7)               1:  13
5903     .                        .
5905     ' fib(7) @key{RET}             a r fib @key{RET}
5906 @end group
5907 @end smallexample
5909 One thing that is guaranteed about the order that rewrites are tried
5910 is that, for any given subformula, earlier rules in the rule set will
5911 be tried for that subformula before later ones.  So even though the
5912 first and third rules both match @samp{fib(1)}, we know the first will
5913 be used preferentially.
5915 This rule set has one dangerous bug:  Suppose we apply it to the
5916 formula @samp{fib(x)}?  (Don't actually try this.)  The third rule
5917 will match @samp{fib(x)} and replace it with @w{@samp{fib(x-1) + fib(x-2)}}.
5918 Each of these will then be replaced to get @samp{fib(x-2) + 2 fib(x-3) +
5919 fib(x-4)}, and so on, expanding forever.  What we really want is to apply
5920 the third rule only when @samp{n} is an integer greater than two.  Type
5921 @w{@kbd{s e fib @key{RET}}}, then edit the third rule to:
5923 @smallexample
5924 fib(n) := fib(n-1) + fib(n-2) :: integer(n) :: n > 2
5925 @end smallexample
5927 @noindent
5928 Now:
5930 @smallexample
5931 @group
5932 1:  fib(6) + fib(x) + fib(0)      1:  8 + fib(x) + fib(0)
5933     .                                 .
5935     ' fib(6)+fib(x)+fib(0) @key{RET}        a r fib @key{RET}
5936 @end group
5937 @end smallexample
5939 @noindent
5940 We've created a new function, @code{fib}, and a new command,
5941 @w{@kbd{a r fib @key{RET}}}, which means ``evaluate all @code{fib} calls in
5942 this formula.''  To make things easier still, we can tell Calc to
5943 apply these rules automatically by storing them in the special
5944 variable @code{EvalRules}.
5946 @smallexample
5947 @group
5948 1:  [fib(1) := ...]    .                1:  [8, 13]
5949     .                                       .
5951     s r fib @key{RET}        s t EvalRules @key{RET}    ' [fib(6), fib(7)] @key{RET}
5952 @end group
5953 @end smallexample
5955 It turns out that this rule set has the problem that it does far
5956 more work than it needs to when @samp{n} is large.  Consider the
5957 first few steps of the computation of @samp{fib(6)}:
5959 @smallexample
5960 @group
5961 fib(6) =
5962 fib(5)              +               fib(4) =
5963 fib(4)     +      fib(3)     +      fib(3)     +      fib(2) =
5964 fib(3) + fib(2) + fib(2) + fib(1) + fib(2) + fib(1) + 1 = ...
5965 @end group
5966 @end smallexample
5968 @noindent
5969 Note that @samp{fib(3)} appears three times here.  Unless Calc's
5970 algebraic simplifier notices the multiple @samp{fib(3)}s and combines
5971 them (and, as it happens, it doesn't), this rule set does lots of
5972 needless recomputation.  To cure the problem, type @code{s e EvalRules}
5973 to edit the rules (or just @kbd{s E}, a shorthand command for editing
5974 @code{EvalRules}) and add another condition:
5976 @smallexample
5977 fib(n) := fib(n-1) + fib(n-2) :: integer(n) :: n > 2 :: remember
5978 @end smallexample
5980 @noindent
5981 If a @samp{:: remember} condition appears anywhere in a rule, then if
5982 that rule succeeds Calc will add another rule that describes that match
5983 to the front of the rule set.  (Remembering works in any rule set, but
5984 for technical reasons it is most effective in @code{EvalRules}.)  For
5985 example, if the rule rewrites @samp{fib(7)} to something that evaluates
5986 to 13, then the rule @samp{fib(7) := 13} will be added to the rule set.
5988 Type @kbd{' fib(8) @key{RET}} to compute the eighth Fibonacci number, then
5989 type @kbd{s E} again to see what has happened to the rule set.
5991 With 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
5993 up a table of all Fibonacci numbers up to @var{n}.  After we have
5994 computed 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.
5997 All Calc operations will run somewhat slower whenever @code{EvalRules}
5998 contains any rules.  You should type @kbd{s u EvalRules @key{RET}} now to
5999 un-store the variable.
6001 (@bullet{}) @strong{Exercise 2.}  Sometimes it is possible to reformulate
6002 a problem to reduce the amount of recursion necessary to solve it.
6003 Create a rule that, in about @var{n} simple steps and without recourse
6004 to 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
6007 rather clunky to use, so add a couple more rules to make the ``user
6008 interface'' the same as for our first version: enter @samp{fib(@var{n})},
6009 get back a plain number.  @xref{Rewrites Answer 2, 2}. (@bullet{})
6011 There are many more things that rewrites can do.  For example, there
6012 are @samp{&&&} and @samp{|||} pattern operators that create ``and''
6013 and ``or'' combinations of rules.  As one really simple example, we
6014 could combine our first two Fibonacci rules thusly:
6016 @example
6017 [fib(1 ||| 2) := 1, fib(n) := ... ]
6018 @end example
6020 @noindent
6021 That means ``@code{fib} of something matching either 1 or 2 rewrites
6022 to 1.''
6024 You can also make meta-variables optional by enclosing them in @code{opt}.
6025 For 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}
6027 matches all of these forms, filling in a default of zero for @samp{a}
6028 and one for @samp{b}.
6030 (@bullet{}) @strong{Exercise 3.}  Your friend Joe had @samp{2 + 3 x}
6031 on 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{})
6035 (@bullet{}) @strong{Exercise 4.}  Starting with a positive integer @expr{a},
6036 divide @expr{a} by two if it is even, otherwise compute @expr{3 a + 1}.
6037 Now repeat this step over and over.  A famous unproved conjecture
6038 is that for any starting @expr{a}, the sequence always eventually
6039 reaches 1.  Given the formula @samp{seq(@var{a}, 0)}, write a set of
6040 rules that convert this into @samp{seq(1, @var{n})} where @var{n}
6041 is the number of steps it took the sequence to reach the value 1.
6042 Now enhance the rules to accept @samp{seq(@var{a})} as a starting
6043 configuration, and to stop with just the number @var{n} by itself.
6044 Now make the result be a vector of values in the sequence, from @var{a}
6045 to 1.  (The formula @samp{@var{x}|@var{y}} appends the vectors @var{x}
6046 and @var{y}.)  For example, rewriting @samp{seq(6)} should yield the
6047 vector @expr{[6, 3, 10, 5, 16, 8, 4, 2, 1]}.
6048 @xref{Rewrites Answer 4, 4}. (@bullet{})
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
6053 is one or more non-sum terms separated by @samp{+} or @samp{-} signs,
6054 so that @expr{2 - 3 (x + y) + x y} is a sum of three terms.)
6055 @xref{Rewrites Answer 5, 5}. (@bullet{})
6057 (@bullet{}) @strong{Exercise 6.}  A Taylor series for a function is an
6058 infinite series that exactly equals the value of that function at
6059 values of @expr{x} near zero.
6061 @ifinfo
6062 @example
6063 cos(x) = 1 - x^2 / 2! + x^4 / 4! - x^6 / 6! + ...
6064 @end example
6065 @end ifinfo
6066 @tex
6067 \turnoffactive
6068 \beforedisplay
6069 $$ \cos x = 1 - {x^2 \over 2!} + {x^4 \over 4!} - {x^6 \over 6!} + \cdots $$
6070 \afterdisplay
6071 @end tex
6073 The @kbd{a t} command produces a @dfn{truncated Taylor series} which
6074 is obtained by dropping all the terms higher than, say, @expr{x^2}.
6075 Calc represents the truncated Taylor series as a polynomial in @expr{x}.
6076 Mathematicians often write a truncated series using a ``big-O'' notation
6077 that records what was the lowest term that was truncated.
6079 @ifinfo
6080 @example
6081 cos(x) = 1 - x^2 / 2! + O(x^3)
6082 @end example
6083 @end ifinfo
6084 @tex
6085 \turnoffactive
6086 \beforedisplay
6087 $$ \cos x = 1 - {x^2 \over 2!} + O(x^3) $$
6088 \afterdisplay
6089 @end tex
6091 @noindent
6092 The meaning of @expr{O(x^3)} is ``a quantity which is negligibly small
6093 if @expr{x^3} is considered negligibly small as @expr{x} goes to zero.''
6095 The exercise is to create rewrite rules that simplify sums and products of
6096 power series represented as @samp{@var{polynomial} + O(@var{var}^@var{n})}.
6097 For example, given @samp{1 - x^2 / 2 + O(x^3)} and @samp{x - x^3 / 6 + O(x^4)}
6098 on 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
6100 rearranged or if @kbd{a s} needs to be typed after rewriting.  (This one
6101 is rather tricky; the solution at the end of this chapter uses 6 rewrite
6102 rules.  Hint:  The @samp{constant(x)} condition tests whether @samp{x} is
6103 a number.)  @xref{Rewrites Answer 6, 6}. (@bullet{})
6105 Just for kicks, try adding the rule @code{2+3 := 6} to @code{EvalRules}.
6106 What happens?  (Be sure to remove this rule afterward, or you might get
6107 a nasty surprise when you use Calc to balance your checkbook!)
6109 @xref{Rewrite Rules}, for the whole story on rewrite rules.
6111 @node Programming Tutorial, Answers to Exercises, Algebra Tutorial, Tutorial
6112 @section Programming Tutorial
6114 @noindent
6115 The Calculator is written entirely in Emacs Lisp, a highly extensible
6116 language.  If you know Lisp, you can program the Calculator to do
6117 anything you like.  Rewrite rules also work as a powerful programming
6118 system.  But Lisp and rewrite rules take a while to master, and often
6119 all you want to do is define a new function or repeat a command a few
6120 times.  Calc has features that allow you to do these things easily.
6122 One very limited form of programming is defining your own functions.
6123 Calc's @kbd{Z F} command allows you to define a function name and
6124 key sequence to correspond to any formula.  Programming commands use
6125 the shift-@kbd{Z} prefix; the user commands they create use the lower
6126 case @kbd{z} prefix.
6128 @smallexample
6129 @group
6130 1:  1 + x + x^2 / 2 + x^3 / 6         1:  1 + x + x^2 / 2 + x^3 / 6
6131     .                                     .
6133     ' 1 + x + x^2/2! + x^3/3! @key{RET}         Z F e myexp @key{RET} @key{RET} @key{RET} y
6134 @end group
6135 @end smallexample
6137 This polynomial is a Taylor series approximation to @samp{exp(x)}.
6138 The @kbd{Z F} command asks a number of questions.  The above answers
6139 say 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
6141 function in algebraic formulas should also be @code{myexp}; the
6142 default argument list @samp{(x)} is acceptable; and finally @kbd{y}
6143 answers the question ``leave it in symbolic form for non-constant
6144 arguments?''
6146 @smallexample
6147 @group
6148 1:  1.3495     2:  1.3495     3:  1.3495
6149     .          1:  1.34986    2:  1.34986
6150                    .          1:  myexp(a + 1)
6151                                   .
6153     .3 z e         .3 E           ' a+1 @key{RET} z e
6154 @end group
6155 @end smallexample
6157 @noindent
6158 First we call our new @code{exp} approximation with 0.3 as an
6159 argument, and compare it with the true @code{exp} function.  Then
6160 we note that, as requested, if we try to give @kbd{z e} an
6161 argument that isn't a plain number, it leaves the @code{myexp}
6162 function call in symbolic form.  If we had answered @kbd{n} to the
6163 final question, @samp{myexp(a + 1)} would have evaluated by plugging
6164 in @samp{a + 1} for @samp{x} in the defining formula.
6166 @cindex Sine integral Si(x)
6167 @ignore
6168 @starindex
6169 @end ignore
6170 @tindex Si
6171 (@bullet{}) @strong{Exercise 1.}  The ``sine integral'' function
6172 @texline @math{{\rm Si}(x)}
6173 @infoline @expr{Si(x)} 
6174 is defined as the integral of @samp{sin(t)/t} for
6175 @expr{t = 0} to @expr{x} in radians.  (It was invented because this
6176 integral has no solution in terms of basic functions; if you give it
6177 to Calc's @kbd{a i} command, it will ponder it for a long time and then
6178 give up.)  We can use the numerical integration command, however,
6179 which in algebraic notation is written like @samp{ninteg(f(t), t, 0, x)}
6180 with 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
6182 default argument list a bit.  As a test, @samp{Si(1)} should return
6183 0.946083. (If you don't get this answer, you might want to check that
6184 Calc is in Radians mode.  Also, @code{ninteg} will run a lot faster if
6185 you reduce the precision to, say, six digits beforehand.)
6186 @xref{Programming Answer 1, 1}. (@bullet{})
6188 The simplest way to do real ``programming'' of Emacs is to define a
6189 @dfn{keyboard macro}.  A keyboard macro is simply a sequence of
6190 keystrokes which Emacs has stored away and can play back on demand.
6191 For example, if you find yourself typing @kbd{H a S x @key{RET}} often,
6192 you may wish to program a keyboard macro to type this for you.
6194 @smallexample
6195 @group
6196 1:  y = sqrt(x)          1:  x = y^2
6197     .                        .
6199     ' y=sqrt(x) @key{RET}       C-x ( H a S x @key{RET} C-x )
6201 1:  y = cos(x)           1:  x = s1 arccos(y) + 2 pi n1
6202     .                        .
6204     ' y=cos(x) @key{RET}           X
6205 @end group
6206 @end smallexample
6208 @noindent
6209 When you type @kbd{C-x (}, Emacs begins recording.  But it is also
6210 still ready to execute your keystrokes, so you're really ``training''
6211 Emacs 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
6213 re-execute the same keystrokes.
6215 You can give a name to your macro by typing @kbd{Z K}.
6217 @smallexample
6218 @group
6219 1:  .              1:  y = x^4         1:  x = s2 sqrt(s1 sqrt(y))
6220                        .                   .
6222   Z K x @key{RET}            ' y=x^4 @key{RET}         z x
6223 @end group
6224 @end smallexample
6226 @noindent
6227 Notice that we use shift-@kbd{Z} to define the command, and lower-case
6228 @kbd{z} to call it up.
6230 Keyboard macros can call other macros.
6232 @smallexample
6233 @group
6234 1:  abs(x)        1:  x = s1 y                1:  2 / x    1:  x = 2 / y
6235     .                 .                           .            .
6237  ' abs(x) @key{RET}   C-x ( ' y @key{RET} a = z x C-x )    ' 2/x @key{RET}       X
6238 @end group
6239 @end smallexample
6241 (@bullet{}) @strong{Exercise 2.}  Define a keyboard macro to negate
6242 the item in level 3 of the stack, without disturbing the rest of
6243 the stack.  @xref{Programming Answer 2, 2}. (@bullet{})
6245 (@bullet{}) @strong{Exercise 3.}  Define keyboard macros to compute
6246 the following functions:
6248 @enumerate
6249 @item
6250 Compute 
6251 @texline @math{\displaystyle{\sin x \over x}},
6252 @infoline @expr{sin(x) / x}, 
6253 where @expr{x} is the number on the top of the stack.
6255 @item
6256 Compute the base-@expr{b} logarithm, just like the @kbd{B} key except
6257 the arguments are taken in the opposite order.
6259 @item
6260 Produce a vector of integers from 1 to the integer on the top of
6261 the stack.
6262 @end enumerate
6263 @noindent
6264 @xref{Programming Answer 3, 3}. (@bullet{})
6266 (@bullet{}) @strong{Exercise 4.}  Define a keyboard macro to compute
6267 the average (mean) value of a list of numbers.
6268 @xref{Programming Answer 4, 4}. (@bullet{})
6270 In many programs, some of the steps must execute several times.
6271 Calc has @dfn{looping} commands that allow this.  Loops are useful
6272 inside keyboard macros, but actually work at any time.
6274 @smallexample
6275 @group
6276 1:  x^6          2:  x^6        1: 360 x^2
6277     .            1:  4             .
6278                      .
6280   ' x^6 @key{RET}          4         Z < a d x @key{RET} Z >
6281 @end group
6282 @end smallexample
6284 @noindent
6285 Here we have computed the fourth derivative of @expr{x^6} by
6286 enclosing a derivative command in a ``repeat loop'' structure.
6287 This structure pops a repeat count from the stack, then
6288 executes the body of the loop that many times.
6290 If you make a mistake while entering the body of the loop,
6291 type @w{@kbd{Z C-g}} to cancel the loop command.
6293 @cindex Fibonacci numbers
6294 Here's another example:
6296 @smallexample
6297 @group
6298 3:  1               2:  10946
6299 2:  1               1:  17711
6300 1:  20                  .
6301     .
6303 1 @key{RET} @key{RET} 20       Z < @key{TAB} C-j + Z >
6304 @end group
6305 @end smallexample
6307 @noindent
6308 The numbers in levels 2 and 1 should be the 21st and 22nd Fibonacci
6309 numbers, respectively.  (To see what's going on, try a few repetitions
6310 of the loop body by hand; @kbd{C-j}, also on the Line-Feed or @key{LFD}
6311 key if you have one, makes a copy of the number in level 2.)
6313 @cindex Golden ratio
6314 @cindex Phi, golden ratio
6315 A fascinating property of the Fibonacci numbers is that the @expr{n}th
6316 Fibonacci number can be found directly by computing 
6317 @texline @math{\phi^n / \sqrt{5}}
6318 @infoline @expr{phi^n / sqrt(5)}
6319 and then rounding to the nearest integer, where 
6320 @texline @math{\phi} (``phi''),
6321 @infoline @expr{phi}, 
6322 the ``golden ratio,'' is 
6323 @texline @math{(1 + \sqrt{5}) / 2}.
6324 @infoline @expr{(1 + sqrt(5)) / 2}. 
6325 (For convenience, this constant is available from the @code{phi}
6326 variable, or the @kbd{I H P} command.)
6328 @smallexample
6329 @group
6330 1:  1.61803         1:  24476.0000409    1:  10945.9999817    1:  10946
6331     .                   .                    .                    .
6333     I H P               21 ^                 5 Q /                R
6334 @end group
6335 @end smallexample
6337 @cindex Continued fractions
6338 (@bullet{}) @strong{Exercise 5.}  The @dfn{continued fraction}
6339 representation of 
6340 @texline @math{\phi}
6341 @infoline @expr{phi} 
6342 is 
6343 @texline @math{1 + 1/(1 + 1/(1 + 1/( \ldots )))}.
6344 @infoline @expr{1 + 1/(1 + 1/(1 + 1/( ...@: )))}.
6345 We can compute an approximate value by carrying this however far
6346 and then replacing the innermost 
6347 @texline @math{1/( \ldots )}
6348 @infoline @expr{1/( ...@: )} 
6349 by 1.  Approximate
6350 @texline @math{\phi}
6351 @infoline @expr{phi} 
6352 using a twenty-term continued fraction.
6353 @xref{Programming Answer 5, 5}. (@bullet{})
6355 (@bullet{}) @strong{Exercise 6.}  Linear recurrences like the one for
6356 Fibonacci numbers can be expressed in terms of matrices.  Given a
6357 vector @w{@expr{[a, b]}} determine a matrix which, when multiplied by this
6358 vector, produces the vector @expr{[b, c]}, where @expr{a}, @expr{b} and
6359 @expr{c} are three successive Fibonacci numbers.  Now write a program
6360 that, given an integer @expr{n}, computes the @expr{n}th Fibonacci number
6361 using matrix arithmetic.  @xref{Programming Answer 6, 6}. (@bullet{})
6363 @cindex Harmonic numbers
6364 A more sophisticated kind of loop is the @dfn{for} loop.  Suppose
6365 we wish to compute the 20th ``harmonic'' number, which is equal to
6366 the sum of the reciprocals of the integers from 1 to 20.
6368 @smallexample
6369 @group
6370 3:  0               1:  3.597739
6371 2:  1                   .
6372 1:  20
6373     .
6375 0 @key{RET} 1 @key{RET} 20         Z ( & + 1 Z )
6376 @end group
6377 @end smallexample
6379 @noindent
6380 The ``for'' loop pops two numbers, the lower and upper limits, then
6381 repeats the body of the loop as an internal counter increases from
6382 the lower limit to the upper one.  Just before executing the loop
6383 body, it pushes the current loop counter.  When the loop body
6384 finishes, it pops the ``step,'' i.e., the amount by which to
6385 increment the loop counter.  As you can see, our loop always
6386 uses a step of one.
6388 This harmonic number function uses the stack to hold the running
6389 total as well as for the various loop housekeeping functions.  If
6390 you find this disorienting, you can sum in a variable instead:
6392 @smallexample
6393 @group
6394 1:  0         2:  1                  .            1:  3.597739
6395     .         1:  20                                  .
6396                   .
6398     0 t 7       1 @key{RET} 20      Z ( & s + 7 1 Z )       r 7
6399 @end group
6400 @end smallexample
6402 @noindent
6403 The @kbd{s +} command adds the top-of-stack into the value in a
6404 variable (and removes that value from the stack).
6406 It's worth noting that many jobs that call for a ``for'' loop can
6407 also be done more easily by Calc's high-level operations.  Two
6408 other ways to compute harmonic numbers are to use vector mapping
6409 and reduction (@kbd{v x 20}, then @w{@kbd{V M &}}, then @kbd{V R +}),
6410 or to use the summation command @kbd{a +}.  Both of these are
6411 probably easier than using loops.  However, there are some
6412 situations where loops really are the way to go:
6414 (@bullet{}) @strong{Exercise 7.}  Use a ``for'' loop to find the first
6415 harmonic number which is greater than 4.0.
6416 @xref{Programming Answer 7, 7}. (@bullet{})
6418 Of course, if we're going to be using variables in our programs,
6419 we have to worry about the programs clobbering values that the
6420 caller was keeping in those same variables.  This is easy to
6421 fix, though:
6423 @smallexample
6424 @group
6425     .        1:  0.6667       1:  0.6667     3:  0.6667
6426                  .                .          2:  3.597739
6427                                              1:  0.6667
6428                                                  .
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}
6431 @end group
6432 @end smallexample
6434 @noindent
6435 When we type @kbd{Z `} (that's a back-quote character), Calc saves
6436 its mode settings and the contents of the ten ``quick variables''
6437 for later reference.  When we type @kbd{Z '} (that's an apostrophe
6438 now), Calc restores those saved values.  Thus the @kbd{p 4} and
6439 @kbd{s 7} commands have no effect outside this sequence.  Wrapping
6440 this around the body of a keyboard macro ensures that it doesn't
6441 interfere with what the user of the macro was doing.  Notice that
6442 the contents of the stack, and the values of named variables,
6443 survive past the @kbd{Z '} command.
6445 @cindex Bernoulli numbers, approximate
6446 The @dfn{Bernoulli numbers} are a sequence with the interesting
6447 property that all of the odd Bernoulli numbers are zero, and the
6448 even ones, while difficult to compute, can be roughly approximated
6449 by the formula 
6450 @texline @math{\displaystyle{2 n! \over (2 \pi)^n}}.
6451 @infoline @expr{2 n!@: / (2 pi)^n}.  
6452 Let's write a keyboard macro to compute (approximate) Bernoulli numbers.
6453 (Calc has a command, @kbd{k b}, to compute exact Bernoulli numbers, but
6454 this command is very slow for large @expr{n} since the higher Bernoulli
6455 numbers are very large fractions.)
6457 @smallexample
6458 @group
6459 1:  10               1:  0.0756823
6460     .                    .
6462     10     C-x ( @key{RET} 2 % Z [ @key{DEL} 0 Z : ' 2 $! / (2 pi)^$ @key{RET} = Z ] C-x )
6463 @end group
6464 @end smallexample
6466 @noindent
6467 You 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''
6469 command.  For the purposes of @w{@kbd{Z [}}, the condition is ``true''
6470 if the value it pops from the stack is a nonzero number, or ``false''
6471 if it pops zero or something that is not a number (like a formula).
6472 Here we take our integer argument modulo 2; this will be nonzero
6473 if we're asking for an odd Bernoulli number.
6475 The actual tenth Bernoulli number is @expr{5/66}.
6477 @smallexample
6478 @group
6479 3:  0.0756823    1:  0          1:  0.25305    1:  0          1:  1.16659
6480 2:  5:66             .              .              .              .
6481 1:  0.0757575
6482     .
6484 10 k b @key{RET} c f   M-0 @key{DEL} 11 X   @key{DEL} 12 X       @key{DEL} 13 X       @key{DEL} 14 X
6485 @end group
6486 @end smallexample
6488 Just to exercise loops a bit more, let's compute a table of even
6489 Bernoulli numbers.
6491 @smallexample
6492 @group
6493 3:  []             1:  [0.10132, 0.03079, 0.02340, 0.033197, ...]
6494 2:  2                  .
6495 1:  30
6496     .
6498  [ ] 2 @key{RET} 30          Z ( X | 2 Z )
6499 @end group
6500 @end smallexample
6502 @noindent
6503 The vertical-bar @kbd{|} is the vector-concatenation command.  When
6504 we 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
6506 will be in level 1.  The effect is to append the Bernoulli number
6507 onto the end of the list.  (To create a table of exact fractional
6508 Bernoulli numbers, just replace @kbd{X} with @kbd{k b} in the above
6509 sequence of keystrokes.)
6511 With loops and conditionals, you can program essentially anything
6512 in Calc.  One other command that makes looping easier is @kbd{Z /},
6513 which takes a condition from the stack and breaks out of the enclosing
6514 loop if the condition is true (non-zero).  You can use this to make
6515 ``while'' and ``until'' style loops.
6517 If you make a mistake when entering a keyboard macro, you can edit
6518 it using @kbd{Z E}.  First, you must attach it to a key with @kbd{Z K}.
6519 One technique is to enter a throwaway dummy definition for the macro,
6520 then enter the real one in the edit command.
6522 @smallexample
6523 @group
6524 1:  3                   1:  3           Calc Macro Edit Mode.
6525     .                       .           Original keys: 1 <return> 2 +
6527                                         1                          ;; calc digits
6528                                         RET                        ;; calc-enter
6529                                         2                          ;; calc digits
6530                                         +                          ;; calc-plus
6532 C-x ( 1 @key{RET} 2 + C-x )    Z K h @key{RET}      Z E h
6533 @end group
6534 @end smallexample
6536 @noindent
6537 A keyboard macro is stored as a pure keystroke sequence.  The
6538 @file{edmacro} package (invoked by @kbd{Z E}) scans along the
6539 macro and tries to decode it back into human-readable steps.
6540 Descriptions of the keystrokes are given as comments, which begin with
6541 @samp{;;}, and which are ignored when the edited macro is saved.
6542 Spaces and line breaks are also ignored when the edited macro is saved.
6543 To enter a space into the macro, type @code{SPC}.  All the special
6544 characters @code{RET}, @code{LFD}, @code{TAB}, @code{SPC}, @code{DEL},
6545 and @code{NUL} must be written in all uppercase, as must the prefixes
6546 @code{C-} and @code{M-}.
6548 Let's edit in a new definition, for computing harmonic numbers.
6549 First, erase the four lines of the old definition.  Then, type
6550 in the new definition (or use Emacs @kbd{M-w} and @kbd{C-y} commands
6551 to copy it from this page of the Info file; you can of course skip
6552 typing the comments, which begin with @samp{;;}).
6554 @smallexample
6555 Z`                      ;; calc-kbd-push     (Save local values)
6556 0                       ;; calc digits       (Push a zero onto the stack)
6557 st                      ;; calc-store-into   (Store it in the following variable)
6558 1                       ;; calc quick variable  (Quick variable q1)
6559 1                       ;; calc digits       (Initial value for the loop) 
6560 TAB                     ;; calc-roll-down    (Swap initial and final)
6561 Z(                      ;; calc-kbd-for      (Begin the "for" loop)
6562 &                       ;; calc-inv          (Take the reciprocal)
6563 s+                      ;; calc-store-plus   (Add to the following variable)
6564 1                       ;; calc quick variable  (Quick variable q1)
6565 1                       ;; calc digits       (The loop step is 1)
6566 Z)                      ;; calc-kbd-end-for  (End the "for" loop)
6567 sr                      ;; calc-recall       (Recall the final accumulated value)
6568 1                       ;; calc quick variable (Quick variable q1)
6569 Z'                      ;; calc-kbd-pop      (Restore values)
6570 @end smallexample
6572 @noindent
6573 Press @kbd{C-c C-c} to finish editing and return to the Calculator.
6575 @smallexample
6576 @group
6577 1:  20         1:  3.597739
6578     .              .
6580     20             z h
6581 @end group
6582 @end smallexample
6584 The @file{edmacro} package defines a handy @code{read-kbd-macro} command
6585 which reads the current region of the current buffer as a sequence of
6586 keystroke names, and defines that sequence on the @kbd{X} 
6587 (and @kbd{C-x e}) key.  Because this is so useful, Calc puts this
6588 command on the @kbd{M-# m} key.  Try reading in this macro in the
6589 following form:  Press @kbd{C-@@} (or @kbd{C-@key{SPC}}) at 
6590 one end of the text below, then type @kbd{M-# m} at the other.
6592 @example
6593 @group
6594 Z ` 0 t 1
6595     1 TAB
6596     Z (  & s + 1  1 Z )
6597     r 1
6598 Z '
6599 @end group
6600 @end example
6602 (@bullet{}) @strong{Exercise 8.}  A general algorithm for solving
6603 equations numerically is @dfn{Newton's Method}.  Given the equation
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
6606 this formula over and over:
6608 @ifinfo
6609 @example
6610 new_x = x - f(x)/f'(x)
6611 @end example
6612 @end ifinfo
6613 @tex
6614 \beforedisplay
6615 $$ x_{\rm new} = x - {f(x) \over f'(x)} $$
6616 \afterdisplay
6617 @end tex
6619 @noindent
6620 where @expr{f'(x)} is the derivative of @expr{f}.  The @expr{x}
6621 values will quickly converge to a solution, i.e., eventually
6622 @texline @math{x_{\rm new}}
6623 @infoline @expr{new_x} 
6624 and @expr{x} will be equal to within the limits
6625 of the current precision.  Write a program which takes a formula
6626 involving the variable @expr{x}, and an initial guess @expr{x_0},
6627 on the stack, and produces a value of @expr{x} for which the formula
6628 is zero.  Use it to find a solution of 
6629 @texline @math{\sin(\cos x) = 0.5}
6630 @infoline @expr{sin(cos(x)) = 0.5}
6631 near @expr{x = 4.5}.  (Use angles measured in radians.)  Note that
6632 the built-in @w{@kbd{a R}} (@code{calc-find-root}) command uses Newton's
6633 method when it is able.  @xref{Programming Answer 8, 8}. (@bullet{})
6635 @cindex Digamma function
6636 @cindex Gamma constant, Euler's
6637 @cindex Euler's gamma constant
6638 (@bullet{}) @strong{Exercise 9.}  The @dfn{digamma} function 
6639 @texline @math{\psi(z) (``psi'')}
6640 @infoline @expr{psi(z)}
6641 is defined as the derivative of 
6642 @texline @math{\ln \Gamma(z)}.
6643 @infoline @expr{ln(gamma(z))}.  
6644 For large values of @expr{z}, it can be approximated by the infinite sum
6646 @ifinfo
6647 @example
6648 psi(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
6652 \beforedisplay
6653 $$ \psi(z) \approx \ln z - {1\over2z} -
6654    \sum_{n=1}^\infty {\code{bern}(2 n) \over 2 n z^{2n}}
6656 \afterdisplay
6657 @end tex
6659 @noindent
6660 where 
6661 @texline @math{\sum}
6662 @infoline @expr{sum} 
6663 represents the sum over @expr{n} from 1 to infinity
6664 (or to some limit high enough to give the desired accuracy), and
6665 the @code{bern} function produces (exact) Bernoulli numbers.
6666 While this sum is not guaranteed to converge, in practice it is safe.
6667 An interesting mathematical constant is Euler's gamma, which is equal
6668 to about 0.5772.  One way to compute it is by the formula,
6669 @texline @math{\gamma = -\psi(1)}.
6670 @infoline @expr{gamma = -psi(1)}.  
6671 Unfortunately, 1 isn't a large enough argument
6672 for the above formula to work (5 is a much safer value for @expr{z}).
6673 Fortunately, we can compute 
6674 @texline @math{\psi(1)}
6675 @infoline @expr{psi(1)} 
6676 from 
6677 @texline @math{\psi(5)}
6678 @infoline @expr{psi(5)} 
6679 using the recurrence 
6680 @texline @math{\psi(z+1) = \psi(z) + {1 \over z}}.
6681 @infoline @expr{psi(z+1) = psi(z) + 1/z}.  
6682 Your task:  Develop a program to compute 
6683 @texline @math{\psi(z)};
6684 @infoline @expr{psi(z)}; 
6685 it should ``pump up'' @expr{z}
6686 if necessary to be greater than 5, then use the above summation
6687 formula.  Use looping commands to compute the sum.  Use your function
6688 to compute 
6689 @texline @math{\gamma}
6690 @infoline @expr{gamma} 
6691 to twelve decimal places.  (Calc has a built-in command
6692 for Euler's constant, @kbd{I P}, which you can use to check your answer.)
6693 @xref{Programming Answer 9, 9}. (@bullet{})
6695 @cindex Polynomial, list of coefficients
6696 (@bullet{}) @strong{Exercise 10.}  Given a polynomial in @expr{x} and
6697 a 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}),
6699 write a program to convert the polynomial into a list-of-coefficients
6700 notation.  For example, @expr{5 x^4 + (x + 1)^2} with @expr{m = 6}
6701 should produce the list @expr{[1, 2, 1, 0, 5, 0, 0]}.  Also develop
6702 a way to convert from this form back to the standard algebraic form.
6703 @xref{Programming Answer 10, 10}. (@bullet{})
6705 @cindex Recursion
6706 (@bullet{}) @strong{Exercise 11.}  The @dfn{Stirling numbers of the
6707 first kind} are defined by the recurrences,
6709 @ifinfo
6710 @example
6711 s(n,n) = 1   for n >= 0,
6712 s(n,0) = 0   for n > 0,
6713 s(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.}
6724 \afterdisplay
6725 \vskip5pt
6726 (These numbers are also sometimes written $\displaystyle{n \brack m}$.)
6727 @end tex
6729 This can be implemented using a @dfn{recursive} program in Calc; the
6730 program must invoke itself in order to calculate the two righthand
6731 terms in the general formula.  Since it always invokes itself with
6732 ``simpler'' arguments, it's easy to see that it must eventually finish
6733 the computation.  Recursion is a little difficult with Emacs keyboard
6734 macros since the macro is executed before its definition is complete.
6735 So here's the recommended strategy:  Create a ``dummy macro'' and assign
6736 it to a key with, e.g., @kbd{Z K s}.  Now enter the true definition,
6737 using the @kbd{z s} command to call itself recursively, then assign it
6738 to the same key with @kbd{Z K s}.  Now the @kbd{z s} command will run
6739 the complete recursive program.  (Another way is to use @w{@kbd{Z E}}
6740 or @kbd{M-# m} (@code{read-kbd-macro}) to read the whole macro at once,
6741 thus avoiding the ``training'' phase.)  The task:  Write a program
6742 that 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,
6745 @kbd{k s}, which you can use to check your answers.)
6746 @xref{Programming Answer 11, 11}. (@bullet{})
6748 The programming commands we've seen in this part of the tutorial
6749 are low-level, general-purpose operations.  Often you will find
6750 that a higher-level function, such as vector mapping or rewrite
6751 rules, will do the job much more easily than a detailed, step-by-step
6752 program can:
6754 (@bullet{}) @strong{Exercise 12.}  Write another program for
6755 computing Stirling numbers of the first kind, this time using
6756 rewrite rules.  Once again, @expr{n} and @expr{m} should be taken
6757 from the stack.  @xref{Programming Answer 12, 12}. (@bullet{})
6759 @example
6761 @end example
6762 This ends the tutorial section of the Calc manual.  Now you know enough
6763 about Calc to use it effectively for many kinds of calculations.  But
6764 Calc has many features that were not even touched upon in this tutorial.
6765 @c [not-split]
6766 The 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.
6770 @page
6771 @node Answers to Exercises, , Programming Tutorial, Tutorial
6772 @section Answers to Exercises
6774 @noindent
6775 This section includes answers to all the exercises in the Calc tutorial.
6777 @menu
6778 * RPN Answer 1::           1 @key{RET} 2 @key{RET} 3 @key{RET} 4 + * -
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
6834 * Rewrites Answer 6::      Truncated Taylor series
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
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
6858 @node RPN Answer 1, RPN Answer 2, Answers to Exercises, Answers to Exercises
6859 @subsection RPN Tutorial Exercise 1
6861 @noindent
6862 @kbd{1 @key{RET} 2 @key{RET} 3 @key{RET} 4 + * -}
6864 The result is 
6865 @texline @math{1 - (2 \times (3 + 4)) = -13}.
6866 @infoline @expr{1 - (2 * (3 + 4)) = -13}.
6868 @node RPN Answer 2, RPN Answer 3, RPN Answer 1, Answers to Exercises
6869 @subsection RPN Tutorial Exercise 2
6871 @noindent
6872 @texline @math{2\times4 + 7\times9.5 + {5\over4} = 75.75}
6873 @infoline @expr{2*4 + 7*9.5 + 5/4 = 75.75}
6875 After computing the intermediate term 
6876 @texline @math{2\times4 = 8},
6877 @infoline @expr{2*4 = 8}, 
6878 you can leave that result on the stack while you compute the second
6879 term.  With both of these results waiting on the stack you can then
6880 compute the final term, then press @kbd{+ +} to add everything up.
6882 @smallexample
6883 @group
6884 2:  2          1:  8          3:  8          2:  8
6885 1:  4              .          2:  7          1:  66.5
6886     .                         1:  9.5            .
6887                                   .
6889   2 @key{RET} 4          *          7 @key{RET} 9.5          *
6891 @end group
6892 @end smallexample
6893 @noindent
6894 @smallexample
6895 @group
6896 4:  8          3:  8          2:  8          1:  75.75
6897 3:  66.5       2:  66.5       1:  67.75          .
6898 2:  5          1:  1.25           .
6899 1:  4              .
6900     .
6902   5 @key{RET} 4          /              +              +
6903 @end group
6904 @end smallexample
6906 Alternatively, you could add the first two terms before going on
6907 with the third term.
6909 @smallexample
6910 @group
6911 2:  8          1:  74.5       3:  74.5       2:  74.5       1:  75.75
6912 1:  66.5           .          2:  5          1:  1.25           .
6913     .                         1:  4              .
6914                                   .
6916    ...             +            5 @key{RET} 4          /              +
6917 @end group
6918 @end smallexample
6920 On an old-style RPN calculator this second method would have the
6921 advantage of using only three stack levels.  But since Calc's stack
6922 can grow arbitrarily large this isn't really an issue.  Which method
6923 you choose is purely a matter of taste.
6925 @node RPN Answer 3, RPN Answer 4, RPN Answer 2, Answers to Exercises
6926 @subsection RPN Tutorial Exercise 3
6928 @noindent
6929 The @key{TAB} key provides a way to operate on the number in level 2.
6931 @smallexample
6932 @group
6933 3:  10         3:  10         4:  10         3:  10         3:  10
6934 2:  20         2:  30         3:  30         2:  30         2:  21
6935 1:  30         1:  20         2:  20         1:  21         1:  30
6936     .              .          1:  1              .              .
6937                                   .
6939                   @key{TAB}             1              +             @key{TAB}
6940 @end group
6941 @end smallexample
6943 Similarly, @kbd{M-@key{TAB}} gives you access to the number in level 3.
6945 @smallexample
6946 @group
6947 3:  10         3:  21         3:  21         3:  30         3:  11
6948 2:  21         2:  30         2:  30         2:  11         2:  21
6949 1:  30         1:  10         1:  11         1:  21         1:  30
6950     .              .              .              .              .
6952                   M-@key{TAB}           1 +           M-@key{TAB}          M-@key{TAB}
6953 @end group
6954 @end smallexample
6956 @node RPN Answer 4, Algebraic Answer 1, RPN Answer 3, Answers to Exercises
6957 @subsection RPN Tutorial Exercise 4
6959 @noindent
6960 Either @kbd{( 2 , 3 )} or @kbd{( 2 @key{SPC} 3 )} would have worked,
6961 but using both the comma and the space at once yields:
6963 @smallexample
6964 @group
6965 1:  ( ...      2:  ( ...      1:  (2, ...    2:  (2, ...    2:  (2, ...
6966     .          1:  2              .          1:  (2, ...    1:  (2, 3)
6967                    .                             .              .
6969     (              2              ,             @key{SPC}            3 )
6970 @end group
6971 @end smallexample
6973 Joe probably tried to type @kbd{@key{TAB} @key{DEL}} to swap the
6974 extra incomplete object to the top of the stack and delete it.
6975 But a feature of Calc is that @key{DEL} on an incomplete object
6976 deletes just one component out of that object, so he had to press
6977 @key{DEL} twice to finish the job.
6979 @smallexample
6980 @group
6981 2:  (2, ...    2:  (2, 3)     2:  (2, 3)     1:  (2, 3)
6982 1:  (2, 3)     1:  (2, ...    1:  ( ...          .
6983     .              .              .
6985                   @key{TAB}            @key{DEL}            @key{DEL}
6986 @end group
6987 @end smallexample
6989 (As it turns out, deleting the second-to-top stack entry happens often
6990 enough 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
6992 the ``feature'' that tripped poor Joe.)
6994 @node Algebraic Answer 1, Algebraic Answer 2, RPN Answer 4, Answers to Exercises
6995 @subsection Algebraic Entry Tutorial Exercise 1
6997 @noindent
6998 Type @kbd{' sqrt($) @key{RET}}.
7000 If the @kbd{Q} key is broken, you could use @kbd{' $^0.5 @key{RET}}.
7001 Or, RPN style, @kbd{0.5 ^}.
7003 (Actually, @samp{$^1:2}, using the fraction one-half as the power, is
7004 a 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}.)
7007 @node Algebraic Answer 2, Algebraic Answer 3, Algebraic Answer 1, Answers to Exercises
7008 @subsection Algebraic Entry Tutorial Exercise 2
7010 @noindent
7011 In the formula @samp{2 x (1+y)}, @samp{x} was interpreted as a function
7012 name with @samp{1+y} as its argument.  Assigning a value to a variable
7013 has no relation to a function by the same name.  Joe needed to use an
7014 explicit @samp{*} symbol here:  @samp{2 x*(1+y)}.
7016 @node Algebraic Answer 3, Modes Answer 1, Algebraic Answer 2, Answers to Exercises
7017 @subsection Algebraic Entry Tutorial Exercise 3
7019 @noindent
7020 The result from @kbd{1 @key{RET} 0 /} will be the formula @expr{1 / 0}.
7021 The ``function'' @samp{/} cannot be evaluated when its second argument
7022 is zero, so it is left in symbolic form.  When you now type @kbd{0 *},
7023 the result will be zero because Calc uses the general rule that ``zero
7024 times anything is zero.''
7026 @c [fix-ref Infinities]
7027 The @kbd{m i} command enables an @dfn{Infinite mode} in which @expr{1 / 0}
7028 results in a special symbol that represents ``infinity.''  If you
7029 multiply infinity by zero, Calc uses another special new symbol to
7030 show that the answer is ``indeterminate.''  @xref{Infinities}, for
7031 further discussion of infinite and indeterminate values.
7033 @node Modes Answer 1, Modes Answer 2, Algebraic Answer 3, Answers to Exercises
7034 @subsection Modes Tutorial Exercise 1
7036 @noindent
7037 Calc always stores its numbers in decimal, so even though one-third has
7038 an exact base-3 representation (@samp{3#0.1}), it is still stored as
7039 0.3333333 (chopped off after 12 or however many decimal digits) inside
7040 the calculator's memory.  When this inexact number is converted back
7041 to base 3 for display, it may still be slightly inexact.  When we
7042 multiply this number by 3, we get 0.999999, also an inexact value.
7044 When Calc displays a number in base 3, it has to decide how many digits
7045 to show.  If the current precision is 12 (decimal) digits, that corresponds
7046 to @samp{12 / log10(3) = 25.15} base-3 digits.  Because 25.15 is not an
7047 exact integer, Calc shows only 25 digits, with the result that stored
7048 numbers carry a little bit of extra information that may not show up on
7049 the screen.  When Joe entered @samp{3#0.2}, the stored number 0.666666
7050 happened to round to a pleasing value when it lost that last 0.15 of a
7051 digit, but it was still inexact in Calc's memory.  When he divided by 2,
7052 he still got the dreaded inexact value 0.333333.  (Actually, he divided
7053 0.666667 by 2 to get 0.333334, which is why he got something a little
7054 higher than @code{3#0.1} instead of a little lower.)
7056 If 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
7058 you give @kbd{d n} a negative argument, it uses default-minus-that,
7059 so @kbd{M-- d n} would be an easier way to get the same effect.)  Those
7060 inexact results would still be lurking there, but they would now be
7061 rounded 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
7063 off one digit will round the number up to @samp{0.1}.)  Depending on the
7064 nature of your work, this hiding of the inexactness may be a benefit or
7065 a danger.  With the @kbd{d n} command, Calc gives you the choice.
7067 Incidentally, another consequence of all this is that if you type
7068 @kbd{M-30 d n} to display more digits than are ``really there,''
7069 you'll see garbage digits at the end of the number.  (In decimal
7070 display mode, with decimally-stored numbers, these garbage digits are
7071 always zero so they vanish and you don't notice them.)  Because Calc
7072 rounds off that 0.15 digit, there is the danger that two numbers could
7073 be slightly different internally but still look the same.  If you feel
7074 uneasy about this, set the @kbd{d n} precision to be a little higher
7075 than normal; you'll get ugly garbage digits, but you'll always be able
7076 to tell two distinct numbers apart.
7078 An interesting side note is that most computers store their
7079 floating-point numbers in binary, and convert to decimal for display.
7080 Thus everyday programs have the same problem:  Decimal 0.1 cannot be
7081 represented exactly in binary (try it: @kbd{0.1 d 2}), so @samp{0.1 * 10}
7082 comes out as an inexact approximation to 1 on some machines (though
7083 they generally arrange to hide it from you by rounding off one digit as
7084 we did above).  Because Calc works in decimal instead of binary, you can
7085 be sure that numbers that look exact @emph{are} exact as long as you stay
7086 in decimal display mode.
7088 It's not hard to show that any number that can be represented exactly
7089 in binary, octal, or hexadecimal is also exact in decimal, so the kinds
7090 of problems we saw in this exercise are likely to be severe only when
7091 you use a relatively unusual radix like 3.
7093 @node Modes Answer 2, Modes Answer 3, Modes Answer 1, Answers to Exercises
7094 @subsection Modes Tutorial Exercise 2
7096 If the radix is 15 or higher, we can't use the letter @samp{e} to mark
7097 the exponent because @samp{e} is interpreted as a digit.  When Calc
7098 needs 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
7100 algebraic entry.  Also, pressing @kbd{e} without any digits before it
7101 normally types @kbd{1e}, but in a high radix it types @kbd{16.^} and
7102 puts you in algebraic entry:  @kbd{16#f.e8f @key{RET} e 15 @key{RET} *} is another
7103 way to enter this number.
7105 The reason Calc puts a decimal point in the @samp{16.^} is to prevent
7106 huge 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
7108 exact integer and then throw away most of the digits when we multiply
7109 it by the floating-point @samp{16#1.23}).  While this wouldn't normally
7110 matter for display purposes, it could give you a nasty surprise if you
7111 copied that number into a file and later moved it back into Calc.
7113 @node Modes Answer 3, Modes Answer 4, Modes Answer 2, Answers to Exercises
7114 @subsection Modes Tutorial Exercise 3
7116 @noindent
7117 The answer he got was @expr{0.5000000000006399}.
7119 The problem is not that the square operation is inexact, but that the
7120 sine of 45 that was already on the stack was accurate to only 12 places.
7121 Arbitrary-precision calculations still only give answers as good as
7122 their inputs.
7124 The real problem is that there is no 12-digit number which, when
7125 squared, comes out to 0.5 exactly.  The @kbd{f [} and @kbd{f ]}
7126 commands decrease or increase a number by one unit in the last
7127 place (according to the current precision).  They are useful for
7128 determining facts like this.
7130 @smallexample
7131 @group
7132 1:  0.707106781187      1:  0.500000000001
7133     .                       .
7135     45 S                    2 ^
7137 @end group
7138 @end smallexample
7139 @noindent
7140 @smallexample
7141 @group
7142 1:  0.707106781187      1:  0.707106781186      1:  0.499999999999
7143     .                       .                       .
7145     U  @key{DEL}                  f [                     2 ^
7146 @end group
7147 @end smallexample
7149 A high-precision calculation must be carried out in high precision
7150 all the way.  The only number in the original problem which was known
7151 exactly was the quantity 45 degrees, so the precision must be raised
7152 before anything is done after the number 45 has been entered in order
7153 for the higher precision to be meaningful.
7155 @node Modes Answer 4, Arithmetic Answer 1, Modes Answer 3, Answers to Exercises
7156 @subsection Modes Tutorial Exercise 4
7158 @noindent
7159 Many calculations involve real-world quantities, like the width and
7160 height of a piece of wood or the volume of a jar.  Such quantities
7161 can't be measured exactly anyway, and if the data that is input to
7162 a calculation is inexact, doing exact arithmetic on it is a waste
7163 of time.
7165 Fractions become unwieldy after too many calculations have been
7166 done with them.  For example, the sum of the reciprocals of the
7167 integers from 1 to 10 is 7381:2520.  The sum from 1 to 30 is
7168 9304682830147:2329089562800.  After a point it will take a long
7169 time to add even one more term to this sum, but a floating-point
7170 calculation of the sum will not have this problem.
7172 Also, rational numbers cannot express the results of all calculations.
7173 There 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.
7176 @node Arithmetic Answer 1, Arithmetic Answer 2, Modes Answer 4, Answers to Exercises
7177 @subsection Arithmetic Tutorial Exercise 1
7179 @noindent
7180 Dividing two integers that are larger than the current precision may
7181 give a floating-point result that is inaccurate even when rounded
7182 down to an integer.  Consider @expr{123456789 / 2} when the current
7183 precision is 6 digits.  The true answer is @expr{61728394.5}, but
7184 with a precision of 6 this will be rounded to 
7185 @texline @math{12345700.0/2.0 = 61728500.0}.
7186 @infoline @expr{12345700.@: / 2.@: = 61728500.}.
7187 The result, when converted to an integer, will be off by 106.
7189 Here are two solutions:  Raise the precision enough that the
7190 floating-point round-off error is strictly to the right of the
7191 decimal point.  Or, convert to Fraction mode so that @expr{123456789 / 2}
7192 produces the exact fraction @expr{123456789:2}, which can be rounded
7193 down by the @kbd{F} command without ever switching to floating-point
7194 format.
7196 @node Arithmetic Answer 2, Vector Answer 1, Arithmetic Answer 1, Answers to Exercises
7197 @subsection Arithmetic Tutorial Exercise 2
7199 @noindent
7200 @kbd{27 @key{RET} 9 B} could give the exact result @expr{3:2}, but it
7201 does a floating-point calculation instead and produces @expr{1.5}.
7203 Calc will find an exact result for a logarithm if the result is an integer
7204 or (when in Fraction mode) the reciprocal of an integer.  But there is
7205 no efficient way to search the space of all possible rational numbers
7206 for an exact answer, so Calc doesn't try.
7208 @node Vector Answer 1, Vector Answer 2, Arithmetic Answer 2, Answers to Exercises
7209 @subsection Vector Tutorial Exercise 1
7211 @noindent
7212 Duplicate the vector, compute its length, then divide the vector
7213 by its length:  @kbd{@key{RET} A /}.
7215 @smallexample
7216 @group
7217 1:  [1, 2, 3]  2:  [1, 2, 3]      1:  [0.27, 0.53, 0.80]  1:  1.
7218     .          1:  3.74165738677      .                       .
7219                    .
7221     r 1            @key{RET} A              /                       A
7222 @end group
7223 @end smallexample
7225 The final @kbd{A} command shows that the normalized vector does
7226 indeed have unit length.
7228 @node Vector Answer 2, Matrix Answer 1, Vector Answer 1, Answers to Exercises
7229 @subsection Vector Tutorial Exercise 2
7231 @noindent
7232 The average position is equal to the sum of the products of the
7233 positions times their corresponding probabilities.  This is the
7234 definition of the dot product operation.  So all you need to do
7235 is to put the two vectors on the stack and press @kbd{*}.
7237 @node Matrix Answer 1, Matrix Answer 2, Vector Answer 2, Answers to Exercises
7238 @subsection Matrix Tutorial Exercise 1
7240 @noindent
7241 The trick is to multiply by a vector of ones.  Use @kbd{r 4 [1 1 1] *} to
7242 get the row sum.  Similarly, use @kbd{[1 1] r 4 *} to get the column sum.
7244 @node Matrix Answer 2, Matrix Answer 3, Matrix Answer 1, Answers to Exercises
7245 @subsection Matrix Tutorial Exercise 2
7247 @ifinfo
7248 @example
7249 @group
7250    x + a y = 6
7251    x + b y = 10
7252 @end group
7253 @end example
7254 @end ifinfo
7255 @tex
7256 \turnoffactive
7257 \beforedisplay
7258 $$ \eqalign{ x &+ a y = 6 \cr
7259              x &+ b y = 10}
7261 \afterdisplay
7262 @end tex
7264 Just enter the righthand side vector, then divide by the lefthand side
7265 matrix as usual.
7267 @smallexample
7268 @group
7269 1:  [6, 10]    2:  [6, 10]         1:  [6 - 4 a / (b - a), 4 / (b - a) ]
7270     .          1:  [ [ 1, a ]          .
7271                      [ 1, b ] ]
7272                    .
7274 ' [6 10] @key{RET}     ' [1 a; 1 b] @key{RET}      /
7275 @end group
7276 @end smallexample
7278 This can be made more readable using @kbd{d B} to enable Big display
7279 mode:
7281 @smallexample
7282 @group
7283           4 a     4
7284 1:  [6 - -----, -----]
7285          b - a  b - a
7286 @end group
7287 @end smallexample
7289 Type @kbd{d N} to return to Normal display mode afterwards.
7291 @node Matrix Answer 3, List Answer 1, Matrix Answer 2, Answers to Exercises
7292 @subsection Matrix Tutorial Exercise 3
7294 @noindent
7295 To solve 
7296 @texline @math{A^T A \, X = A^T B},
7297 @infoline @expr{trn(A) * A * X = trn(A) * B}, 
7298 first we compute
7299 @texline @math{A' = A^T A}
7300 @infoline @expr{A2 = trn(A) * A} 
7301 and 
7302 @texline @math{B' = A^T B};
7303 @infoline @expr{B2 = trn(A) * B}; 
7304 now, we have a system 
7305 @texline @math{A' X = B'}
7306 @infoline @expr{A2 * X = B2} 
7307 which we can solve using Calc's @samp{/} command.
7309 @ifinfo
7310 @example
7311 @group
7312     a + 2b + 3c = 6
7313    4a + 5b + 6c = 2
7314    7a + 6b      = 3
7315    2a + 4b + 6c = 11
7316 @end group
7317 @end example
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}
7332 \afterdisplayh
7333 @end tex
7335 The first step is to enter the coefficient matrix.  We'll store it in
7336 quick variable number 7 for later reference.  Next, we compute the
7337 @texline @math{B'}
7338 @infoline @expr{B2} 
7339 vector.
7341 @smallexample
7342 @group
7343 1:  [ [ 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     .                             .
7349 ' [1 2 3; 4 5 6; 7 6 0; 2 4 6] @key{RET}  s 7  v t  [6 2 3 11]   *
7350 @end group
7351 @end smallexample
7353 @noindent
7354 Now we compute the matrix 
7355 @texline @math{A'}
7356 @infoline @expr{A2} 
7357 and divide.
7359 @smallexample
7360 @group
7361 2:  [57, 84, 96]          1:  [-11.64, 14.08, -3.64]
7362 1:  [ [ 70, 72, 39 ]          .
7363       [ 72, 81, 60 ]
7364       [ 39, 60, 81 ] ]
7365     .
7367     r 7 v t r 7 *             /
7368 @end group
7369 @end smallexample
7371 @noindent
7372 (The actual computed answer will be slightly inexact due to
7373 round-off error.)
7375 Notice that the answers are similar to those for the 
7376 @texline @math{3\times3}
7377 @infoline 3x3
7378 system solved in the text.  That's because the fourth equation that was 
7379 added to the system is almost identical to the first one multiplied
7380 by two.  (If it were identical, we would have gotten the exact same
7381 answer since the 
7382 @texline @math{4\times3}
7383 @infoline 4x3
7384 system would be equivalent to the original 
7385 @texline @math{3\times3}
7386 @infoline 3x3
7387 system.)
7389 Since the first and fourth equations aren't quite equivalent, they
7390 can't both be satisfied at once.  Let's plug our answers back into
7391 the original system of equations to see how well they match.
7393 @smallexample
7394 @group
7395 2:  [-11.64, 14.08, -3.64]     1:  [5.6, 2., 3., 11.2]
7396 1:  [ [ 1, 2, 3 ]                  .
7397       [ 4, 5, 6 ]
7398       [ 7, 6, 0 ]
7399       [ 2, 4, 6 ] ]
7400     .
7402     r 7                            @key{TAB} *
7403 @end group
7404 @end smallexample
7406 @noindent
7407 This is reasonably close to our original @expr{B} vector,
7408 @expr{[6, 2, 3, 11]}.
7410 @node List Answer 1, List Answer 2, Matrix Answer 3, Answers to Exercises
7411 @subsection List Tutorial Exercise 1
7413 @noindent
7414 We can use @kbd{v x} to build a vector of integers.  This needs to be
7415 adjusted to get the range of integers we desire.  Mapping @samp{-}
7416 across the vector will accomplish this, although it turns out the
7417 plain @samp{-} key will work just as well.
7419 @smallexample
7420 @group
7421 2:  2                              2:  2
7422 1:  [1, 2, 3, 4, 5, 6, 7, 8, 9]    1:  [-4, -3, -2, -1, 0, 1, 2, 3, 4]
7423     .                                  .
7425     2  v x 9 @key{RET}                       5 V M -   or   5 -
7426 @end group
7427 @end smallexample
7429 @noindent
7430 Now we use @kbd{V M ^} to map the exponentiation operator across the
7431 vector.
7433 @smallexample
7434 @group
7435 1:  [0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16]
7436     .
7438     V M ^
7439 @end group
7440 @end smallexample
7442 @node List Answer 2, List Answer 3, List Answer 1, Answers to Exercises
7443 @subsection List Tutorial Exercise 2
7445 @noindent
7446 Given @expr{x} and @expr{y} vectors in quick variables 1 and 2 as before,
7447 the first job is to form the matrix that describes the problem.
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
7461 Thus we want a 
7462 @texline @math{19\times2}
7463 @infoline 19x2
7464 matrix with our @expr{x} vector as one column and
7465 ones as the other column.  So, first we build the column of ones, then
7466 we combine the two columns to form our @expr{A} matrix.
7468 @smallexample
7469 @group
7470 2:  [1.34, 1.41, 1.49, ... ]    1:  [ [ 1.34, 1 ]
7471 1:  [1, 1, 1, ...]                    [ 1.41, 1 ]
7472     .                                 [ 1.49, 1 ]
7473                                       @dots{}
7475     r 1 1 v b 19 @key{RET}                M-2 v p v t   s 3
7476 @end group
7477 @end smallexample
7479 @noindent
7480 Now we compute 
7481 @texline @math{A^T y}
7482 @infoline @expr{trn(A) * y} 
7483 and 
7484 @texline @math{A^T A}
7485 @infoline @expr{trn(A) * A} 
7486 and divide.
7488 @smallexample
7489 @group
7490 1:  [33.36554, 13.613]    2:  [33.36554, 13.613]
7491     .                     1:  [ [ 98.0003, 41.63 ]
7492                                 [  41.63,   19   ] ]
7493                               .
7495  v t r 2 *                    r 3 v t r 3 *
7496 @end group
7497 @end smallexample
7499 @noindent
7500 (Hey, those numbers look familiar!)
7502 @smallexample
7503 @group
7504 1:  [0.52141679, -0.425978]
7505     .
7507     /
7508 @end group
7509 @end smallexample
7511 Since we were solving equations of the form 
7512 @texline @math{m \times x + b \times 1 = y},
7513 @infoline @expr{m*x + b*1 = y}, 
7514 these numbers should be @expr{m} and @expr{b}, respectively.  Sure
7515 enough, they agree exactly with the result computed using @kbd{V M} and
7516 @kbd{V R}!
7518 The moral of this story:  @kbd{V M} and @kbd{V R} will probably solve
7519 your problem, but there is often an easier way using the higher-level
7520 arithmetic functions!
7522 @c [fix-ref Curve Fitting]
7523 In fact, there is a built-in @kbd{a F} command that does least-squares
7524 fits.  @xref{Curve Fitting}.
7526 @node List Answer 3, List Answer 4, List Answer 2, Answers to Exercises
7527 @subsection List Tutorial Exercise 3
7529 @noindent
7530 Move to one end of the list and press @kbd{C-@@} (or @kbd{C-@key{SPC}} or
7531 whatever) to set the mark, then move to the other end of the list
7532 and type @w{@kbd{M-# g}}.
7534 @smallexample
7535 @group
7536 1:  [2.3, 6, 22, 15.1, 7, 15, 14, 7.5, 2.5]
7537     .
7538 @end group
7539 @end smallexample
7541 To make things interesting, let's assume we don't know at a glance
7542 how many numbers are in this list.  Then we could type:
7544 @smallexample
7545 @group
7546 2:  [2.3, 6, 22, ... ]     2:  [2.3, 6, 22, ... ]
7547 1:  [2.3, 6, 22, ... ]     1:  126356422.5
7548     .                          .
7550     @key{RET}                        V R *
7552 @end group
7553 @end smallexample
7554 @noindent
7555 @smallexample
7556 @group
7557 2:  126356422.5            2:  126356422.5     1:  7.94652913734
7558 1:  [2.3, 6, 22, ... ]     1:  9                   .
7559     .                          .
7561     @key{TAB}                        v l                 I ^
7562 @end group
7563 @end smallexample
7565 @noindent
7566 (The @kbd{I ^} command computes the @var{n}th root of a number.
7567 You could also type @kbd{& ^} to take the reciprocal of 9 and
7568 then raise the number to that power.)
7570 @node List Answer 4, List Answer 5, List Answer 3, Answers to Exercises
7571 @subsection List Tutorial Exercise 4
7573 @noindent
7574 A number @expr{j} is a divisor of @expr{n} if 
7575 @texline @math{n \mathbin{\hbox{\code{\%}}} j = 0}.
7576 @infoline @samp{n % j = 0}.  
7577 The first step is to get a vector that identifies the divisors.
7579 @smallexample
7580 @group
7581 2:  30                  2:  [0, 0, 0, 2, ...]    1:  [1, 1, 1, 0, ...]
7582 1:  [1, 2, 3, 4, ...]   1:  0                        .
7583     .                       .
7585  30 @key{RET} v x 30 @key{RET}   s 1    V M %  0                 V M a =  s 2
7586 @end group
7587 @end smallexample
7589 @noindent
7590 This vector has 1's marking divisors of 30 and 0's marking non-divisors.
7592 The zeroth divisor function is just the total number of divisors.
7593 The first divisor function is the sum of the divisors.
7595 @smallexample
7596 @group
7597 1:  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                .
7602    V R +       r 1 r 2                  V M *                  V R +
7603 @end group
7604 @end smallexample
7606 @noindent
7607 Once again, the last two steps just compute a dot product for which
7608 a simple @kbd{*} would have worked equally well.
7610 @node List Answer 5, List Answer 6, List Answer 4, Answers to Exercises
7611 @subsection List Tutorial Exercise 5
7613 @noindent
7614 The obvious first step is to obtain the list of factors with @kbd{k f}.
7615 This list will always be in sorted order, so if there are duplicates
7616 they will be right next to each other.  A suitable method is to compare
7617 the list with a copy of itself shifted over by one.
7619 @smallexample
7620 @group
7621 1:  [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                            .                        .
7625     19551 k f              @key{RET} 0 |                  @key{TAB} 0 @key{TAB} |
7627 @end group
7628 @end smallexample
7629 @noindent
7630 @smallexample
7631 @group
7632 1:  [0, 0, 1, 1, 0, 0]   1:  2          1:  0
7633     .                        .              .
7635     V M a =                  V R +          0 a =
7636 @end group
7637 @end smallexample
7639 @noindent
7640 Note that we have to arrange for both vectors to have the same length
7641 so that the mapping operation works; no prime factor will ever be
7642 zero, so adding zeros on the left and right is safe.  From then on
7643 the job is pretty straightforward.
7645 Incidentally, Calc provides the 
7646 @texline @dfn{M@"obius} @math{\mu}
7647 @infoline @dfn{Moebius mu} 
7648 function which is zero if and only if its argument is square-free.  It
7649 would be a much more convenient way to do the above test in practice.
7651 @node List Answer 6, List Answer 7, List Answer 5, Answers to Exercises
7652 @subsection List Tutorial Exercise 6
7654 @noindent
7655 First use @kbd{v x 6 @key{RET}} to get a list of integers, then @kbd{V M v x}
7656 to get a list of lists of integers!
7658 @node List Answer 7, List Answer 8, List Answer 6, Answers to Exercises
7659 @subsection List Tutorial Exercise 7
7661 @noindent
7662 Here's one solution.  First, compute the triangular list from the previous
7663 exercise and type @kbd{1 -} to subtract one from all the elements.
7665 @smallexample
7666 @group
7667 1:  [ [0],
7668       [0, 1],
7669       [0, 1, 2],
7670       @dots{}
7672     1 -
7673 @end group
7674 @end smallexample
7676 The numbers down the lefthand edge of the list we desire are called
7677 the ``triangular numbers'' (now you know why!).  The @expr{n}th
7678 triangular number is the sum of the integers from 1 to @expr{n}, and
7679 can be computed directly by the formula 
7680 @texline @math{n (n+1) \over 2}.
7681 @infoline @expr{n * (n+1) / 2}.
7683 @smallexample
7684 @group
7685 2:  [ [0], [0, 1], ... ]    2:  [ [0], [0, 1], ... ]
7686 1:  [0, 1, 2, 3, 4, 5]      1:  [0, 1, 3, 6, 10, 15]
7687     .                           .
7689     v x 6 @key{RET} 1 -               V M ' $ ($+1)/2 @key{RET}
7690 @end group
7691 @end smallexample
7693 @noindent
7694 Adding this list to the above list of lists produces the desired
7695 result:
7697 @smallexample
7698 @group
7699 1:  [ [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       .
7707       V M +
7708 @end group
7709 @end smallexample
7711 If we did not know the formula for triangular numbers, we could have
7712 computed them using a @kbd{V U +} command.  We could also have
7713 gotten them the hard way by mapping a reduction across the original
7714 triangular list.
7716 @smallexample
7717 @group
7718 2:  [ [0], [0, 1], ... ]    2:  [ [0], [0, 1], ... ]
7719 1:  [ [0], [0, 1], ... ]    1:  [0, 1, 3, 6, 10, 15]
7720     .                           .
7722     @key{RET}                         V M V R +
7723 @end group
7724 @end smallexample
7726 @noindent
7727 (This means ``map a @kbd{V R +} command across the vector,'' and
7728 since each element of the main vector is itself a small vector,
7729 @kbd{V R +} computes the sum of its elements.)
7731 @node List Answer 8, List Answer 9, List Answer 7, Answers to Exercises
7732 @subsection List Tutorial Exercise 8
7734 @noindent
7735 The first step is to build a list of values of @expr{x}.
7737 @smallexample
7738 @group
7739 1:  [1, 2, 3, ..., 21]  1:  [0, 1, 2, ..., 20]  1:  [0, 0.25, 0.5, ..., 5]
7740     .                       .                       .
7742     v x 21 @key{RET}              1 -                     4 /  s 1
7743 @end group
7744 @end smallexample
7746 Next, we compute the Bessel function values.
7748 @smallexample
7749 @group
7750 1:  [0., 0.124, 0.242, ..., -0.328]
7751     .
7753     V M ' besJ(1,$) @key{RET}
7754 @end group
7755 @end smallexample
7757 @noindent
7758 (Another way to do this would be @kbd{1 @key{TAB} V M f j}.)
7760 A 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.
7763 @smallexample
7764 @group
7765 2:  [0., 0.124, 0.242, ... ]   1:  [0, 0, 0, ... ]    2:  [0, 0, 0, ... ]
7766 1:  0.5801562                      .                  1:  1
7767     .                                                     .
7769     @key{RET} V R X                      V M a =                @key{RET} V R +    @key{DEL}
7770 @end group
7771 @end smallexample
7773 @noindent
7774 It's a good idea to verify, as in the last step above, that only
7775 one value is equal to the maximum.  (After all, a plot of 
7776 @texline @math{\sin x}
7777 @infoline @expr{sin(x)}
7778 might have many points all equal to the maximum value, 1.)
7780 The vector we have now has a single 1 in the position that indicates
7781 the maximum value of @expr{x}.  Now it is a simple matter to convert
7782 this back into the corresponding value itself.
7784 @smallexample
7785 @group
7786 2:  [0, 0, 0, ... ]         1:  [0, 0., 0., ... ]    1:  1.75
7787 1:  [0, 0.25, 0.5, ... ]        .                        .
7788     .
7790     r 1                         V M *                    V R +
7791 @end group
7792 @end smallexample
7794 If @kbd{a =} had produced more than one @expr{1} value, this method
7795 would have given the sum of all maximum @expr{x} values; not very
7796 useful!  In this case we could have used @kbd{v m} (@code{calc-mask-vector})
7797 instead.  This command deletes all elements of a ``data'' vector that
7798 correspond to zeros in a ``mask'' vector, leaving us with, in this
7799 example, a vector of maximum @expr{x} values.
7801 The built-in @kbd{a X} command maximizes a function using more
7802 efficient methods.  Just for illustration, let's use @kbd{a X}
7803 to maximize @samp{besJ(1,x)} over this same interval.
7805 @smallexample
7806 @group
7807 2:  besJ(1, x)                 1:  [1.84115, 0.581865]
7808 1:  [0 .. 5]                       .
7809     .
7811 ' besJ(1,x), [0..5] @key{RET}            a X x @key{RET}
7812 @end group
7813 @end smallexample
7815 @noindent
7816 The output from @kbd{a X} is a vector containing the value of @expr{x}
7817 that maximizes the function, and the function's value at that maximum.
7818 As you can see, our simple search got quite close to the right answer.
7820 @node List Answer 9, List Answer 10, List Answer 8, Answers to Exercises
7821 @subsection List Tutorial Exercise 9
7823 @noindent
7824 Step one is to convert our integer into vector notation.
7826 @smallexample
7827 @group
7828 1:  25129925999           3:  25129925999
7829     .                     2:  10
7830                           1:  [11, 10, 9, ..., 1, 0]
7831                               .
7833     25129925999 @key{RET}           10 @key{RET} 12 @key{RET} v x 12 @key{RET} -
7835 @end group
7836 @end smallexample
7837 @noindent
7838 @smallexample
7839 @group
7840 1:  25129925999              1:  [0, 2, 25, 251, 2512, ... ]
7841 2:  [100000000000, ... ]         .
7842     .
7844     V M ^   s 1                  V M \
7845 @end group
7846 @end smallexample
7848 @noindent
7849 (Recall, the @kbd{\} command computes an integer quotient.)
7851 @smallexample
7852 @group
7853 1:  [0, 2, 5, 1, 2, 9, 9, 2, 5, 9, 9, 9]
7854     .
7856     10 V M %   s 2
7857 @end group
7858 @end smallexample
7860 Next we must increment this number.  This involves adding one to
7861 the last digit, plus handling carries.  There is a carry to the
7862 left out of a digit if that digit is a nine and all the digits to
7863 the right of it are nines.
7865 @smallexample
7866 @group
7867 1:  [0, 0, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1]   1:  [1, 1, 1, 0, 0, 1, ... ]
7868     .                                          .
7870     9 V M a =                                  v v
7872 @end group
7873 @end smallexample
7874 @noindent
7875 @smallexample
7876 @group
7877 1:  [1, 1, 1, 0, 0, 0, ... ]   1:  [0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1]
7878     .                              .
7880     V U *                          v v 1 |
7881 @end group
7882 @end smallexample
7884 @noindent
7885 Accumulating @kbd{*} across a vector of ones and zeros will preserve
7886 only the initial run of ones.  These are the carries into all digits
7887 except the rightmost digit.  Concatenating a one on the right takes
7888 care of aligning the carries properly, and also adding one to the
7889 rightmost digit.
7891 @smallexample
7892 @group
7893 2:  [0, 0, 0, 0, ... ]     1:  [0, 0, 2, 5, 1, 2, 9, 9, 2, 6, 0, 0, 0]
7894 1:  [0, 0, 2, 5, ... ]         .
7895     .
7897     0 r 2 |                    V M +  10 V M %
7898 @end group
7899 @end smallexample
7901 @noindent
7902 Here we have concatenated 0 to the @emph{left} of the original number;
7903 this takes care of shifting the carries by one with respect to the
7904 digits that generated them.
7906 Finally, we must convert this list back into an integer.
7908 @smallexample
7909 @group
7910 3:  [0, 0, 2, 5, ... ]        2:  [0, 0, 2, 5, ... ]
7911 2:  1000000000000             1:  [1000000000000, 100000000000, ... ]
7912 1:  [100000000000, ... ]          .
7913     .
7915     10 @key{RET} 12 ^  r 1              |
7917 @end group
7918 @end smallexample
7919 @noindent
7920 @smallexample
7921 @group
7922 1:  [0, 0, 20000000000, 5000000000, ... ]    1:  25129926000
7923     .                                            .
7925     V M *                                        V R +
7926 @end group
7927 @end smallexample
7929 @noindent
7930 Another way to do this final step would be to reduce the formula
7931 @w{@samp{10 $$ + $}} across the vector of digits.
7933 @smallexample
7934 @group
7935 1:  [0, 0, 2, 5, ... ]        1:  25129926000
7936     .                             .
7938                                   V R ' 10 $$ + $ @key{RET}
7939 @end group
7940 @end smallexample
7942 @node List Answer 10, List Answer 11, List Answer 9, Answers to Exercises
7943 @subsection List Tutorial Exercise 10
7945 @noindent
7946 For the list @expr{[a, b, c, d]}, the result is @expr{((a = b) = c) = d},
7947 which will compare @expr{a} and @expr{b} to produce a 1 or 0, which is
7948 then compared with @expr{c} to produce another 1 or 0, which is then
7949 compared with @expr{d}.  This is not at all what Joe wanted.
7951 Here's a more correct method:
7953 @smallexample
7954 @group
7955 1:  [7, 7, 7, 8, 7]      2:  [7, 7, 7, 8, 7]
7956     .                    1:  7
7957                              .
7959   ' [7,7,7,8,7] @key{RET}          @key{RET} v r 1 @key{RET}
7961 @end group
7962 @end smallexample
7963 @noindent
7964 @smallexample
7965 @group
7966 1:  [1, 1, 1, 0, 1]      1:  0
7967     .                        .
7969     V M a =                  V R *
7970 @end group
7971 @end smallexample
7973 @node List Answer 11, List Answer 12, List Answer 10, Answers to Exercises
7974 @subsection List Tutorial Exercise 11
7976 @noindent
7977 The 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}
7979 and a vector of @expr{y^2}.
7981 We can make this go a bit faster by using the @kbd{v .} and @kbd{t .}
7982 commands.
7984 @smallexample
7985 @group
7986 2:  [2., 2., ..., 2.]          2:  [2., 2., ..., 2.]
7987 1:  [2., 2., ..., 2.]          1:  [1.16, 1.98, ..., 0.81]
7988     .                              .
7990  v . t .  2. v b 100 @key{RET} @key{RET}       V M k r
7992 @end group
7993 @end smallexample
7994 @noindent
7995 @smallexample
7996 @group
7997 2:  [2., 2., ..., 2.]          1:  [0.026, 0.96, ..., 0.036]
7998 1:  [0.026, 0.96, ..., 0.036]  2:  [0.53, 0.81, ..., 0.094]
7999     .                              .
8001     1 -  2 V M ^                   @key{TAB}  V M k r  1 -  2 V M ^
8002 @end group
8003 @end smallexample
8005 Now we sum the @expr{x^2} and @expr{y^2} values, compare with 1 to
8006 get a vector of 1/0 truth values, then sum the truth values.
8008 @smallexample
8009 @group
8010 1:  [0.56, 1.78, ..., 0.13]    1:  [1, 0, ..., 1]    1:  84
8011     .                              .                     .
8013     +                              1 V M a <             V R +
8014 @end group
8015 @end smallexample
8017 @noindent
8018 The ratio @expr{84/100} should approximate the ratio @cpiover{4}.
8020 @smallexample
8021 @group
8022 1:  0.84       1:  3.36       2:  3.36       1:  1.0695
8023     .              .          1:  3.14159        .
8025     100 /          4 *            P              /
8026 @end group
8027 @end smallexample
8029 @noindent
8030 Our estimate, 3.36, is off by about 7%.  We could get a better estimate
8031 by taking more points (say, 1000), but it's clear that this method is
8032 not very efficient!
8034 (Naturally, since this example uses random numbers your own answer
8035 will be slightly different from the one shown here!)
8037 If you typed @kbd{v .} and @kbd{t .} before, type them again to
8038 return to full-sized display of vectors.
8040 @node List Answer 12, List Answer 13, List Answer 11, Answers to Exercises
8041 @subsection List Tutorial Exercise 12
8043 @noindent
8044 This problem can be made a lot easier by taking advantage of some
8045 symmetries.  First of all, after some thought it's clear that the
8046 @expr{y} axis can be ignored altogether.  Just pick a random @expr{x}
8047 component for one end of the match, pick a random direction 
8048 @texline @math{\theta},
8049 @infoline @expr{theta},
8050 and see if @expr{x} and 
8051 @texline @math{x + \cos \theta}
8052 @infoline @expr{x + cos(theta)} 
8053 (which is the @expr{x} coordinate of the other endpoint) cross a line.
8054 The lines are at integer coordinates, so this happens when the two
8055 numbers surround an integer.
8057 Since the two endpoints are equivalent, we may as well choose the leftmost
8058 of the two endpoints as @expr{x}.  Then @expr{theta} is an angle pointing
8059 to the right, in the range -90 to 90 degrees.  (We could use radians, but
8060 it would feel like cheating to refer to @cpiover{2} radians while trying
8061 to estimate @cpi{}!)
8063 In fact, since the field of lines is infinite we can choose the
8064 coordinates 0 and 1 for the lines on either side of the leftmost
8065 endpoint.  The rightmost endpoint will be between 0 and 1 if the
8066 match does not cross a line, or between 1 and 2 if it does.  So:
8067 Pick random @expr{x} and 
8068 @texline @math{\theta},
8069 @infoline @expr{theta}, 
8070 compute
8071 @texline @math{x + \cos \theta},
8072 @infoline @expr{x + cos(theta)},
8073 and count how many of the results are greater than one.  Simple!
8075 We can make this go a bit faster by using the @kbd{v .} and @kbd{t .}
8076 commands.
8078 @smallexample
8079 @group
8080 1:  [0.52, 0.71, ..., 0.72]    2:  [0.52, 0.71, ..., 0.72]
8081     .                          1:  [78.4, 64.5, ..., -42.9]
8082                                    .
8084 v . t . 1. v b 100 @key{RET}  V M k r    180. v b 100 @key{RET}  V M k r  90 -
8085 @end group
8086 @end smallexample
8088 @noindent
8089 (The next step may be slow, depending on the speed of your computer.)
8091 @smallexample
8092 @group
8093 2:  [0.52, 0.71, ..., 0.72]    1:  [0.72, 1.14, ..., 1.45]
8094 1:  [0.20, 0.43, ..., 0.73]        .
8095     .
8097     m d  V M C                     +
8099 @end group
8100 @end smallexample
8101 @noindent
8102 @smallexample
8103 @group
8104 1:  [0, 1, ..., 1]       1:  0.64            1:  3.125
8105     .                        .                   .
8107     1 V M a >                V R + 100 /         2 @key{TAB} /
8108 @end group
8109 @end smallexample
8111 Let's try the third method, too.  We'll use random integers up to
8112 one million.  The @kbd{k r} command with an integer argument picks
8113 a random integer.
8115 @smallexample
8116 @group
8117 2:  [1000000, 1000000, ..., 1000000]   2:  [78489, 527587, ..., 814975]
8118 1:  [1000000, 1000000, ..., 1000000]   1:  [324014, 358783, ..., 955450]
8119     .                                      .
8121     1000000 v b 100 @key{RET} @key{RET}                V M k r  @key{TAB}  V M k r
8123 @end group
8124 @end smallexample
8125 @noindent
8126 @smallexample
8127 @group
8128 1:  [1, 1, ..., 25]      1:  [1, 1, ..., 0]     1:  0.56
8129     .                        .                      .
8131     V M k g                  1 V M a =              V R + 100 /
8133 @end group
8134 @end smallexample
8135 @noindent
8136 @smallexample
8137 @group
8138 1:  10.714        1:  3.273
8139     .                 .
8141     6 @key{TAB} /           Q
8142 @end group
8143 @end smallexample
8145 For a proof of this property of the GCD function, see section 4.5.2,
8146 exercise 10, of Knuth's @emph{Art of Computer Programming}, volume II.
8148 If you typed @kbd{v .} and @kbd{t .} before, type them again to
8149 return to full-sized display of vectors.
8151 @node List Answer 13, List Answer 14, List Answer 12, Answers to Exercises
8152 @subsection List Tutorial Exercise 13
8154 @noindent
8155 First, we put the string on the stack as a vector of ASCII codes.
8157 @smallexample
8158 @group
8159 1:  [84, 101, 115, ..., 51]
8160     .
8162     "Testing, 1, 2, 3 @key{RET}
8163 @end group
8164 @end smallexample
8166 @noindent
8167 Note that the @kbd{"} key, like @kbd{$}, initiates algebraic entry so
8168 there was no need to type an apostrophe.  Also, Calc didn't mind that
8169 we omitted the closing @kbd{"}.  (The same goes for all closing delimiters
8170 like @kbd{)} and @kbd{]} at the end of a formula.
8172 We'll show two different approaches here.  In the first, we note that
8173 if 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,
8175 it's a sum of descending powers of three times the ASCII codes.
8177 @smallexample
8178 @group
8179 2:  [84, 101, 115, ..., 51]    2:  [84, 101, 115, ..., 51]
8180 1:  16                         1:  [15, 14, 13, ..., 0]
8181     .                              .
8183     @key{RET} v l                        v x 16 @key{RET} -
8185 @end group
8186 @end smallexample
8187 @noindent
8188 @smallexample
8189 @group
8190 2:  [84, 101, 115, ..., 51]    1:  1960915098    1:  121
8191 1:  [14348907, ..., 1]             .                 .
8192     .
8194     3 @key{TAB} V M ^                    *                 511 %
8195 @end group
8196 @end smallexample
8198 @noindent
8199 Once again, @kbd{*} elegantly summarizes most of the computation.
8200 But there's an even more elegant approach:  Reduce the formula
8201 @kbd{3 $$ + $} across the vector.  Recall that this represents a
8202 function of two arguments that computes its first argument times three
8203 plus its second argument.
8205 @smallexample
8206 @group
8207 1:  [84, 101, 115, ..., 51]    1:  1960915098
8208     .                              .
8210     "Testing, 1, 2, 3 @key{RET}          V R ' 3$$+$ @key{RET}
8211 @end group
8212 @end smallexample
8214 @noindent
8215 If you did the decimal arithmetic exercise, this will be familiar.
8216 Basically, we're turning a base-3 vector of digits into an integer,
8217 except that our ``digits'' are much larger than real digits.
8219 Instead of typing @kbd{511 %} again to reduce the result, we can be
8220 cleverer still and notice that rather than computing a huge integer
8221 and taking the modulo at the end, we can take the modulo at each step
8222 without affecting the result.  While this means there are more
8223 arithmetic operations, the numbers we operate on remain small so
8224 the operations are faster.
8226 @smallexample
8227 @group
8228 1:  [84, 101, 115, ..., 51]    1:  121
8229     .                              .
8231     "Testing, 1, 2, 3 @key{RET}          V R ' (3$$+$)%511 @key{RET}
8232 @end group
8233 @end smallexample
8235 Why does this work?  Think about a two-step computation:
8236 @w{@expr{3 (3a + b) + c}}.  Taking a result modulo 511 basically means
8237 subtracting off enough 511's to put the result in the desired range.
8238 So the result when we take the modulo after every step is,
8240 @ifinfo
8241 @example
8242 3 (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
8252 @noindent
8253 for some suitable integers @expr{m} and @expr{n}.  Expanding out by
8254 the distributive law yields
8256 @ifinfo
8257 @example
8258 9 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
8268 @noindent
8269 The @expr{m} term in the latter formula is redundant because any
8270 contribution it makes could just as easily be made by the @expr{n}
8271 term.  So we can take it out to get an equivalent formula with
8272 @expr{n' = 3m + n},
8274 @ifinfo
8275 @example
8276 9 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
8286 @noindent
8287 which is just the formula for taking the modulo only at the end of
8288 the calculation.  Therefore the two methods are essentially the same.
8290 Later in the tutorial we will encounter @dfn{modulo forms}, which
8291 basically automate the idea of reducing every intermediate result
8292 modulo some value @var{m}.
8294 @node List Answer 14, Types Answer 1, List Answer 13, Answers to Exercises
8295 @subsection List Tutorial Exercise 14
8297 We want to use @kbd{H V U} to nest a function which adds a random
8298 step to an @expr{(x,y)} coordinate.  The function is a bit long, but
8299 otherwise the problem is quite straightforward.
8301 @smallexample
8302 @group
8303 2:  [0, 0]     1:  [ [    0,       0    ]
8304 1:  50               [  0.4288, -0.1695 ]
8305     .                [ -0.4787, -0.9027 ]
8306                      ...
8308     [0,0] 50       H V U ' <# + [random(2.0)-1, random(2.0)-1]> @key{RET}
8309 @end group
8310 @end smallexample
8312 Just as the text recommended, we used @samp{< >} nameless function
8313 notation to keep the two @code{random} calls from being evaluated
8314 before nesting even begins.
8316 We now have a vector of @expr{[x, y]} sub-vectors, which by Calc's
8317 rules acts like a matrix.  We can transpose this matrix and unpack
8318 to get a pair of vectors, @expr{x} and @expr{y}, suitable for graphing.
8320 @smallexample
8321 @group
8322 2:  [ 0, 0.4288, -0.4787, ... ]
8323 1:  [ 0, -0.1696, -0.9027, ... ]
8324     .
8326     v t  v u  g f
8327 @end group
8328 @end smallexample
8330 Incidentally, because the @expr{x} and @expr{y} are completely
8331 independent in this case, we could have done two separate commands
8332 to create our @expr{x} and @expr{y} vectors of numbers directly.
8334 To make a random walk of unit steps, we note that @code{sincos} of
8335 a random direction exactly gives us an @expr{[x, y]} step of unit
8336 length; in fact, the new nesting function is even briefer, though
8337 we might want to lower the precision a bit for it.
8339 @smallexample
8340 @group
8341 2:  [0, 0]     1:  [ [    0,      0    ]
8342 1:  50               [  0.1318, 0.9912 ]
8343     .                [ -0.5965, 0.3061 ]
8344                      ...
8346     [0,0] 50   m d  p 6 @key{RET}   H V U ' <# + sincos(random(360.0))> @key{RET}
8347 @end group
8348 @end smallexample
8350 Another @kbd{v t v u g f} sequence will graph this new random walk.
8352 An interesting twist on these random walk functions would be to use
8353 complex numbers instead of 2-vectors to represent points on the plane.
8354 In the first example, we'd use something like @samp{random + random*(0,1)},
8355 and in the second we could use polar complex numbers with random phase
8356 angles.  (This exercise was first suggested in this form by Randal
8357 Schwartz.)
8359 @node Types Answer 1, Types Answer 2, List Answer 14, Answers to Exercises
8360 @subsection Types Tutorial Exercise 1
8362 @noindent
8363 If the number is the square root of @cpi{} times a rational number,
8364 then its square, divided by @cpi{}, should be a rational number.
8366 @smallexample
8367 @group
8368 1:  1.26508260337    1:  0.509433962268   1:  2486645810:4881193627
8369     .                    .                    .
8371                          2 ^ P /              c F
8372 @end group
8373 @end smallexample
8375 @noindent
8376 Technically speaking this is a rational number, but not one that is
8377 likely to have arisen in the original problem.  More likely, it just
8378 happens to be the fraction which most closely represents some
8379 irrational number to within 12 digits.
8381 But perhaps our result was not quite exact.  Let's reduce the
8382 precision slightly and try again:
8384 @smallexample
8385 @group
8386 1:  0.509433962268     1:  27:53
8387     .                      .
8389     U p 10 @key{RET}             c F
8390 @end group
8391 @end smallexample
8393 @noindent
8394 Aha!  It's unlikely that an irrational number would equal a fraction
8395 this simple to within ten digits, so our original number was probably
8396 @texline @math{\sqrt{27 \pi / 53}}.
8397 @infoline @expr{sqrt(27 pi / 53)}.
8399 Notice that we didn't need to re-round the number when we reduced the
8400 precision.  Remember, arithmetic operations always round their inputs
8401 to the current precision before they begin.
8403 @node Types Answer 2, Types Answer 3, Types Answer 1, Answers to Exercises
8404 @subsection Types Tutorial Exercise 2
8406 @noindent
8407 @samp{inf / inf = nan}.  Perhaps @samp{1} is the ``obvious'' answer.
8408 But if @w{@samp{17 inf = inf}}, then @samp{17 inf / inf = inf / inf = 17}, too.
8410 @samp{exp(inf) = inf}.  It's tempting to say that the exponential
8411 of infinity must be ``bigger'' than ``regular'' infinity, but as
8412 far as Calc is concerned all infinities are as just as big.
8413 In other words, as @expr{x} goes to infinity, @expr{e^x} also goes
8414 to infinity, but the fact the @expr{e^x} grows much faster than
8415 @expr{x} is not relevant here.
8417 @samp{exp(-inf) = 0}.  Here we have a finite answer even though
8418 the input is infinite.
8420 @samp{sqrt(-inf) = (0, 1) inf}.  Remember that @expr{(0, 1)}
8421 represents the imaginary number @expr{i}.  Here's a derivation:
8422 @samp{sqrt(-inf) = @w{sqrt((-1) * inf)} = sqrt(-1) * sqrt(inf)}.
8423 The first part is, by definition, @expr{i}; the second is @code{inf}
8424 because, once again, all infinities are the same size.
8426 @samp{sqrt(uinf) = uinf}.  In fact, we do know something about the
8427 direction because @code{sqrt} is defined to return a value in the
8428 right half of the complex plane.  But Calc has no notation for this,
8429 so it settles for the conservative answer @code{uinf}.
8431 @samp{abs(uinf) = inf}.  No matter which direction @expr{x} points,
8432 @samp{abs(x)} always points along the positive real axis.
8434 @samp{ln(0) = -inf}.  Here we have an infinite answer to a finite
8435 input.  As in the @expr{1 / 0} case, Calc will only use infinities
8436 here if you have turned on Infinite mode.  Otherwise, it will
8437 treat @samp{ln(0)} as an error.
8439 @node Types Answer 3, Types Answer 4, Types Answer 2, Answers to Exercises
8440 @subsection Types Tutorial Exercise 3
8442 @noindent
8443 We can make @samp{inf - inf} be any real number we like, say,
8444 @expr{a}, just by claiming that we added @expr{a} to the first
8445 infinity but not to the second.  This is just as true for complex
8446 values of @expr{a}, so @code{nan} can stand for a complex number.
8447 (And, similarly, @code{uinf} can stand for an infinity that points
8448 in any direction in the complex plane, such as @samp{(0, 1) inf}).
8450 In 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}.
8452 So @code{nan} can even stand for infinity.  Obviously it's just
8453 as easy to make it stand for minus infinity as for plus infinity.
8455 The moral of this story is that ``infinity'' is a slippery fish
8456 indeed, and Calc tries to handle it by having a very simple model
8457 for infinities (only the direction counts, not the ``size''); but
8458 Calc is careful to write @code{nan} any time this simple model is
8459 unable to tell what the true answer is.
8461 @node Types Answer 4, Types Answer 5, Types Answer 3, Answers to Exercises
8462 @subsection Types Tutorial Exercise 4
8464 @smallexample
8465 @group
8466 2:  0@@ 47' 26"              1:  0@@ 2' 47.411765"
8467 1:  17                          .
8468     .
8470     0@@ 47' 26" @key{RET} 17           /
8471 @end group
8472 @end smallexample
8474 @noindent
8475 The average song length is two minutes and 47.4 seconds.
8477 @smallexample
8478 @group
8479 2:  0@@ 2' 47.411765"     1:  0@@ 3' 7.411765"    1:  0@@ 53' 6.000005"
8480 1:  0@@ 0' 20"                .                      .
8481     .
8483     20"                      +                      17 *
8484 @end group
8485 @end smallexample
8487 @noindent
8488 The album would be 53 minutes and 6 seconds long.
8490 @node Types Answer 5, Types Answer 6, Types Answer 4, Answers to Exercises
8491 @subsection Types Tutorial Exercise 5
8493 @noindent
8494 Let's suppose it's January 14, 1991.  The easiest thing to do is
8495 to keep trying 13ths of months until Calc reports a Friday.
8496 We can do this by manually entering dates, or by using @kbd{t I}:
8498 @smallexample
8499 @group
8500 1:  <Wed Feb 13, 1991>    1:  <Wed Mar 13, 1991>   1:  <Sat Apr 13, 1991>
8501     .                         .                        .
8503     ' <2/13> @key{RET}       @key{DEL}    ' <3/13> @key{RET}             t I
8504 @end group
8505 @end smallexample
8507 @noindent
8508 (Calc assumes the current year if you don't say otherwise.)
8510 This 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
8512 vector mapping.  The @kbd{t I} command actually takes a second
8513 ``how-many-months'' argument, which defaults to one.  This
8514 argument is exactly what we want to map over:
8516 @smallexample
8517 @group
8518 2:  <Sat Apr 13, 1991>     1:  [<Mon May 13, 1991>, <Thu Jun 13, 1991>,
8519 1:  [1, 2, 3, 4, 5, 6]          <Sat Jul 13, 1991>, <Tue Aug 13, 1991>,
8520     .                           <Fri Sep 13, 1991>, <Sun Oct 13, 1991>]
8521                                .
8523     v x 6 @key{RET}                  V M t I
8524 @end group
8525 @end smallexample
8527 @noindent
8528 Et voil@`a, September 13, 1991 is a Friday.
8530 @smallexample
8531 @group
8532 1:  242
8533     .
8535 ' <sep 13> - <jan 14> @key{RET}
8536 @end group
8537 @end smallexample
8539 @noindent
8540 And the answer to our original question:  242 days to go.
8542 @node Types Answer 6, Types Answer 7, Types Answer 5, Answers to Exercises
8543 @subsection Types Tutorial Exercise 6
8545 @noindent
8546 The full rule for leap years is that they occur in every year divisible
8547 by four, except that they don't occur in years divisible by 100, except
8548 that they @emph{do} in years divisible by 400.  We could work out the
8549 answer by carefully counting the years divisible by four and the
8550 exceptions, but there is a much simpler way that works even if we
8551 don't know the leap year rule.
8553 Let's assume the present year is 1991.  Years have 365 days, except
8554 that leap years (whenever they occur) have 366 days.  So let's count
8555 the number of days between now and then, and compare that to the
8556 number of years times 365.  The number of extra days we find must be
8557 equal to the number of leap years there were.
8559 @smallexample
8560 @group
8561 1:  <Mon Jan 1, 10001>     2:  <Mon Jan 1, 10001>     1:  2925593
8562     .                      1:  <Tue Jan 1, 1991>          .
8563                                .
8565   ' <jan 1 10001> @key{RET}         ' <jan 1 1991> @key{RET}          -
8567 @end group
8568 @end smallexample
8569 @noindent
8570 @smallexample
8571 @group
8572 3:  2925593       2:  2925593     2:  2925593     1:  1943
8573 2:  10001         1:  8010        1:  2923650         .
8574 1:  1991              .               .
8575     .
8577   10001 @key{RET} 1991      -               365 *           -
8578 @end group
8579 @end smallexample
8581 @c [fix-ref Date Forms]
8582 @noindent
8583 There will be 1943 leap years before the year 10001.  (Assuming,
8584 of course, that the algorithm for computing leap years remains
8585 unchanged for that long.  @xref{Date Forms}, for some interesting
8586 background information in that regard.)
8588 @node Types Answer 7, Types Answer 8, Types Answer 6, Answers to Exercises
8589 @subsection Types Tutorial Exercise 7
8591 @noindent
8592 The relative errors must be converted to absolute errors so that
8593 @samp{+/-} notation may be used.
8595 @smallexample
8596 @group
8597 1:  1.              2:  1.
8598     .               1:  0.2
8599                         .
8601     20 @key{RET} .05 *        4 @key{RET} .05 *
8602 @end group
8603 @end smallexample
8605 Now we simply chug through the formula.
8607 @smallexample
8608 @group
8609 1:  19.7392088022    1:  394.78 +/- 19.739    1:  6316.5 +/- 706.21
8610     .                    .                        .
8612     2 P 2 ^ *            20 p 1 *                 4 p .2 @key{RET} 2 ^ *
8613 @end group
8614 @end smallexample
8616 It turns out the @kbd{v u} command will unpack an error form as
8617 well as a vector.  This saves us some retyping of numbers.
8619 @smallexample
8620 @group
8621 3:  6316.5 +/- 706.21     2:  6316.5 +/- 706.21
8622 2:  6316.5                1:  0.1118
8623 1:  706.21                    .
8624     .
8626     @key{RET} v u                   @key{TAB} /
8627 @end group
8628 @end smallexample
8630 @noindent
8631 Thus the volume is 6316 cubic centimeters, within about 11 percent.
8633 @node Types Answer 8, Types Answer 9, Types Answer 7, Answers to Exercises
8634 @subsection Types Tutorial Exercise 8
8636 @noindent
8637 The first answer is pretty simple:  @samp{1 / (0 .. 10) = (0.1 .. inf)}.
8638 Since a number in the interval @samp{(0 .. 10)} can get arbitrarily
8639 close to zero, its reciprocal can get arbitrarily large, so the answer
8640 is an interval that effectively means, ``any number greater than 0.1''
8641 but with no upper bound.
8643 The second answer, similarly, is @samp{1 / (-10 .. 0) = (-inf .. -0.1)}.
8645 Calc 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
8648 is now a member of the interval.  So Calc leaves this one unevaluated, too.
8650 If you turn on Infinite mode by pressing @kbd{m i}, you will
8651 instead get the answer @samp{[0.1 .. inf]}, which includes infinity
8652 as a possible value.
8654 The fourth calculation, @samp{1 / (-10 .. 10)}, has the same problem.
8655 Zero is buried inside the interval, but it's still a possible value.
8656 It's not hard to see that the actual result of @samp{1 / (-10 .. 10)}
8657 will be either greater than @mathit{0.1}, or less than @mathit{-0.1}.  Thus
8658 the interval goes from minus infinity to plus infinity, with a ``hole''
8659 in it from @mathit{-0.1} to @mathit{0.1}.  Calc doesn't have any way to
8660 represent this, so it just reports @samp{[-inf .. inf]} as the answer.
8661 It may be disappointing to hear ``the answer lies somewhere between
8662 minus infinity and plus infinity, inclusive,'' but that's the best
8663 that interval arithmetic can do in this case.
8665 @node Types Answer 9, Types Answer 10, Types Answer 8, Answers to Exercises
8666 @subsection Types Tutorial Exercise 9
8668 @smallexample
8669 @group
8670 1:  [-3 .. 3]       2:  [-3 .. 3]     2:  [0 .. 9]
8671     .               1:  [0 .. 9]      1:  [-9 .. 9]
8672                         .                 .
8674     [ 3 n .. 3 ]        @key{RET} 2 ^           @key{TAB} @key{RET} *
8675 @end group
8676 @end smallexample
8678 @noindent
8679 In the first case the result says, ``if a number is between @mathit{-3} and
8680 3, its square is between 0 and 9.''  The second case says, ``the product
8681 of two numbers each between @mathit{-3} and 3 is between @mathit{-9} and 9.''
8683 An interval form is not a number; it is a symbol that can stand for
8684 many different numbers.  Two identical-looking interval forms can stand
8685 for different numbers.
8687 The same issue arises when you try to square an error form.
8689 @node Types Answer 10, Types Answer 11, Types Answer 9, Answers to Exercises
8690 @subsection Types Tutorial Exercise 10
8692 @noindent
8693 Testing the first number, we might arbitrarily choose 17 for @expr{x}.
8695 @smallexample
8696 @group
8697 1:  17 mod 811749613   2:  17 mod 811749613   1:  533694123 mod 811749613
8698     .                      811749612              .
8699                            .
8701     17 M 811749613 @key{RET}     811749612              ^
8702 @end group
8703 @end smallexample
8705 @noindent
8706 Since 533694123 is (considerably) different from 1, the number 811749613
8707 must not be prime.
8709 It's awkward to type the number in twice as we did above.  There are
8710 various ways to avoid this, and algebraic entry is one.  In fact, using
8711 a vector mapping operation we can perform several tests at once.  Let's
8712 use this method to test the second number.
8714 @smallexample
8715 @group
8716 2:  [17, 42, 100000]               1:  [1 mod 15485863, 1 mod ... ]
8717 1:  15485863                           .
8718     .
8720  [17 42 100000] 15485863 @key{RET}           V M ' ($$ mod $)^($-1) @key{RET}
8721 @end group
8722 @end smallexample
8724 @noindent
8725 The result is three ones (modulo @expr{n}), so it's very probable that
8726 15485863 is prime.  (In fact, this number is the millionth prime.)
8728 Note that the functions @samp{($$^($-1)) mod $} or @samp{$$^($-1) % $}
8729 would have been hopelessly inefficient, since they would have calculated
8730 the power using full integer arithmetic.
8732 Calc has a @kbd{k p} command that does primality testing.  For small
8733 numbers it does an exact test; for large numbers it uses a variant
8734 of the Fermat test we used here.  You can use @kbd{k p} repeatedly
8735 to prove that a large integer is prime with any desired probability.
8737 @node Types Answer 11, Types Answer 12, Types Answer 10, Answers to Exercises
8738 @subsection Types Tutorial Exercise 11
8740 @noindent
8741 There are several ways to insert a calculated number into an HMS form.
8742 One way to convert a number of seconds to an HMS form is simply to
8743 multiply the number by an HMS form representing one second:
8745 @smallexample
8746 @group
8747 1:  31415926.5359     2:  31415926.5359     1:  8726@@ 38' 46.5359"
8748     .                 1:  0@@ 0' 1"              .
8749                           .
8751     P 1e7 *               0@@ 0' 1"              *
8753 @end group
8754 @end smallexample
8755 @noindent
8756 @smallexample
8757 @group
8758 2:  8726@@ 38' 46.5359"             1:  6@@ 6' 2.5359" mod 24@@ 0' 0"
8759 1:  15@@ 27' 16" mod 24@@ 0' 0"          .
8760     .
8762     x time @key{RET}                         +
8763 @end group
8764 @end smallexample
8766 @noindent
8767 It will be just after six in the morning.
8769 The algebraic @code{hms} function can also be used to build an
8770 HMS form:
8772 @smallexample
8773 @group
8774 1:  hms(0, 0, 10000000. pi)       1:  8726@@ 38' 46.5359"
8775     .                                 .
8777   ' hms(0, 0, 1e7 pi) @key{RET}             =
8778 @end group
8779 @end smallexample
8781 @noindent
8782 The @kbd{=} key is necessary to evaluate the symbol @samp{pi} to
8783 the actual number 3.14159...
8785 @node Types Answer 12, Types Answer 13, Types Answer 11, Answers to Exercises
8786 @subsection Types Tutorial Exercise 12
8788 @noindent
8789 As we recall, there are 17 songs of about 2 minutes and 47 seconds
8790 each.
8792 @smallexample
8793 @group
8794 2:  0@@ 2' 47"                    1:  [0@@ 3' 7" .. 0@@ 3' 47"]
8795 1:  [0@@ 0' 20" .. 0@@ 1' 0"]          .
8796     .
8798     [ 0@@ 20" .. 0@@ 1' ]              +
8800 @end group
8801 @end smallexample
8802 @noindent
8803 @smallexample
8804 @group
8805 1:  [0@@ 52' 59." .. 1@@ 4' 19."]
8806     .
8808     17 *
8809 @end group
8810 @end smallexample
8812 @noindent
8813 No matter how long it is, the album will fit nicely on one CD.
8815 @node Types Answer 13, Types Answer 14, Types Answer 12, Answers to Exercises
8816 @subsection Types Tutorial Exercise 13
8818 @noindent
8819 Type @kbd{' 1 yr @key{RET} u c s @key{RET}}.  The answer is 31557600 seconds.
8821 @node Types Answer 14, Types Answer 15, Types Answer 13, Answers to Exercises
8822 @subsection Types Tutorial Exercise 14
8824 @noindent
8825 How long will it take for a signal to get from one end of the computer
8826 to the other?
8828 @smallexample
8829 @group
8830 1:  m / c         1:  3.3356 ns
8831     .                 .
8833  ' 1 m / c @key{RET}        u c ns @key{RET}
8834 @end group
8835 @end smallexample
8837 @noindent
8838 (Recall, @samp{c} is a ``unit'' corresponding to the speed of light.)
8840 @smallexample
8841 @group
8842 1:  3.3356 ns     1:  0.81356 ns / ns     1:  0.81356
8843 2:  4.1 ns            .                       .
8844     .
8846   ' 4.1 ns @key{RET}        /                       u s
8847 @end group
8848 @end smallexample
8850 @noindent
8851 Thus a signal could take up to 81 percent of a clock cycle just to
8852 go from one place to another inside the computer, assuming the signal
8853 could actually attain the full speed of light.  Pretty tight!
8855 @node Types Answer 15, Algebra Answer 1, Types Answer 14, Answers to Exercises
8856 @subsection Types Tutorial Exercise 15
8858 @noindent
8859 The speed limit is 55 miles per hour on most highways.  We want to
8860 find the ratio of Sam's speed to the US speed limit.
8862 @smallexample
8863 @group
8864 1:  55 mph         2:  55 mph           3:  11 hr mph / yd
8865     .              1:  5 yd / hr            .
8866                        .
8868   ' 55 mph @key{RET}       ' 5 yd/hr @key{RET}          /
8869 @end group
8870 @end smallexample
8872 The @kbd{u s} command cancels out these units to get a plain
8873 number.  Now we take the logarithm base two to find the final
8874 answer, assuming that each successive pill doubles his speed.
8876 @smallexample
8877 @group
8878 1:  19360.       2:  19360.       1:  14.24
8879     .            1:  2                .
8880                      .
8882     u s              2                B
8883 @end group
8884 @end smallexample
8886 @noindent
8887 Thus Sam can take up to 14 pills without a worry.
8889 @node Algebra Answer 1, Algebra Answer 2, Types Answer 15, Answers to Exercises
8890 @subsection Algebra Tutorial Exercise 1
8892 @noindent
8893 @c [fix-ref Declarations]
8894 The result @samp{sqrt(x)^2} is simplified back to @expr{x} by the
8895 Calculator, but @samp{sqrt(x^2)} is not.  (Consider what happens
8896 if @w{@expr{x = -4}}.)  If @expr{x} is real, this formula could be
8897 simplified to @samp{abs(x)}, but for general complex arguments even
8898 that is not safe.  (@xref{Declarations}, for a way to tell Calc
8899 that @expr{x} is known to be real.)
8901 @node Algebra Answer 2, Algebra Answer 3, Algebra Answer 1, Answers to Exercises
8902 @subsection Algebra Tutorial Exercise 2
8904 @noindent
8905 Suppose our roots are @expr{[a, b, c]}.  We want a polynomial which
8906 is 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)}
8908 will do the job.  We can use @kbd{a c x} to write this in a more
8909 familiar form.
8911 @smallexample
8912 @group
8913 1:  34 x - 24 x^3          1:  [1.19023, -1.19023, 0]
8914     .                          .
8916     r 2                        a P x @key{RET}
8918 @end group
8919 @end smallexample
8920 @noindent
8921 @smallexample
8922 @group
8923 1:  [x - 1.19023, x + 1.19023, x]     1:  (x - 1.19023) (x + 1.19023) x
8924     .                                     .
8926     V M ' x-$ @key{RET}                         V R *
8928 @end group
8929 @end smallexample
8930 @noindent
8931 @smallexample
8932 @group
8933 1:  x^3 - 1.41666 x        1:  34 x - 24 x^3
8934     .                          .
8936     a c x @key{RET}                  24 n *  a x
8937 @end group
8938 @end smallexample
8940 @noindent
8941 Sure enough, our answer (multiplied by a suitable constant) is the
8942 same as the original polynomial.
8944 @node Algebra Answer 3, Algebra Answer 4, Algebra Answer 2, Answers to Exercises
8945 @subsection Algebra Tutorial Exercise 3
8947 @smallexample
8948 @group
8949 1:  x sin(pi x)         1:  (sin(pi x) - pi x cos(pi x)) / pi^2
8950     .                       .
8952   ' x sin(pi x) @key{RET}   m r   a i x @key{RET}
8954 @end group
8955 @end smallexample
8956 @noindent
8957 @smallexample
8958 @group
8959 1:  [y, 1]
8960 2:  (sin(pi x) - pi x cos(pi x)) / pi^2
8961     .
8963   ' [y,1] @key{RET} @key{TAB}
8965 @end group
8966 @end smallexample
8967 @noindent
8968 @smallexample
8969 @group
8970 1:  [(sin(pi y) - pi y cos(pi y)) / pi^2, (sin(pi) - pi cos(pi)) / pi^2]
8971     .
8973     V M $ @key{RET}
8975 @end group
8976 @end smallexample
8977 @noindent
8978 @smallexample
8979 @group
8980 1:  (sin(pi y) - pi y cos(pi y)) / pi^2 + (pi cos(pi) - sin(pi)) / pi^2
8981     .
8983     V R -
8985 @end group
8986 @end smallexample
8987 @noindent
8988 @smallexample
8989 @group
8990 1:  (sin(3.14159 y) - 3.14159 y cos(3.14159 y)) / 9.8696 - 0.3183
8991     .
8993     =
8995 @end group
8996 @end smallexample
8997 @noindent
8998 @smallexample
8999 @group
9000 1:  [0., -0.95493, 0.63662, -1.5915, 1.2732]
9001     .
9003     v x 5 @key{RET}  @key{TAB}  V M $ @key{RET}
9004 @end group
9005 @end smallexample
9007 @node Algebra Answer 4, Rewrites Answer 1, Algebra Answer 3, Answers to Exercises
9008 @subsection Algebra Tutorial Exercise 4
9010 @noindent
9011 The hard part is that @kbd{V R +} is no longer sufficient to add up all
9012 the contributions from the slices, since the slices have varying
9013 coefficients.  So first we must come up with a vector of these
9014 coefficients.  Here's one way:
9016 @smallexample
9017 @group
9018 2:  -1                 2:  3                    1:  [4, 2, ..., 4]
9019 1:  [1, 2, ..., 9]     1:  [-1, 1, ..., -1]         .
9020     .                      .
9022     1 n v x 9 @key{RET}          V M ^  3 @key{TAB}             -
9024 @end group
9025 @end smallexample
9026 @noindent
9027 @smallexample
9028 @group
9029 1:  [4, 2, ..., 4, 1]      1:  [1, 4, 2, ..., 4, 1]
9030     .                          .
9032     1 |                        1 @key{TAB} |
9033 @end group
9034 @end smallexample
9036 @noindent
9037 Now we compute the function values.  Note that for this method we need
9038 eleven values, including both endpoints of the desired interval.
9040 @smallexample
9041 @group
9042 2:  [1, 4, 2, ..., 4, 1]
9043 1:  [1, 1.1, 1.2,  ...  , 1.8, 1.9, 2.]
9044     .
9046  11 @key{RET} 1 @key{RET} .1 @key{RET}  C-u v x
9048 @end group
9049 @end smallexample
9050 @noindent
9051 @smallexample
9052 @group
9053 2:  [1, 4, 2, ..., 4, 1]
9054 1:  [0., 0.084941, 0.16993, ... ]
9055     .
9057     ' sin(x) ln(x) @key{RET}   m r  p 5 @key{RET}   V M $ @key{RET}
9058 @end group
9059 @end smallexample
9061 @noindent
9062 Once again this calls for @kbd{V M * V R +}; a simple @kbd{*} does the
9063 same thing.
9065 @smallexample
9066 @group
9067 1:  11.22      1:  1.122      1:  0.374
9068     .              .              .
9070     *              .1 *           3 /
9071 @end group
9072 @end smallexample
9074 @noindent
9075 Wow!  That's even better than the result from the Taylor series method.
9077 @node Rewrites Answer 1, Rewrites Answer 2, Algebra Answer 4, Answers to Exercises
9078 @subsection Rewrites Tutorial Exercise 1
9080 @noindent
9081 We'll use Big mode to make the formulas more readable.
9083 @smallexample
9084 @group
9085                                                ___
9086                                           2 + V 2
9087 1:  (2 + sqrt(2)) / (1 + sqrt(2))     1:  --------
9088     .                                          ___
9089                                           1 + V 2
9091                                           .
9093   ' (2+sqrt(2)) / (1+sqrt(2)) @key{RET}         d B
9094 @end group
9095 @end smallexample
9097 @noindent
9098 Multiplying by the conjugate helps because @expr{(a+b) (a-b) = a^2 - b^2}.
9100 @smallexample
9101 @group
9102           ___    ___
9103 1:  (2 + V 2 ) (V 2  - 1)
9104     .
9106   a r a/(b+c) := a*(b-c) / (b^2-c^2) @key{RET}
9108 @end group
9109 @end smallexample
9110 @noindent
9111 @smallexample
9112 @group
9113          ___                         ___
9114 1:  2 + V 2  - 2                1:  V 2
9115     .                               .
9117   a r a*(b+c) := a*b + a*c          a s
9118 @end group
9119 @end smallexample
9121 @noindent
9122 (We could have used @kbd{a x} instead of a rewrite rule for the
9123 second step.)
9125 The multiply-by-conjugate rule turns out to be useful in many
9126 different circumstances, such as when the denominator involves
9127 sines and cosines or the imaginary constant @code{i}.
9129 @node Rewrites Answer 2, Rewrites Answer 3, Rewrites Answer 1, Answers to Exercises
9130 @subsection Rewrites Tutorial Exercise 2
9132 @noindent
9133 Here is the rule set:
9135 @smallexample
9136 @group
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) ]
9140 @end group
9141 @end smallexample
9143 @noindent
9144 The first rule turns a one-argument @code{fib} that people like to write
9145 into a three-argument @code{fib} that makes computation easier.  The
9146 second rule converts back from three-argument form once the computation
9147 is done.  The third rule does the computation itself.  It basically
9148 says that if @expr{x} and @expr{y} are two consecutive Fibonacci numbers,
9149 then @expr{y} and @expr{x+y} are the next (overlapping) pair of Fibonacci
9150 numbers.
9152 Notice that because the number @expr{n} was ``validated'' by the
9153 conditions on the first rule, there is no need to put conditions on
9154 the other rules because the rule set would never get that far unless
9155 the input were valid.  That further speeds computation, since no
9156 extra conditions need to be checked at every step.
9158 Actually, a user with a nasty sense of humor could enter a bad
9159 three-argument @code{fib} call directly, say, @samp{fib(0, 1, 1)},
9160 which would get the rules into an infinite loop.  One thing that would
9161 help 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
9163 function.
9165 @node Rewrites Answer 3, Rewrites Answer 4, Rewrites Answer 2, Answers to Exercises
9166 @subsection Rewrites Tutorial Exercise 3
9168 @noindent
9169 He 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
9171 apply 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, ...)}
9174 around that, and so on, ad infinitum.  Joe should have used @kbd{M-1 a r}
9175 to make sure the rule applied only once.
9177 (Actually, even the first step didn't work as he expected.  What Calc
9178 really gives for @kbd{M-1 a r} in this situation is @samp{f(3 x, 1, 2)},
9179 treating 2 as the ``variable,'' and @samp{3 x} as a constant being added
9180 to 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)}
9184 on the lefthand side, so that the rule matches the actual variable
9185 @samp{x} rather than letting @samp{x} stand for something else.)
9187 @node Rewrites Answer 4, Rewrites Answer 5, Rewrites Answer 3, Answers to Exercises
9188 @subsection Rewrites Tutorial Exercise 4
9190 @noindent
9191 @ignore
9192 @starindex
9193 @end ignore
9194 @tindex seq
9195 Here is a suitable set of rules to solve the first part of the problem:
9197 @smallexample
9198 @group
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 ]
9201 @end group
9202 @end smallexample
9204 Given the initial formula @samp{seq(6, 0)}, application of these
9205 rules produces the following sequence of formulas:
9207 @example
9208 seq( 3, 1)
9209 seq(10, 2)
9210 seq( 5, 3)
9211 seq(16, 4)
9212 seq( 8, 5)
9213 seq( 4, 6)
9214 seq( 2, 7)
9215 seq( 1, 8)
9216 @end example
9218 @noindent
9219 whereupon neither of the rules match, and rewriting stops.
9221 We can pretty this up a bit with a couple more rules:
9223 @smallexample
9224 @group
9225 [ seq(n) := seq(n, 0),
9226   seq(1, c) := c,
9227   ... ]
9228 @end group
9229 @end smallexample
9231 @noindent
9232 Now, given @samp{seq(6)} as the starting configuration, we get 8
9233 as the result.
9235 The change to return a vector is quite simple:
9237 @smallexample
9238 @group
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 ]
9243 @end group
9244 @end smallexample
9246 @noindent
9247 Given @samp{seq(6)}, the result is @samp{[6, 3, 10, 5, 16, 8, 4, 2, 1]}.
9249 Notice that the @expr{n > 1} guard is no longer necessary on the last
9250 rule since the @expr{n = 1} case is now detected by another rule.
9251 But a guard has been added to the initial rule to make sure the
9252 initial value is suitable before the computation begins.
9254 While still a good idea, this guard is not as vitally important as it
9255 was for the @code{fib} function, since calling, say, @samp{seq(x, [])}
9256 will not get into an infinite loop.  Calc will not be able to prove
9257 the symbol @samp{x} is either even or odd, so none of the rules will
9258 apply and the rewrites will stop right away.
9260 @node Rewrites Answer 5, Rewrites Answer 6, Rewrites Answer 4, Answers to Exercises
9261 @subsection Rewrites Tutorial Exercise 5
9263 @noindent
9264 @ignore
9265 @starindex
9266 @end ignore
9267 @tindex nterms
9268 If @expr{x} is the sum @expr{a + b}, then `@tfn{nterms(}@var{x}@tfn{)}' must
9269 be `@tfn{nterms(}@var{a}@tfn{)}' plus `@tfn{nterms(}@var{b}@tfn{)}'.  If @expr{x}
9270 is not a sum, then `@tfn{nterms(}@var{x}@tfn{)}' = 1.
9272 @smallexample
9273 @group
9274 [ nterms(a + b) := nterms(a) + nterms(b),
9275   nterms(x)     := 1 ]
9276 @end group
9277 @end smallexample
9279 @noindent
9280 Here we have taken advantage of the fact that earlier rules always
9281 match before later rules; @samp{nterms(x)} will only be tried if we
9282 already know that @samp{x} is not a sum.
9284 @node Rewrites Answer 6, Programming Answer 1, Rewrites Answer 5, Answers to Exercises
9285 @subsection Rewrites Tutorial Exercise 6
9287 @noindent
9288 Here is a rule set that will do the job:
9290 @smallexample
9291 @group
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)) ]
9300 @end group
9301 @end smallexample
9303 If we really want the @kbd{+} and @kbd{*} keys to operate naturally
9304 on power series, we should put these rules in @code{EvalRules}.  For
9305 testing purposes, it is better to put them in a different variable,
9306 say, @code{O}, first.
9308 The first rule just expands products of sums so that the rest of the
9309 rules can assume they have an expanded-out polynomial to work with.
9310 Note that this rule does not mention @samp{O} at all, so it will
9311 apply to any product-of-sum it encounters---this rule may surprise
9312 you if you put it into @code{EvalRules}!
9314 In the second rule, the sum of two O's is changed to the smaller O.
9315 The 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
9317 as well as @samp{O(x^2) + O(x^3)}.
9319 The third rule absorbs higher powers of @samp{x} into O's.
9321 The fourth rule says that a constant times a negligible quantity
9322 is still negligible.  (This rule will also match @samp{O(x^3) / 4},
9323 with @samp{a = 1/4}.)
9325 The 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
9327 is, 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}
9329 but not 1 as @samp{x^0}.  This turns out to be exactly what we want here.
9331 The sixth rule is the corresponding rule for products of two O's.
9333 Another way to solve this problem would be to create a new ``data type''
9334 that represents truncated power series.  We might represent these as
9335 function calls @samp{series(@var{coefs}, @var{x})} where @var{coefs} is
9336 a vector of coefficients for @expr{x^0}, @expr{x^1}, @expr{x^2}, and so
9337 on.  Rules would exist for sums and products of such @code{series}
9338 objects, 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
9340 rule that rewrites @samp{O(x^n)} to the equivalent @code{series} form,
9341 you could still enter power series in exactly the same notation as
9342 before.)  Operations on such objects would probably be more efficient,
9343 although the objects would be a bit harder to read.
9345 @c [fix-ref Compositions]
9346 Some other symbolic math programs provide a power series data type
9347 similar to this.  Mathematica, for example, has an object that looks
9348 like @samp{PowerSeries[@var{x}, @var{x0}, @var{coefs}, @var{nmin},
9349 @var{nmax}, @var{den}]}, where @var{x0} is the point about which the
9350 power series is taken (we've been assuming this was always zero),
9351 and @var{nmin}, @var{nmax}, and @var{den} allow pseudo-power-series
9352 with fractional or negative powers.  Also, the @code{PowerSeries}
9353 objects 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},
9355 for a way to do this in Calc, although for something as involved as
9356 this it would probably be better to write the formatting routine
9357 in Lisp.)
9359 @node Programming Answer 1, Programming Answer 2, Rewrites Answer 6, Answers to Exercises
9360 @subsection Programming Tutorial Exercise 1
9362 @noindent
9363 Just 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
9365 variables, the default argument list will be @samp{(t x)}.  We want to
9366 change this to @samp{(x)} since @expr{t} is really a dummy variable
9367 to be used within @code{ninteg}.
9369 The 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.)
9372 @node Programming Answer 2, Programming Answer 3, Programming Answer 1, Answers to Exercises
9373 @subsection Programming Tutorial Exercise 2
9375 @noindent
9376 One way is to move the number to the top of the stack, operate on
9377 it, then move it back:  @kbd{C-x ( M-@key{TAB} n M-@key{TAB} M-@key{TAB} C-x )}.
9379 Another way is to negate the top three stack entries, then negate
9380 again the top two stack entries:  @kbd{C-x ( M-3 n M-2 n C-x )}.
9382 Finally, it turns out that a negative prefix argument causes a
9383 command like @kbd{n} to operate on the specified stack entry only,
9384 which is just what we want:  @kbd{C-x ( M-- 3 n C-x )}.
9386 Just for kicks, let's also do it algebraically:
9387 @w{@kbd{C-x ( ' -$$$, $$, $ @key{RET} C-x )}}.
9389 @node Programming Answer 3, Programming Answer 4, Programming Answer 2, Answers to Exercises
9390 @subsection Programming Tutorial Exercise 3
9392 @noindent
9393 Each of these functions can be computed using the stack, or using
9394 algebraic entry, whichever way you prefer:
9396 @noindent
9397 Computing 
9398 @texline @math{\displaystyle{\sin x \over x}}:
9399 @infoline @expr{sin(x) / x}:
9401 Using the stack:  @kbd{C-x (  @key{RET} S @key{TAB} /  C-x )}.
9403 Using algebraic entry:  @kbd{C-x (  ' sin($)/$ @key{RET}  C-x )}.
9405 @noindent
9406 Computing the logarithm:
9408 Using the stack:  @kbd{C-x (  @key{TAB} B  C-x )}
9410 Using algebraic entry:  @kbd{C-x (  ' log($,$$) @key{RET}  C-x )}.
9412 @noindent
9413 Computing the vector of integers:
9415 Using the stack:  @kbd{C-x (  1 @key{RET} 1  C-u v x  C-x )}.  (Recall that
9416 @kbd{C-u v x} takes the vector size, starting value, and increment
9417 from the stack.)
9419 Alternatively:  @kbd{C-x (  ~ v x  C-x )}.  (The @kbd{~} key pops a
9420 number from the stack and uses it as the prefix argument for the
9421 next command.)
9423 Using algebraic entry:  @kbd{C-x (  ' index($) @key{RET}  C-x )}.
9425 @node Programming Answer 4, Programming Answer 5, Programming Answer 3, Answers to Exercises
9426 @subsection Programming Tutorial Exercise 4
9428 @noindent
9429 Here's one way:  @kbd{C-x ( @key{RET} V R + @key{TAB} v l / C-x )}.
9431 @node Programming Answer 5, Programming Answer 6, Programming Answer 4, Answers to Exercises
9432 @subsection Programming Tutorial Exercise 5
9434 @smallexample
9435 @group
9436 2:  1              1:  1.61803398502         2:  1.61803398502
9437 1:  20                 .                     1:  1.61803398875
9438     .                                            .
9440    1 @key{RET} 20         Z < & 1 + Z >                I H P
9441 @end group
9442 @end smallexample
9444 @noindent
9445 This answer is quite accurate.
9447 @node Programming Answer 6, Programming Answer 7, Programming Answer 5, Answers to Exercises
9448 @subsection Programming Tutorial Exercise 6
9450 @noindent
9451 Here is the matrix:
9453 @example
9454 [ [ 0, 1 ]   * [a, b] = [b, a + b]
9455   [ 1, 1 ] ]
9456 @end example
9458 @noindent
9459 Thus @samp{[0, 1; 1, 1]^n * [1, 1]} computes Fibonacci numbers @expr{n+1}
9460 and @expr{n+2}.  Here's one program that does the job:
9462 @example
9463 C-x ( ' [0, 1; 1, 1] ^ ($-1) * [1, 1] @key{RET} v u @key{DEL} C-x )
9464 @end example
9466 @noindent
9467 This program is quite efficient because Calc knows how to raise a
9468 matrix (or other value) to the power @expr{n} in only 
9469 @texline @math{\log_2 n}
9470 @infoline @expr{log(n,2)}
9471 steps.  For example, this program can compute the 1000th Fibonacci
9472 number (a 209-digit integer!) in about 10 steps; even though the
9473 @kbd{Z < ... Z >} solution had much simpler steps, it would have
9474 required so many steps that it would not have been practical.
9476 @node Programming Answer 7, Programming Answer 8, Programming Answer 6, Answers to Exercises
9477 @subsection Programming Tutorial Exercise 7
9479 @noindent
9480 The trick here is to compute the harmonic numbers differently, so that
9481 the loop counter itself accumulates the sum of reciprocals.  We use
9482 a separate variable to hold the integer counter.
9484 @smallexample
9485 @group
9486 1:  1          2:  1       1:  .
9487     .          1:  4
9488                    .
9490     1 t 1       1 @key{RET} 4      Z ( t 2 r 1 1 + s 1 & Z )
9491 @end group
9492 @end smallexample
9494 @noindent
9495 The body of the loop goes as follows:  First save the harmonic sum
9496 so far in variable 2.  Then delete it from the stack; the for loop
9497 itself will take care of remembering it for us.  Next, recall the
9498 count from variable 1, add one to it, and feed its reciprocal to
9499 the for loop to use as the step value.  The for loop will increase
9500 the ``loop counter'' by that amount and keep going until the
9501 loop counter exceeds 4.
9503 @smallexample
9504 @group
9505 2:  31                  3:  31
9506 1:  3.99498713092       2:  3.99498713092
9507     .                   1:  4.02724519544
9508                             .
9510     r 1 r 2                 @key{RET} 31 & +
9511 @end group
9512 @end smallexample
9514 Thus we find that the 30th harmonic number is 3.99, and the 31st
9515 harmonic number is 4.02.
9517 @node Programming Answer 8, Programming Answer 9, Programming Answer 7, Answers to Exercises
9518 @subsection Programming Tutorial Exercise 8
9520 @noindent
9521 The first step is to compute the derivative @expr{f'(x)} and thus
9522 the formula 
9523 @texline @math{\displaystyle{x - {f(x) \over f'(x)}}}.
9524 @infoline @expr{x - f(x)/f'(x)}.
9526 (Because this definition is long, it will be repeated in concise form
9527 below.  You can use @w{@kbd{M-# m}} to load it from there.  While you are
9528 entering a @kbd{Z ` Z '} body in a macro, Calc simply collects
9529 keystrokes without executing them.  In the following diagrams we'll
9530 pretend Calc actually executed the keystrokes as you typed them,
9531 just for purposes of illustration.)
9533 @smallexample
9534 @group
9535 2:  sin(cos(x)) - 0.5            3:  4.5
9536 1:  4.5                          2:  sin(cos(x)) - 0.5
9537     .                            1:  -(sin(x) cos(cos(x)))
9538                                      .
9540 ' sin(cos(x))-0.5 @key{RET} 4.5  m r  C-x ( Z `  @key{TAB} @key{RET} a d x @key{RET}
9542 @end group
9543 @end smallexample
9544 @noindent
9545 @smallexample
9546 @group
9547 2:  4.5
9548 1:  x + (sin(cos(x)) - 0.5) / sin(x) cos(cos(x))
9549     .
9551     /  ' x @key{RET} @key{TAB} -   t 1
9552 @end group
9553 @end smallexample
9555 Now, we enter the loop.  We'll use a repeat loop with a 20-repetition
9556 limit 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
9558 repetitions are done.)
9560 @smallexample
9561 @group
9562 1:  4.5         3:  4.5                     2:  4.5
9563     .           2:  x + (sin(cos(x)) ...    1:  5.24196456928
9564                 1:  4.5                         .
9565                     .
9567   20 Z <          @key{RET} r 1 @key{TAB}                 s l x @key{RET}
9568 @end group
9569 @end smallexample
9571 This is the new guess for @expr{x}.  Now we compare it with the
9572 old one to see if we've converged.
9574 @smallexample
9575 @group
9576 3:  5.24196     2:  5.24196     1:  5.24196     1:  5.26345856348
9577 2:  5.24196     1:  0               .               .
9578 1:  4.5             .
9579     .
9581   @key{RET} M-@key{TAB}         a =             Z /             Z > Z ' C-x )
9582 @end group
9583 @end smallexample
9585 The loop converges in just a few steps to this value.  To check
9586 the result, we can simply substitute it back into the equation.
9588 @smallexample
9589 @group
9590 2:  5.26345856348
9591 1:  0.499999999997
9592     .
9594  @key{RET} ' sin(cos($)) @key{RET}
9595 @end group
9596 @end smallexample
9598 Let's test the new definition again:
9600 @smallexample
9601 @group
9602 2:  x^2 - 9           1:  3.
9603 1:  1                     .
9604     .
9606   ' x^2-9 @key{RET} 1           X
9607 @end group
9608 @end smallexample
9610 Once again, here's the full Newton's Method definition:
9612 @example
9613 @group
9614 C-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 /
9617               Z >
9618       Z '
9619 C-x )
9620 @end group
9621 @end example
9623 @c [fix-ref Nesting and Fixed Points]
9624 It turns out that Calc has a built-in command for applying a formula
9625 repeatedly until it converges to a number.  @xref{Nesting and Fixed Points},
9626 to see how to use it.
9628 @c [fix-ref Root Finding]
9629 Also, of course, @kbd{a R} is a built-in command that uses Newton's
9630 method (among others) to look for numerical solutions to any equation.
9631 @xref{Root Finding}.
9633 @node Programming Answer 9, Programming Answer 10, Programming Answer 8, Answers to Exercises
9634 @subsection Programming Tutorial Exercise 9
9636 @noindent
9637 The 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
9639 reduce the problem using 
9640 @texline @math{\psi(z) = \psi(z+1) - 1/z}.
9641 @infoline @expr{psi(z) = psi(z+1) - 1/z}.  We go
9642 on to compute 
9643 @texline @math{\psi(z+1)},
9644 @infoline @expr{psi(z+1)}, 
9645 and remember to add back a factor of @expr{-1/z} when we're done.  This
9646 step is repeated until @expr{z > 5}.
9648 (Because this definition is long, it will be repeated in concise form
9649 below.  You can use @w{@kbd{M-# m}} to load it from there.  While you are
9650 entering a @kbd{Z ` Z '} body in a macro, Calc simply collects
9651 keystrokes without executing them.  In the following diagrams we'll
9652 pretend Calc actually executed the keystrokes as you typed them,
9653 just for purposes of illustration.)
9655 @smallexample
9656 @group
9657 1:  1.             1:  1.
9658     .                  .
9660  1.0 @key{RET}       C-x ( Z `  s 1  0 t 2
9661 @end group
9662 @end smallexample
9664 Here, variable 1 holds @expr{z} and variable 2 holds the adjustment
9665 factor.  If @expr{z < 5}, we use a loop to increase it.
9667 (By the way, we started with @samp{1.0} instead of the integer 1 because
9668 otherwise the calculation below will try to do exact fractional arithmetic,
9669 and will never converge because fractions compare equal only if they
9670 are exactly equal, not just equal to within the current precision.)
9672 @smallexample
9673 @group
9674 3:  1.      2:  1.       1:  6.
9675 2:  1.      1:  1            .
9676 1:  5           .
9677     .
9679   @key{RET} 5        a <    Z [  5 Z (  & s + 2  1 s + 1  1 Z ) r 1  Z ]
9680 @end group
9681 @end smallexample
9683 Now we compute the initial part of the sum:  
9684 @texline @math{\ln z - {1 \over 2z}}
9685 @infoline @expr{ln(z) - 1/2z}
9686 minus the adjustment factor.
9688 @smallexample
9689 @group
9690 2:  1.79175946923      2:  1.7084261359      1:  -0.57490719743
9691 1:  0.0833333333333    1:  2.28333333333         .
9692     .                      .
9694     L  r 1 2 * &           -  r 2                -
9695 @end group
9696 @end smallexample
9698 Now we evaluate the series.  We'll use another ``for'' loop counting
9699 up the value of @expr{2 n}.  (Calc does have a summation command,
9700 @kbd{a +}, but we'll use loops just to get more practice with them.)
9702 @smallexample
9703 @group
9704 3:  -0.5749       3:  -0.5749        4:  -0.5749      2:  -0.5749
9705 2:  2             2:  1:6            3:  1:6          1:  2.3148e-3
9706 1:  40            1:  2              2:  2                .
9707     .                 .              1:  36.
9708                                          .
9710    2 @key{RET} 40        Z ( @key{RET} k b @key{TAB}     @key{RET} r 1 @key{TAB} ^      * /
9712 @end group
9713 @end smallexample
9714 @noindent
9715 @smallexample
9716 @group
9717 3:  -0.5749       3:  -0.5772      2:  -0.5772     1:  -0.577215664892
9718 2:  -0.5749       2:  -0.5772      1:  0               .
9719 1:  2.3148e-3     1:  -0.5749          .
9720     .                 .
9722   @key{TAB} @key{RET} M-@key{TAB}       - @key{RET} M-@key{TAB}      a =     Z /    2  Z )  Z ' C-x )
9723 @end group
9724 @end smallexample
9726 This is the value of 
9727 @texline @math{-\gamma},
9728 @infoline @expr{- gamma}, 
9729 with a slight bit of roundoff error.  To get a full 12 digits, let's use
9730 a higher precision:
9732 @smallexample
9733 @group
9734 2:  -0.577215664892      2:  -0.577215664892
9735 1:  1.                   1:  -0.577215664901532
9737     1. @key{RET}                   p 16 @key{RET} X
9738 @end group
9739 @end smallexample
9741 Here's the complete sequence of keystrokes:
9743 @example
9744 @group
9745 C-x ( Z `  s 1  0 t 2
9746            @key{RET} 5 a <  Z [  5 Z (  & s + 2  1 s + 1  1 Z ) r 1  Z ]
9747            L r 1 2 * & - r 2 -
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 /
9750                   2  Z )
9751       Z '
9752 C-x )
9753 @end group
9754 @end example
9756 @node Programming Answer 10, Programming Answer 11, Programming Answer 9, Answers to Exercises
9757 @subsection Programming Tutorial Exercise 10
9759 @noindent
9760 Taking the derivative of a term of the form @expr{x^n} will produce
9761 a term like 
9762 @texline @math{n x^{n-1}}.
9763 @infoline @expr{n x^(n-1)}.  
9764 Taking the derivative of a constant
9765 produces zero.  From this it is easy to see that the @expr{n}th
9766 derivative of a polynomial, evaluated at @expr{x = 0}, will equal the
9767 coefficient on the @expr{x^n} term times @expr{n!}.
9769 (Because this definition is long, it will be repeated in concise form
9770 below.  You can use @w{@kbd{M-# m}} to load it from there.  While you are
9771 entering a @kbd{Z ` Z '} body in a macro, Calc simply collects
9772 keystrokes without executing them.  In the following diagrams we'll
9773 pretend Calc actually executed the keystrokes as you typed them,
9774 just for purposes of illustration.)
9776 @smallexample
9777 @group
9778 2:  5 x^4 + (x + 1)^2          3:  5 x^4 + (x + 1)^2
9779 1:  6                          2:  0
9780     .                          1:  6
9781                                    .
9783   ' 5 x^4 + (x+1)^2 @key{RET} 6        C-x ( Z `  [ ] t 1  0 @key{TAB}
9784 @end group
9785 @end smallexample
9787 @noindent
9788 Variable 1 will accumulate the vector of coefficients.
9790 @smallexample
9791 @group
9792 2:  0              3:  0                  2:  5 x^4 + ...
9793 1:  5 x^4 + ...    2:  5 x^4 + ...        1:  1
9794     .              1:  1                      .
9795                        .
9797    Z ( @key{TAB}         @key{RET} 0 s l x @key{RET}            M-@key{TAB} ! /  s | 1
9798 @end group
9799 @end smallexample
9801 @noindent
9802 Note that @kbd{s | 1} appends the top-of-stack value to the vector
9803 in a variable; it is completely analogous to @kbd{s + 1}.  We could
9804 have written instead, @kbd{r 1 @key{TAB} | t 1}.
9806 @smallexample
9807 @group
9808 1:  20 x^3 + 2 x + 2      1:  0         1:  [1, 2, 1, 0, 5, 0, 0]
9809     .                         .             .
9811     a d x @key{RET}                 1 Z )         @key{DEL} r 1  Z ' C-x )
9812 @end group
9813 @end smallexample
9815 To convert back, a simple method is just to map the coefficients
9816 against a table of powers of @expr{x}.
9818 @smallexample
9819 @group
9820 2:  [1, 2, 1, 0, 5, 0, 0]    2:  [1, 2, 1, 0, 5, 0, 0]
9821 1:  6                        1:  [0, 1, 2, 3, 4, 5, 6]
9822     .                            .
9824     6 @key{RET}                        1 + 0 @key{RET} 1 C-u v x
9826 @end group
9827 @end smallexample
9828 @noindent
9829 @smallexample
9830 @group
9831 2:  [1, 2, 1, 0, 5, 0, 0]    2:  1 + 2 x + x^2 + 5 x^4
9832 1:  [1, x, x^2, x^3, ... ]       .
9833     .
9835     ' x @key{RET} @key{TAB} V M ^            *
9836 @end group
9837 @end smallexample
9839 Once again, here are the whole polynomial to/from vector programs:
9841 @example
9842 @group
9843 C-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}
9846          1 Z ) r 1
9847       Z '
9848 C-x )
9850 C-x (  1 + 0 @key{RET} 1 C-u v x ' x @key{RET} @key{TAB} V M ^ *  C-x )
9851 @end group
9852 @end example
9854 @node Programming Answer 11, Programming Answer 12, Programming Answer 10, Answers to Exercises
9855 @subsection Programming Tutorial Exercise 11
9857 @noindent
9858 First 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
9860 return one number, so @key{DEL} as a dummy definition will make
9861 sure the stack comes out right.
9863 @smallexample
9864 @group
9865 2:  4          1:  4                         2:  4
9866 1:  2              .                         1:  2
9867     .                                            .
9869   4 @key{RET} 2       C-x ( @key{DEL} C-x )  Z K s @key{RET}       2
9870 @end group
9871 @end smallexample
9873 The last step replaces the 2 that was eaten during the creation
9874 of the dummy @kbd{z s} command.  Now we move on to the real
9875 definition.  The recurrence needs to be rewritten slightly,
9876 to the form @expr{s(n,m) = s(n-1,m-1) - (n-1) s(n-1,m)}.
9878 (Because this definition is long, it will be repeated in concise form
9879 below.  You can use @kbd{M-# m} to load it from there.)
9881 @smallexample
9882 @group
9883 2:  4        4:  4       3:  4       2:  4
9884 1:  2        3:  2       2:  2       1:  2
9885     .        2:  4       1:  0           .
9886              1:  2           .
9887                  .
9889   C-x (       M-2 @key{RET}        a =         Z [  @key{DEL} @key{DEL} 1  Z :
9891 @end group
9892 @end smallexample
9893 @noindent
9894 @smallexample
9895 @group
9896 4:  4       2:  4                     2:  3      4:  3    4:  3    3:  3
9897 3:  2       1:  2                     1:  2      3:  2    3:  2    2:  2
9898 2:  2           .                         .      2:  3    2:  3    1:  3
9899 1:  0                                            1:  2    1:  1        .
9900     .                                                .        .
9902   @key{RET} 0   a = Z [  @key{DEL} @key{DEL} 0  Z :  @key{TAB} 1 - @key{TAB}   M-2 @key{RET}     1 -      z s
9903 @end group
9904 @end smallexample
9906 @noindent
9907 (Note that the value 3 that our dummy @kbd{z s} produces is not correct;
9908 it is merely a placeholder that will do just as well for now.)
9910 @smallexample
9911 @group
9912 3:  3               4:  3           3:  3       2:  3      1:  -6
9913 2:  3               3:  3           2:  3       1:  9          .
9914 1:  2               2:  3           1:  3           .
9915     .               1:  2               .
9916                         .
9918  M-@key{TAB} M-@key{TAB}     @key{TAB} @key{RET} M-@key{TAB}         z s          *          -
9920 @end group
9921 @end smallexample
9922 @noindent
9923 @smallexample
9924 @group
9925 1:  -6                          2:  4          1:  11      2:  11
9926     .                           1:  2              .       1:  11
9927                                     .                          .
9929   Z ] Z ] C-x )   Z K s @key{RET}      @key{DEL} 4 @key{RET} 2       z s      M-@key{RET} k s
9930 @end group
9931 @end smallexample
9933 Even though the result that we got during the definition was highly
9934 bogus, once the definition is complete the @kbd{z s} command gets
9935 the right answers.
9937 Here's the full program once again:
9939 @example
9940 @group
9941 C-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 * -
9947             Z ]
9948        Z ]
9949 C-x )
9950 @end group
9951 @end example
9953 You can read this definition using @kbd{M-# m} (@code{read-kbd-macro})
9954 followed by @kbd{Z K s}, without having to make a dummy definition
9955 first, because @code{read-kbd-macro} doesn't need to execute the
9956 definition as it reads it in.  For this reason, @code{M-# m} is often
9957 the easiest way to create recursive programs in Calc.
9959 @node Programming Answer 12, , Programming Answer 11, Answers to Exercises
9960 @subsection Programming Tutorial Exercise 12
9962 @noindent
9963 This turns out to be a much easier way to solve the problem.  Let's
9964 denote Stirling numbers as calls of the function @samp{s}.
9966 First, we store the rewrite rules corresponding to the definition of
9967 Stirling numbers in a convenient variable:
9969 @smallexample
9970 s e StirlingRules @key{RET}
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 ]
9974 C-c C-c
9975 @end smallexample
9977 Now, it's just a matter of applying the rules:
9979 @smallexample
9980 @group
9981 2:  4          1:  s(4, 2)              1:  11
9982 1:  2              .                        .
9983     .
9985   4 @key{RET} 2       C-x (  ' s($$,$) @key{RET}     a r StirlingRules @key{RET}  C-x )
9986 @end group
9987 @end smallexample
9989 As in the case of the @code{fib} rules, it would be useful to put these
9990 rules in @code{EvalRules} and to add a @samp{:: remember} condition to
9991 the last rule.
9993 @c This ends the table-of-contents kludge from above:
9994 @tex
9995 \global\let\chapternofonts=\oldchapternofonts
9996 @end tex
9998 @c [reference]
10000 @node Introduction, Data Types, Tutorial, Top
10001 @chapter Introduction
10003 @noindent
10004 This chapter is the beginning of the Calc reference manual.
10005 It covers basic concepts such as the stack, algebraic and
10006 numeric entry, undo, numeric prefix arguments, etc.
10008 @c [when-split]
10009 @c (Chapter 2, the Tutorial, has been printed in a separate volume.)
10011 @menu
10012 * Basic Commands::
10013 * Help Commands::
10014 * Stack Basics::
10015 * Numeric Entry::
10016 * Algebraic Entry::
10017 * Quick Calculator::
10018 * Prefix Arguments::
10019 * Undo::
10020 * Error Messages::
10021 * Multiple Calculators::
10022 * Troubleshooting Commands::
10023 @end menu
10025 @node Basic Commands, Help Commands, Introduction, Introduction
10026 @section Basic Commands
10028 @noindent
10029 @pindex calc
10030 @pindex calc-mode
10031 @cindex Starting the Calculator
10032 @cindex Running the Calculator
10033 To start the Calculator in its standard interface, type @kbd{M-x calc}.
10034 By default this creates a pair of small windows, @samp{*Calculator*}
10035 and @samp{*Calc Trail*}.  The former displays the contents of the
10036 Calculator stack and is manipulated exclusively through Calc commands.
10037 It is possible (though not usually necessary) to create several Calc
10038 mode buffers each of which has an independent stack, undo list, and
10039 mode settings.  There is exactly one Calc Trail buffer; it records a
10040 list of the results of all calculations that have been done.  The
10041 Calc Trail buffer uses a variant of Calc mode, so Calculator commands
10042 still work when the trail buffer's window is selected.  It is possible
10043 to turn the trail window off, but the @samp{*Calc Trail*} buffer itself
10044 still exists and is updated silently.  @xref{Trail Commands}.
10046 @kindex M-# c
10047 @kindex M-# M-#
10048 @ignore
10049 @mindex @null
10050 @end ignore
10051 @kindex M-# #
10052 In most installations, the @kbd{M-# c} key sequence is a more
10053 convenient way to start the Calculator.  Also, @kbd{M-# M-#} and
10054 @kbd{M-# #} are synonyms for @kbd{M-# c} unless you last used Calc
10055 in its Keypad mode.
10057 @kindex x
10058 @kindex M-x
10059 @pindex calc-execute-extended-command
10060 Most Calc commands use one or two keystrokes.  Lower- and upper-case
10061 letters are distinct.  Commands may also be entered in full @kbd{M-x} form;
10062 for some commands this is the only form.  As a convenience, the @kbd{x}
10063 key (@code{calc-execute-extended-command})
10064 is like @kbd{M-x} except that it enters the initial string @samp{calc-}
10065 for you.  For example, the following key sequences are equivalent:
10066 @kbd{S}, @kbd{M-x calc-sin @key{RET}}, @kbd{x sin @key{RET}}.
10068 @cindex Extensions module
10069 @cindex @file{calc-ext} module
10070 The Calculator exists in many parts.  When you type @kbd{M-# c}, the
10071 Emacs ``auto-load'' mechanism will bring in only the first part, which
10072 contains the basic arithmetic functions.  The other parts will be
10073 auto-loaded the first time you use the more advanced commands like trig
10074 functions or matrix operations.  This is done to improve the response time
10075 of the Calculator in the common case when all you need to do is a
10076 little arithmetic.  If for some reason the Calculator fails to load an
10077 extension module automatically, you can force it to load all the
10078 extensions by using the @kbd{M-# L} (@code{calc-load-everything})
10079 command.  @xref{Mode Settings}.
10081 If you type @kbd{M-x calc} or @kbd{M-# c} with any numeric prefix argument,
10082 the Calculator is loaded if necessary, but it is not actually started.
10083 If the argument is positive, the @file{calc-ext} extensions are also
10084 loaded if necessary.  User-written Lisp code that wishes to make use
10085 of Calc's arithmetic routines can use @samp{(calc 0)} or @samp{(calc 1)}
10086 to auto-load the Calculator.
10088 @kindex M-# b
10089 @pindex full-calc
10090 If you type @kbd{M-# b}, then next time you use @kbd{M-# c} you
10091 will get a Calculator that uses the full height of the Emacs screen.
10092 When full-screen mode is on, @kbd{M-# c} runs the @code{full-calc}
10093 command 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
10095 as a calculator.  When Calc is started from the Emacs command line
10096 like this, Calc's normal ``quit'' commands actually quit Emacs itself.
10098 @kindex M-# o
10099 @pindex calc-other-window
10100 The @kbd{M-# o} command is like @kbd{M-# c} except that the Calc
10101 window is not actually selected.  If you are already in the Calc
10102 window, @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
10104 tendency to drop you into the Calc Trail window instead, which
10105 @kbd{M-# o} takes care not to do.)
10107 @ignore
10108 @mindex M-# q
10109 @end ignore
10110 For one quick calculation, you can type @kbd{M-# q} (@code{quick-calc})
10111 which prompts you for a formula (like @samp{2+3/4}).  The result is
10112 displayed at the bottom of the Emacs screen without ever creating
10113 any special Calculator windows.  @xref{Quick Calculator}.
10115 @ignore
10116 @mindex M-# k
10117 @end ignore
10118 Finally, 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
10121 the keys with the mouse to operate the calculator.  @xref{Keypad Mode}.
10123 @kindex q
10124 @pindex calc-quit
10125 @cindex Quitting the Calculator
10126 @cindex Exiting the Calculator
10127 The @kbd{q} key (@code{calc-quit}) exits Calc mode and closes the
10128 Calculator's window(s).  It does not delete the Calculator buffers.
10129 If you type @kbd{M-x calc} again, the Calculator will reappear with the
10130 contents of the stack intact.  Typing @kbd{M-# c} or @kbd{M-# M-#}
10131 again from inside the Calculator buffer is equivalent to executing
10132 @code{calc-quit}; you can think of @kbd{M-# M-#} as toggling the
10133 Calculator on and off.
10135 @kindex M-# x
10136 The @kbd{M-# x} command also turns the Calculator off, no matter which
10137 user interface (standard, Keypad, or Embedded) is currently active.
10138 It also cancels @code{calc-edit} mode if used from there.
10140 @kindex d @key{SPC}
10141 @pindex calc-refresh
10142 @cindex Refreshing a garbled display
10143 @cindex Garbled displays, refreshing
10144 The @kbd{d @key{SPC}} key sequence (@code{calc-refresh}) redraws the contents
10145 of the Calculator buffer from memory.  Use this if the contents of the
10146 buffer have been damaged somehow.
10148 @ignore
10149 @mindex o
10150 @end ignore
10151 The @kbd{o} key (@code{calc-realign}) moves the cursor back to its
10152 ``home'' position at the bottom of the Calculator buffer.
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
10161 The @kbd{<} and @kbd{>} keys are bound to @code{calc-scroll-left} and
10162 @code{calc-scroll-right}.  These are just like the normal horizontal
10163 scrolling commands except that they scroll one half-screen at a time by
10164 default.  (Calc formats its output to fit within the bounds of the
10165 window whenever it can.)
10167 @kindex @{
10168 @kindex @}
10169 @pindex calc-scroll-down
10170 @pindex calc-scroll-up
10171 @cindex Vertical scrolling
10172 The @kbd{@{} and @kbd{@}} keys are bound to @code{calc-scroll-down}
10173 and @code{calc-scroll-up}.  They scroll up or down by one-half the
10174 height of the Calc window.
10176 @kindex M-# 0
10177 @pindex calc-reset
10178 The @kbd{M-# 0} command (@code{calc-reset}; that's @kbd{M-#} followed
10179 by a zero) resets the Calculator to its initial state.  This clears
10180 the stack, resets all the modes to their initial values (the values
10181 that were saved with @kbd{m m} (@code{calc-save-modes})), clears the
10182 caches (@pxref{Caches}), and so on.  (It does @emph{not} erase the
10183 values of any variables.) With an argument of 0, Calc will be reset to
10184 its default state; namely, the modes will be given their default values.
10185 With a positive prefix argument, @kbd{M-# 0} preserves the contents of
10186 the stack but resets everything else to its initial state; with a
10187 negative prefix argument, @kbd{M-# 0} preserves the contents of the
10188 stack but resets everything else to its default state.
10190 @pindex calc-version
10191 The @kbd{M-x calc-version} command displays the current version number
10192 of 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,
10194 and in the output of the @kbd{h h} command.)
10196 @node Help Commands, Stack Basics, Basic Commands, Introduction
10197 @section Help Commands
10199 @noindent
10200 @cindex Help commands
10201 @kindex ?
10202 @pindex calc-help
10203 The @kbd{?} key (@code{calc-help}) displays a series of brief help messages.
10204 Some 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
10207 prefix.  (If the message includes @samp{[MORE]}, press @kbd{?} again
10208 to see additional commands for that prefix.)
10210 @kindex h h
10211 @pindex calc-full-help
10212 The @kbd{h h} (@code{calc-full-help}) command displays all the @kbd{?}
10213 responses at once.  When printed, this makes a nice, compact (three pages)
10214 summary of Calc keystrokes.
10216 In general, the @kbd{h} key prefix introduces various commands that
10217 provide help within Calc.  Many of the @kbd{h} key functions are
10218 Calc-specific analogues to the @kbd{C-h} functions for Emacs help.
10220 @kindex h i
10221 @kindex M-# i
10222 @kindex i
10223 @pindex calc-info
10224 The @kbd{h i} (@code{calc-info}) command runs the Emacs Info system
10225 to 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
10227 is not already in the Calc manual, selecting the beginning of the
10228 manual.  The @kbd{M-# i} command is another way to read the Calc
10229 manual; it is different from @kbd{h i} in that it works any time,
10230 not 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
10232 different command in a future version of Calc.
10234 @kindex h t
10235 @kindex M-# t
10236 @pindex calc-tutorial
10237 The @kbd{h t} (@code{calc-tutorial}) command runs the Info system on
10238 the Tutorial section of the Calc manual.  It is like @kbd{h i},
10239 except that it selects the starting node of the tutorial rather
10240 than the beginning of the whole manual.  (It actually selects the
10241 node ``Interactive Tutorial'' which tells a few things about
10242 using the Info system before going on to the actual tutorial.)
10243 The @kbd{M-# t} key is equivalent to @kbd{h t} (but it works at
10244 all times).
10246 @kindex h s
10247 @kindex M-# s
10248 @pindex calc-info-summary
10249 The @kbd{h s} (@code{calc-info-summary}) command runs the Info system
10250 on the Summary node of the Calc manual.  @xref{Summary}.  The @kbd{M-# s}
10251 key is equivalent to @kbd{h s}.
10253 @kindex h k
10254 @pindex calc-describe-key
10255 The @kbd{h k} (@code{calc-describe-key}) command looks up a key
10256 sequence in the Calc manual.  For example, @kbd{h k H a S} looks
10257 up the documentation on the @kbd{H a S} (@code{calc-solve-for})
10258 command.  This works by looking up the textual description of
10259 the key(s) in the Key Index of the manual, then jumping to the
10260 node indicated by the index.
10262 Most Calc commands do not have traditional Emacs documentation
10263 strings, since the @kbd{h k} command is both more convenient and
10264 more instructive.  This means the regular Emacs @kbd{C-h k}
10265 (@code{describe-key}) command will not be useful for Calc keystrokes.
10267 @kindex h c
10268 @pindex calc-describe-key-briefly
10269 The @kbd{h c} (@code{calc-describe-key-briefly}) command reads a
10270 key sequence and displays a brief one-line description of it at
10271 the bottom of the screen.  It looks for the key sequence in the
10272 Summary node of the Calc manual; if it doesn't find the sequence
10273 there, 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}
10275 gives the description:
10277 @smallexample
10278 H a S runs calc-solve-for:  a `H a S' v  => fsolve(a,v)  (?=notes)
10279 @end smallexample
10281 @noindent
10282 which means the command @kbd{H a S} or @kbd{H M-x calc-solve-for}
10283 takes a value @expr{a} from the stack, prompts for a value @expr{v},
10284 then applies the algebraic function @code{fsolve} to these values.
10285 The @samp{?=notes} message means you can now type @kbd{?} to see
10286 additional notes from the summary that apply to this command.
10288 @kindex h f
10289 @pindex calc-describe-function
10290 The @kbd{h f} (@code{calc-describe-function}) command looks up an
10291 algebraic function or a command name in the Calc manual.  Enter an
10292 algebraic function name to look up that function in the Function
10293 Index or enter a command name beginning with @samp{calc-} to look it 
10294 up in the Command Index.  This command will also look up operator
10295 symbols that can appear in algebraic formulas, like @samp{%} and 
10296 @samp{=>}.
10298 @kindex h v
10299 @pindex calc-describe-variable
10300 The @kbd{h v} (@code{calc-describe-variable}) command looks up a
10301 variable in the Calc manual.  Enter a variable name like @code{pi} or
10302 @code{PlotRejects}.
10304 @kindex h b
10305 @pindex describe-bindings
10306 The @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
10308 listed.
10310 @kindex h n
10311 The @kbd{h n} or @kbd{h C-n} (@code{calc-view-news}) command displays
10312 the ``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
10314 source files.
10316 @kindex h C-c
10317 @kindex h C-d
10318 @kindex h C-w
10319 The @kbd{h C-c}, @kbd{h C-d}, and @kbd{h C-w} keys display copying,
10320 distribution, and warranty information about Calc.  These work by
10321 pulling up the appropriate parts of the ``Copying'' or ``Reporting
10322 Bugs'' sections of the manual.
10324 @node Stack Basics, Numeric Entry, Help Commands, Introduction
10325 @section Stack Basics
10327 @noindent
10328 @cindex Stack basics
10329 @c [fix-tut RPN Calculations and the Stack]
10330 Calc uses RPN notation.  If you are not familiar with RPN, @pxref{RPN
10331 Tutorial}.
10333 To 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.)
10336 The 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,
10338 and pushes the result (3) back onto the stack.  This number is ready for
10339 further calculations:  @kbd{5 -} pushes 5 onto the stack, then pops the
10340 3 and 5, subtracts them, and pushes the result (@mathit{-2}).
10342 Note that the ``top'' of the stack actually appears at the @emph{bottom}
10343 of the buffer.  A line containing a single @samp{.} character signifies
10344 the end of the buffer; Calculator commands operate on the number(s)
10345 directly above this line.  The @kbd{d t} (@code{calc-truncate-stack})
10346 command allows you to move the @samp{.} marker up and down in the stack;
10347 @pxref{Truncating the Stack}.
10349 @kindex d l
10350 @pindex calc-line-numbering
10351 Stack elements are numbered consecutively, with number 1 being the top of
10352 the stack.  These line numbers are ordinarily displayed on the lefthand side
10353 of the window.  The @kbd{d l} (@code{calc-line-numbering}) command controls
10354 whether these numbers appear.  (Line numbers may be turned off since they
10355 slow the Calculator down a bit and also clutter the display.)
10357 @kindex o
10358 @pindex calc-realign
10359 The unshifted letter @kbd{o} (@code{calc-realign}) command repositions
10360 the cursor to its top-of-stack ``home'' position.  It also undoes any
10361 horizontal scrolling in the window.  If you give it a numeric prefix
10362 argument, it instead moves the cursor to the specified stack element.
10364 The @key{RET} (or equivalent @key{SPC}) key is only required to separate
10365 two consecutive numbers.
10366 (After all, if you typed @kbd{1 2} by themselves the Calculator
10367 would enter the number 12.)  If you press @key{RET} or @key{SPC} @emph{not}
10368 right after typing a number, the key duplicates the number on the top of
10369 the stack.  @kbd{@key{RET} *} is thus a handy way to square a number.
10371 The @key{DEL} key pops and throws away the top number on the stack.
10372 The @key{TAB} key swaps the top two objects on the stack.
10373 @xref{Stack and Trail}, for descriptions of these and other stack-related
10374 commands.
10376 @node Numeric Entry, Algebraic Entry, Stack Basics, Introduction
10377 @section Numeric Entry
10379 @noindent
10380 @kindex 0-9
10381 @kindex .
10382 @kindex e
10383 @cindex Numeric entry
10384 @cindex Entering numbers
10385 Pressing a digit or other numeric key begins numeric entry using the
10386 minibuffer.  The number is pushed on the stack when you press the @key{RET}
10387 or @key{SPC} keys.  If you press any other non-numeric key, the number is
10388 pushed onto the stack and the appropriate operation is performed.  If
10389 you press a numeric key which is not valid, the key is ignored.
10391 @cindex Minus signs
10392 @cindex Negative numbers, entering
10393 @kindex _
10394 There are three different concepts corresponding to the word ``minus,''
10395 typified by @expr{a-b} (subtraction), @expr{-x}
10396 (change-sign), and @expr{-5} (negative number).  Calc uses three
10397 different keys for these operations, respectively:
10398 @kbd{-}, @kbd{n}, and @kbd{_} (the underscore).  The @kbd{-} key subtracts
10399 the two numbers on the top of the stack.  The @kbd{n} key changes the sign
10400 of the number on the top of the stack or the number currently being entered.
10401 The @kbd{_} key begins entry of a negative number or changes the sign of
10402 the number currently being entered.  The following sequences all enter the
10403 number @mathit{-5} onto the stack:  @kbd{0 @key{RET} 5 -}, @kbd{5 n @key{RET}},
10404 @kbd{5 @key{RET} n}, @kbd{_ 5 @key{RET}}, @kbd{5 _ @key{RET}}.
10406 Some other keys are active during numeric entry, such as @kbd{#} for
10407 non-decimal numbers, @kbd{:} for fractions, and @kbd{@@} for HMS forms.
10408 These notations are described later in this manual with the corresponding
10409 data types.  @xref{Data Types}.
10411 During numeric entry, the only editing key available is @key{DEL}.
10413 @node Algebraic Entry, Quick Calculator, Numeric Entry, Introduction
10414 @section Algebraic Entry
10416 @noindent
10417 @kindex '
10418 @pindex calc-algebraic-entry
10419 @cindex Algebraic notation
10420 @cindex Formulas, entering
10421 Calculations can also be entered in algebraic form.  This is accomplished
10422 by typing the apostrophe key, @kbd{'}, followed by the expression in
10423 standard format:  @kbd{@key{'} 2+3*4 @key{RET}} computes
10424 @texline @math{2+(3\times4) = 14}
10425 @infoline @expr{2+(3*4) = 14} 
10426 and pushes that on the stack.  If you wish you can
10427 ignore the RPN aspect of Calc altogether and simply enter algebraic
10428 expressions in this way.  You may want to use @key{DEL} every so often to
10429 clear previous results off the stack.
10431 You can press the apostrophe key during normal numeric entry to switch
10432 the half-entered number into Algebraic entry mode.  One reason to do this
10433 would be to use the full Emacs cursor motion and editing keys, which are
10434 available during algebraic entry but not during numeric entry.
10436 In the same vein, during either numeric or algebraic entry you can
10437 press @kbd{`} (backquote) to switch to @code{calc-edit} mode, where
10438 you complete your half-finished entry in a separate buffer.
10439 @xref{Editing Stack Entries}.
10441 @kindex m a
10442 @pindex calc-algebraic-mode
10443 @cindex Algebraic Mode
10444 If you prefer algebraic entry, you can use the command @kbd{m a}
10445 (@code{calc-algebraic-mode}) to set Algebraic mode.  In this mode,
10446 digits and other keys that would normally start numeric entry instead
10447 start full algebraic entry; as long as your formula begins with a digit
10448 you can omit the apostrophe.  Open parentheses and square brackets also
10449 begin algebraic entry.  You can still do RPN calculations in this mode,
10450 but 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
10452 thing as @kbd{2*3+4 @key{RET}}.
10454 @cindex Incomplete Algebraic Mode
10455 If you give a numeric prefix argument like @kbd{C-u} to the @kbd{m a}
10456 command, it enables Incomplete Algebraic mode; this is like regular
10457 Algebraic mode except that it applies to the @kbd{(} and @kbd{[} keys
10458 only.  Numeric keys still begin a numeric entry in this mode.
10460 @kindex m t
10461 @pindex calc-total-algebraic-mode
10462 @cindex Total Algebraic Mode
10463 The @kbd{m t} (@code{calc-total-algebraic-mode}) gives you an even
10464 stronger algebraic-entry mode, in which @emph{all} regular letter and
10465 punctuation 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
10468 Total Algebraic mode, hold down the @key{META} key.  Thus @kbd{M-q}
10469 is the command to quit Calc, @kbd{M-p} sets the precision, and
10470 @kbd{M-m t} (or @kbd{M-m M-t}, if you prefer) turns Total Algebraic
10471 mode back off again.  Meta keys also terminate algebraic entry, so
10472 that @kbd{2+3 M-S} is equivalent to @kbd{2+3 @key{RET} M-S}.  The symbol
10473 @samp{Alg*} will appear in the mode line whenever you are in this mode.
10475 Pressing @kbd{'} (the apostrophe) a second time re-enters the previous
10476 algebraic formula.  You can then use the normal Emacs editing keys to
10477 modify this formula to your liking before pressing @key{RET}.
10479 @kindex $
10480 @cindex Formulas, referring to stack
10481 Within a formula entered from the keyboard, the symbol @kbd{$}
10482 represents the number on the top of the stack.  If an entered formula
10483 contains any @kbd{$} characters, the Calculator replaces the top of
10484 stack with that formula rather than simply pushing the formula onto the
10485 stack.  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
10487 initiates algebraic entry; the @kbd{'} is unnecessary if @kbd{$} is the
10488 first character in the new formula.
10490 Higher stack elements can be accessed from an entered formula with the
10491 symbols @kbd{$$}, @kbd{$$$}, and so on.  The number of stack elements
10492 removed (to be replaced by the entered values) equals the number of dollar
10493 signs in the longest such symbol in the formula.  For example, @samp{$$+$$$}
10494 adds the second and third stack elements, replacing the top three elements
10495 with the answer.  (All information about the top stack element is thus lost
10496 since no single @samp{$} appears in this formula.)
10498 A slightly different way to refer to stack elements is with a dollar
10499 sign followed by a number:  @samp{$1}, @samp{$2}, and so on are much
10500 like @samp{$}, @samp{$$}, etc., except that stack entries referred
10501 to 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
10503 on the stack and pushes an additional 6.
10505 If a sequence of formulas are entered separated by commas, each formula
10506 is pushed onto the stack in turn.  For example, @samp{1,2,3} pushes
10507 those 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.
10512 You can finish an algebraic entry with @kbd{M-=} or @kbd{M-@key{RET}} instead
10513 of @key{RET}.  This uses @kbd{=} to evaluate the variables in each
10514 formula that goes onto the stack.  (Thus @kbd{' pi @key{RET}} pushes
10515 the variable @samp{pi}, but @kbd{' pi M-@key{RET}} pushes 3.1415.)
10517 If you finish your algebraic entry by pressing @key{LFD} (or @kbd{C-j})
10518 instead of @key{RET}, Calc disables the default simplifications
10519 (as if by @kbd{m O}; @pxref{Simplification Modes}) while the entry
10520 is being pushed on the stack.  Thus @kbd{' 1+2 @key{RET}} pushes 3
10521 on the stack, but @kbd{' 1+2 @key{LFD}} pushes the formula @expr{1+2};
10522 you might then press @kbd{=} when it is time to evaluate this formula.
10524 @node Quick Calculator, Prefix Arguments, Algebraic Entry, Introduction
10525 @section ``Quick Calculator'' Mode
10527 @noindent
10528 @kindex M-# q
10529 @pindex quick-calc
10530 @cindex Quick Calculator
10531 There is another way to invoke the Calculator if all you need to do
10532 is 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.
10534 The Calculator will compute the result and display it in the echo
10535 area, without ever actually putting up a Calc window.
10537 You can use the @kbd{$} character in a Quick Calculator formula to
10538 refer to the previous Quick Calculator result.  Older results are
10539 not retained; the Quick Calculator has no effect on the full
10540 Calculator's stack or trail.  If you compute a result and then
10541 forget what it was, just run @code{M-# q} again and enter
10542 @samp{$} as the formula.
10544 If this is the first time you have used the Calculator in this Emacs
10545 session, the @kbd{M-# q} command will create the @code{*Calculator*}
10546 buffer and perform all the usual initializations; it simply will
10547 refrain from putting that buffer up in a new window.  The Quick
10548 Calculator refers to the @code{*Calculator*} buffer for all mode
10549 settings.  Thus, for example, to set the precision that the Quick
10550 Calculator uses, simply run the full Calculator momentarily and use
10551 the regular @kbd{p} command.
10553 If you use @code{M-# q} from inside the Calculator buffer, the
10554 effect is the same as pressing the apostrophe key (algebraic entry).
10556 The result of a Quick calculation is placed in the Emacs ``kill ring''
10557 as well as being displayed.  A subsequent @kbd{C-y} command will
10558 yank the result into the editing buffer.  You can also use this
10559 to yank the result into the next @kbd{M-# q} input line as a more
10560 explicit alternative to @kbd{$} notation, or to yank the result
10561 into the Calculator stack after typing @kbd{M-# c}.
10563 If you finish your formula by typing @key{LFD} (or @kbd{C-j}) instead
10564 of @key{RET}, the result is inserted immediately into the current
10565 buffer rather than going into the kill ring.
10567 Quick Calculator results are actually evaluated as if by the @kbd{=}
10568 key (which replaces variable names by their stored values, if any).
10569 If 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},
10571 then the result of the evaluation is stored in that Calc variable.
10572 @xref{Store and Recall}.
10574 If the result is an integer and the current display radix is decimal,
10575 the number will also be displayed in hex and octal formats.  If the
10576 integer is in the range from 1 to 126, it will also be displayed as
10577 an ASCII character.
10579 For example, the quoted character @samp{"x"} produces the vector
10580 result @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
10582 is displayed only according to the current mode settings.  But
10583 running Quick Calc again and entering @samp{120} will produce the
10584 result @samp{120 (16#78, 8#170, x)} which shows the number in its
10585 decimal, hexadecimal, octal, and ASCII forms.
10587 Please note that the Quick Calculator is not any faster at loading
10588 or computing the answer than the full Calculator; the name ``quick''
10589 merely refers to the fact that it's much less hassle to use for
10590 small calculations.
10592 @node Prefix Arguments, Undo, Quick Calculator, Introduction
10593 @section Numeric Prefix Arguments
10595 @noindent
10596 Many Calculator commands use numeric prefix arguments.  Some, such as
10597 @kbd{d s} (@code{calc-sci-notation}), set a parameter to the value of
10598 the prefix argument or use a default if you don't use a prefix.
10599 Others (like @kbd{d f} (@code{calc-fix-notation})) require an argument
10600 and prompt for a number if you don't give one as a prefix.
10602 As a rule, stack-manipulation commands accept a numeric prefix argument
10603 which is interpreted as an index into the stack.  A positive argument
10604 operates on the top @var{n} stack entries; a negative argument operates
10605 on the @var{n}th stack entry in isolation; and a zero argument operates
10606 on the entire stack.
10608 Most commands that perform computations (such as the arithmetic and
10609 scientific functions) accept a numeric prefix argument that allows the
10610 operation to be applied across many stack elements.  For unary operations
10611 (that is, functions of one argument like absolute value or complex
10612 conjugate), a positive prefix argument applies that function to the top
10613 @var{n} stack entries simultaneously, and a negative argument applies it
10614 to the @var{n}th stack entry only.  For binary operations (functions of
10615 two arguments like addition, GCD, and vector concatenation), a positive
10616 prefix argument ``reduces'' the function across the top @var{n}
10617 stack 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).
10621 This feature is not available for operations which use the numeric prefix
10622 argument for some other purpose.
10624 Numeric prefixes are specified the same way as always in Emacs:  Press
10625 a sequence of @key{META}-digits, or press @key{ESC} followed by digits,
10626 or press @kbd{C-u} followed by digits.  Some commands treat plain
10627 @kbd{C-u} (without any actual digits) specially.
10629 @kindex ~
10630 @pindex calc-num-prefix
10631 You can type @kbd{~} (@code{calc-num-prefix}) to pop an integer from the
10632 top of the stack and enter it as the numeric prefix for the next command.
10633 For 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
10635 to the fourth power and set the precision to that value.
10637 Conversely, if you have typed a numeric prefix argument the @kbd{~} key
10638 pushes it onto the stack in the form of an integer.
10640 @node Undo, Error Messages, Prefix Arguments, Introduction
10641 @section Undoing Mistakes
10643 @noindent
10644 @kindex U
10645 @kindex C-_
10646 @pindex calc-undo
10647 @cindex Mistakes, undoing
10648 @cindex Undoing mistakes
10649 @cindex Errors, undoing
10650 The shift-@kbd{U} key (@code{calc-undo}) undoes the most recent operation.
10651 If that operation added or dropped objects from the stack, those objects
10652 are removed or restored.  If it was a ``store'' operation, you are
10653 queried whether or not to restore the variable to its original value.
10654 The @kbd{U} key may be pressed any number of times to undo successively
10655 farther back in time; with a numeric prefix argument it undoes a
10656 specified number of operations.  The undo history is cleared only by the
10657 @kbd{q} (@code{calc-quit}) command.  (Recall that @kbd{M-# c} is
10658 synonymous with @code{calc-quit} while inside the Calculator; this
10659 also clears the undo history.)
10661 Currently the mode-setting commands (like @code{calc-precision}) are not
10662 undoable.  You can undo past a point where you changed a mode, but you
10663 will need to reset the mode yourself.
10665 @kindex D
10666 @pindex calc-redo
10667 @cindex Redoing after an Undo
10668 The shift-@kbd{D} key (@code{calc-redo}) redoes an operation that was
10669 mistakenly undone.  Pressing @kbd{U} with a negative prefix argument is
10670 equivalent to executing @code{calc-redo}.  You can redo any number of
10671 times, up to the number of recent consecutive undo commands.  Redo
10672 information is cleared whenever you give any command that adds new undo
10673 information, i.e., if you undo, then enter a number on the stack or make
10674 any other change, then it will be too late to redo.
10676 @kindex M-@key{RET}
10677 @pindex calc-last-args
10678 @cindex Last-arguments feature
10679 @cindex Arguments, restoring
10680 The @kbd{M-@key{RET}} key (@code{calc-last-args}) is like undo in that
10681 it restores the arguments of the most recent command onto the stack;
10682 however, it does not remove the result of that command.  Given a numeric
10683 prefix argument, this command applies to the @expr{n}th most recent
10684 command which removed items from the stack; it pushes those items back
10685 onto the stack.
10687 The @kbd{K} (@code{calc-keep-args}) command provides a related function
10688 to @kbd{M-@key{RET}}.  @xref{Stack and Trail}.
10690 It is also possible to recall previous results or inputs using the trail.
10691 @xref{Trail Commands}.
10693 The standard Emacs @kbd{C-_} undo key is recognized as a synonym for @kbd{U}.
10695 @node Error Messages, Multiple Calculators, Undo, Introduction
10696 @section Error Messages
10698 @noindent
10699 @kindex w
10700 @pindex calc-why
10701 @cindex Errors, messages
10702 @cindex Why did an error occur?
10703 Many situations that would produce an error message in other calculators
10704 simply create unsimplified formulas in the Emacs Calculator.  For example,
10705 @kbd{1 @key{RET} 0 /} pushes the formula @expr{1 / 0}; @w{@kbd{0 L}} pushes
10706 the formula @samp{ln(0)}.  Floating-point overflow and underflow are also
10707 reasons for this to happen.
10709 When a function call must be left in symbolic form, Calc usually
10710 produces a message explaining why.  Messages that are probably
10711 surprising or indicative of user errors are displayed automatically.
10712 Other messages are simply kept in Calc's memory and are displayed only
10713 if you type @kbd{w} (@code{calc-why}).  You can also press @kbd{w} if
10714 the same computation results in several messages.  (The first message
10715 will end with @samp{[w=more]} in this case.)
10717 @kindex d w
10718 @pindex calc-auto-why
10719 The @kbd{d w} (@code{calc-auto-why}) command controls when error messages
10720 are displayed automatically.  (Calc effectively presses @kbd{w} for you
10721 after 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
10724 that you must always press @kbd{w} yourself to see the messages).
10726 @node Multiple Calculators, Troubleshooting Commands, Error Messages, Introduction
10727 @section Multiple Calculators
10729 @noindent
10730 @pindex another-calc
10731 It is possible to have any number of Calc mode buffers at once.
10732 Usually this is done by executing @kbd{M-x another-calc}, which
10733 is similar to @kbd{M-# c} except that if a @samp{*Calculator*}
10734 buffer already exists, a new, independent one with a name of the
10735 form @samp{*Calculator*<@var{n}>} is created.  You can also use the
10736 command @code{calc-mode} to put any buffer into Calculator mode, but
10737 this would ordinarily never be done.
10739 The @kbd{q} (@code{calc-quit}) command does not destroy a Calculator buffer;
10740 it only closes its window.  Use @kbd{M-x kill-buffer} to destroy a
10741 Calculator buffer.
10743 Each Calculator buffer keeps its own stack, undo list, and mode settings
10744 such as precision, angular mode, and display formats.  In Emacs terms,
10745 variables such as @code{calc-stack} are buffer-local variables.  The
10746 global default values of these variables are used only when a new
10747 Calculator buffer is created.  The @code{calc-quit} command saves
10748 the stack and mode settings of the buffer being quit as the new defaults.
10750 There is only one trail buffer, @samp{*Calc Trail*}, used by all
10751 Calculator buffers.
10753 @node Troubleshooting Commands, , Multiple Calculators, Introduction
10754 @section Troubleshooting Commands
10756 @noindent
10757 This section describes commands you can use in case a computation
10758 incorrectly fails or gives the wrong answer.
10760 @xref{Reporting Bugs}, if you find a problem that appears to be due
10761 to a bug or deficiency in Calc.
10763 @menu
10764 * Autoloading Problems::
10765 * Recursion Depth::
10766 * Caches::
10767 * Debugging Calc::
10768 @end menu
10770 @node Autoloading Problems, Recursion Depth, Troubleshooting Commands, Troubleshooting Commands
10771 @subsection Autoloading Problems
10773 @noindent
10774 The Calc program is split into many component files; components are
10775 loaded automatically as you use various commands that require them.
10776 Occasionally Calc may lose track of when a certain component is
10777 necessary; typically this means you will type a command and it won't
10778 work because some function you've never heard of was undefined.
10780 @kindex M-# L
10781 @pindex calc-load-everything
10782 If 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
10784 loaded right away.  This will cause Emacs to take up a lot more
10785 memory than it would otherwise, but it's guaranteed to fix the problem.
10787 @node Recursion Depth, Caches, Autoloading Problems, Troubleshooting Commands
10788 @subsection Recursion Depth
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}
10799 Calc uses recursion in many of its calculations.  Emacs Lisp keeps a
10800 variable @code{max-lisp-eval-depth} which limits the amount of recursion
10801 possible in an attempt to recover from program bugs.  If a calculation
10802 ever halts incorrectly with the message ``Computation got stuck or
10803 ran too long,'' use the @kbd{M} command (@code{calc-more-recursion-depth})
10804 to increase this limit.  (Of course, this will not help if the
10805 calculation really did get stuck due to some problem inside Calc.)
10807 The limit is always increased (multiplied) by a factor of two.  There
10808 is also an @kbd{I M} (@code{calc-less-recursion-depth}) command which
10809 decreases this limit by a factor of two, down to a minimum value of 200.
10810 The default value is 1000.
10812 These commands also double or halve @code{max-specpdl-size}, another
10813 internal Lisp recursion limit.  The minimum value for this limit is 600.
10815 @node Caches, Debugging Calc, Recursion Depth, Troubleshooting Commands
10816 @subsection Caches
10818 @noindent
10819 @cindex Caches
10820 @cindex Flushing caches
10821 Calc saves certain values after they have been computed once.  For
10822 example, the @kbd{P} (@code{calc-pi}) command initially ``knows'' the
10823 constant @cpi{} to about 20 decimal places; if the current precision
10824 is greater than this, it will recompute @cpi{} using a series
10825 approximation.  This value will not need to be recomputed ever again
10826 unless you raise the precision still further.  Many operations such as
10827 logarithms and sines make use of similarly cached values such as
10828 @cpiover{4} and 
10829 @texline @math{\ln 2}.
10830 @infoline @expr{ln(2)}.  
10831 The visible effect of caching is that
10832 high-precision computations may seem to do extra work the first time.
10833 Other things cached include powers of two (for the binary arithmetic
10834 functions), matrix inverses and determinants, symbolic integrals, and
10835 data points computed by the graphing commands.
10837 @pindex calc-flush-caches
10838 If 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.)
10841 The @kbd{M-# 0} (with the zero key) command also resets caches along
10842 with all other aspects of the Calculator's state.
10844 @node Debugging Calc, , Caches, Troubleshooting Commands
10845 @subsection Debugging Calc
10847 @noindent
10848 A few commands exist to help in the debugging of Calc commands.
10849 @xref{Programming}, to see the various ways that you can write
10850 your own Calc commands.
10852 @kindex Z T
10853 @pindex calc-timing
10854 The @kbd{Z T} (@code{calc-timing}) command turns on and off a mode
10855 in which the timing of slow commands is reported in the Trail.
10856 Any Calc command that takes two seconds or longer writes a line
10857 to the Trail showing how many seconds it took.  This value is
10858 accurate only to within one second.
10860 All steps of executing a command are included; in particular, time
10861 taken to format the result for display in the stack and trail is
10862 counted.  Some prompts also count time taken waiting for them to
10863 be answered, while others do not; this depends on the exact
10864 implementation of the command.  For best results, if you are timing
10865 a sequence that includes prompts or multiple commands, define a
10866 keyboard macro to run the whole sequence at once.  Calc's @kbd{X}
10867 command (@pxref{Keyboard Macros}) will then report the time taken
10868 to execute the whole macro.
10870 Another advantage of the @kbd{X} command is that while it is
10871 executing, the stack and trail are not updated from step to step.
10872 So if you expect the output of your test sequence to leave a result
10873 that may take a long time to format and you don't wish to count
10874 this formatting time, end your sequence with a @key{DEL} keystroke
10875 to clear the result from the stack.  When you run the sequence with
10876 @kbd{X}, Calc will never bother to format the large result.
10878 Another thing @kbd{Z T} does is to increase the Emacs variable
10879 @code{gc-cons-threshold} to a much higher value (two million; the
10880 usual default in Calc is 250,000) for the duration of each command.
10881 This generally prevents garbage collection during the timing of
10882 the command, though it may cause your Emacs process to grow
10883 abnormally large.  (Garbage collection time is a major unpredictable
10884 factor in the timing of Emacs operations.)
10886 Another command that is useful when debugging your own Lisp
10887 extensions to Calc is @kbd{M-x calc-pass-errors}, which disables
10888 the error handler that changes the ``@code{max-lisp-eval-depth}
10889 exceeded'' message to the much more friendly ``Computation got
10890 stuck or ran too long.''  This handler interferes with the Emacs
10891 Lisp debugger's @code{debug-on-error} mode.  Errors are reported
10892 in the handler itself rather than at the true location of the
10893 error.  After you have executed @code{calc-pass-errors}, Lisp
10894 errors will be reported correctly but the user-friendly message
10895 will be lost.
10897 @node Data Types, Stack and Trail, Introduction, Top
10898 @chapter Data Types
10900 @noindent
10901 This chapter discusses the various types of objects that can be placed
10902 on the Calculator stack, how they are displayed, and how they are
10903 entered.  (@xref{Data Type Formats}, for information on how these data
10904 types are represented as underlying Lisp objects.)
10906 Integers, fractions, and floats are various ways of describing real
10907 numbers.  HMS forms also for many purposes act as real numbers.  These
10908 types can be combined to form complex numbers, modulo forms, error forms,
10909 or interval forms.  (But these last four types cannot be combined
10910 arbitrarily:@: error forms may not contain modulo forms, for example.)
10911 Finally, all these types of numbers may be combined into vectors,
10912 matrices, or algebraic formulas.
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
10932 @node Integers, Fractions, Data Types, Data Types
10933 @section Integers
10935 @noindent
10936 @cindex Integers
10937 The Calculator stores integers to arbitrary precision.  Addition,
10938 subtraction, and multiplication of integers always yields an exact
10939 integer result.  (If the result of a division or exponentiation of
10940 integers is not an integer, it is expressed in fractional or
10941 floating-point form according to the current Fraction mode.
10942 @xref{Fraction Mode}.)
10944 A decimal integer is represented as an optional sign followed by a
10945 sequence of digits.  Grouping (@pxref{Grouping Digits}) can be used to
10946 insert a comma at every third digit for display purposes, but you
10947 must not type commas during the entry of numbers.
10949 @kindex #
10950 A non-decimal integer is represented as an optional sign, a radix
10951 between 2 and 36, a @samp{#} symbol, and one or more digits.  For radix 11
10952 and above, the letters A through Z (upper- or lower-case) count as
10953 digits and do not terminate numeric entry mode.  @xref{Radix Modes}, for how
10954 to set the default radix for display of integers.  Numbers of any radix
10955 may be entered at any time.  If you press @kbd{#} at the beginning of a
10956 number, the current display radix is used.
10958 @node Fractions, Floats, Integers, Data Types
10959 @section Fractions
10961 @noindent
10962 @cindex Fractions
10963 A @dfn{fraction} is a ratio of two integers.  Fractions are traditionally
10964 written ``2/3'' but Calc uses the notation @samp{2:3}.  (The @kbd{/} key
10965 performs 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 /}
10967 assuming Fraction mode has been enabled.)
10968 When the Calculator produces a fractional result it always reduces it to
10969 simplest form, which may in fact be an integer.
10971 Fractions may also be entered in a three-part form, where @samp{2:3:4}
10972 represents two-and-three-quarters.  @xref{Fraction Formats}, for fraction
10973 display formats.
10975 Non-decimal fractions are entered and displayed as
10976 @samp{@var{radix}#@var{num}:@var{denom}} (or in the analogous three-part
10977 form).  The numerator and denominator always use the same radix.
10979 @node Floats, Complex Numbers, Fractions, Data Types
10980 @section Floats
10982 @noindent
10983 @cindex Floating-point numbers
10984 A floating-point number or @dfn{float} is a number stored in scientific
10985 notation.  The number of significant digits in the fractional part is
10986 governed by the current floating precision (@pxref{Precision}).  The
10987 range of acceptable values is from 
10988 @texline @math{10^{-3999999}}
10989 @infoline @expr{10^-3999999} 
10990 (inclusive) to 
10991 @texline @math{10^{4000000}}
10992 @infoline @expr{10^4000000}
10993 (exclusive), plus the corresponding negative values and zero.
10995 Calculations that would exceed the allowable range of values (such
10996 as @samp{exp(exp(20))}) are left in symbolic form by Calc.  The
10997 messages ``floating-point overflow'' or ``floating-point underflow''
10998 indicate that during the calculation a number would have been produced
10999 that was too large or too close to zero, respectively, to be represented
11000 by Calc.  This does not necessarily mean the final result would have
11001 overflowed, just that an overflow occurred while computing the result.
11002 (In fact, it could report an underflow even though the final result
11003 would have overflowed!)
11005 If a rational number and a float are mixed in a calculation, the result
11006 will in general be expressed as a float.  Commands that require an integer
11007 value (such as @kbd{k g} [@code{gcd}]) will also accept integer-valued
11008 floats, i.e., floating-point numbers with nothing after the decimal point.
11010 Floats are identified by the presence of a decimal point and/or an
11011 exponent.  In general a float consists of an optional sign, digits
11012 including an optional decimal point, and an optional exponent consisting
11013 of an @samp{e}, an optional sign, and up to seven exponent digits.
11014 For example, @samp{23.5e-2} is 23.5 times ten to the minus-second power,
11015 or 0.235.
11017 Floating-point numbers are normally displayed in decimal notation with
11018 all significant figures shown.  Exceedingly large or small numbers are
11019 displayed in scientific notation.  Various other display options are
11020 available.  @xref{Float Formats}.
11022 @cindex Accuracy of calculations
11023 Floating-point numbers are stored in decimal, not binary.  The result
11024 of each operation is rounded to the nearest value representable in the
11025 number of significant digits specified by the current precision,
11026 rounding away from zero in the case of a tie.  Thus (in the default
11027 display mode) what you see is exactly what you get.  Some operations such
11028 as square roots and transcendental functions are performed with several
11029 digits of extra precision and then rounded down, in an effort to make the
11030 final result accurate to the full requested precision.  However,
11031 accuracy is not rigorously guaranteed.  If you suspect the validity of a
11032 result, try doing the same calculation in a higher precision.  The
11033 Calculator's arithmetic is not intended to be IEEE-conformant in any
11034 way.
11036 While floats are always @emph{stored} in decimal, they can be entered
11037 and displayed in any radix just like integers and fractions.  The
11038 notation @samp{@var{radix}#@var{ddd}.@var{ddd}} is a floating-point
11039 number whose digits are in the specified radix.  Note that the @samp{.}
11040 is more aptly referred to as a ``radix point'' than as a decimal
11041 point 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.
11044 The exponent is written in decimal, and is considered to be a power
11045 of the radix: @samp{8#1234567e-4}.  If the radix is 15 or above, the
11046 letter @samp{e} is a digit, so scientific notation must be written
11047 out, e.g., @samp{16#123.4567*16^2}.  The first two exercises of the
11048 Modes Tutorial explore some of the properties of non-decimal floats.
11050 @node Complex Numbers, Infinities, Floats, Data Types
11051 @section Complex Numbers
11053 @noindent
11054 @cindex Complex numbers
11055 There are two supported formats for complex numbers: rectangular and
11056 polar.  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.
11059 Rectangular complex numbers can also be displayed in @samp{@var{a}+@var{b}i}
11060 notation; @pxref{Complex Formats}.
11062 Polar complex numbers are displayed in the form 
11063 @texline `@tfn{(}@var{r}@tfn{;}@math{\theta}@tfn{)}'
11064 @infoline `@tfn{(}@var{r}@tfn{;}@var{theta}@tfn{)}'
11065 where @var{r} is the nonnegative magnitude and 
11066 @texline @math{\theta}
11067 @infoline @var{theta} 
11068 is the argument or phase angle.  The range of 
11069 @texline @math{\theta}
11070 @infoline @var{theta} 
11071 depends on the current angular mode (@pxref{Angular Modes}); it is
11072 generally between @mathit{-180} and @mathit{+180} degrees or the equivalent range
11073 in radians. 
11075 Complex numbers are entered in stages using incomplete objects.
11076 @xref{Incomplete Objects}.
11078 Operations on rectangular complex numbers yield rectangular complex
11079 results, and similarly for polar complex numbers.  Where the two types
11080 are mixed, or where new complex numbers arise (as for the square root of
11081 a negative real), the current @dfn{Polar mode} is used to determine the
11082 type.  @xref{Polar Mode}.
11084 A complex result in which the imaginary part is zero (or the phase angle
11085 is 0 or 180 degrees or @cpi{} radians) is automatically converted to a real
11086 number.
11088 @node Infinities, Vectors and Matrices, Complex Numbers, Data Types
11089 @section Infinities
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
11099 The word @code{inf} represents the mathematical concept of @dfn{infinity}.
11100 Calc actually has three slightly different infinity-like values:
11101 @code{inf}, @code{uinf}, and @code{nan}.  These are just regular
11102 variable names (@pxref{Variables}); you should avoid using these
11103 names for your own variables because Calc gives them special
11104 treatment.  Infinities, like all variable names, are normally
11105 entered using algebraic entry.
11107 Mathematically speaking, it is not rigorously correct to treat
11108 ``infinity'' as if it were a number, but mathematicians often do
11109 so informally.  When they say that @samp{1 / inf = 0}, what they
11110 really mean is that @expr{1 / x}, as @expr{x} becomes larger and
11111 larger, becomes arbitrarily close to zero.  So you can imagine
11112 that if @expr{x} got ``all the way to infinity,'' then @expr{1 / x}
11113 would go all the way to zero.  Similarly, when they say that
11114 @samp{exp(inf) = inf}, they mean that 
11115 @texline @math{e^x}
11116 @infoline @expr{exp(x)} 
11117 grows without bound as @expr{x} grows.  The symbol @samp{-inf} likewise
11118 stands for an infinitely negative real value; for example, we say that
11119 @samp{exp(-inf) = 0}.  You can have an infinity pointing in any
11120 direction on the complex plane:  @samp{sqrt(-inf) = i inf}.
11122 The same concept of limits can be used to define @expr{1 / 0}.  We
11123 really want the value that @expr{1 / x} approaches as @expr{x}
11124 approaches zero.  But if all we have is @expr{1 / 0}, we can't
11125 tell which direction @expr{x} was coming from.  If @expr{x} was
11126 positive and decreasing toward zero, then we should say that
11127 @samp{1 / 0 = inf}.  But if @expr{x} was negative and increasing
11128 toward zero, the answer is @samp{1 / 0 = -inf}.  In fact, @expr{x}
11129 could 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
11132 large but with an unknown sign (or direction on the complex plane).
11134 Calc actually has three modes that say how infinities are handled.
11135 Normally, infinities never arise from calculations that didn't
11136 already have them.  Thus, @expr{1 / 0} is treated simply as an
11137 error and left unevaluated.  The @kbd{m i} (@code{calc-infinite-mode})
11138 command (@pxref{Infinite Mode}) enables a mode in which
11139 @expr{1 / 0} evaluates to @code{uinf} instead.  There is also
11140 an alternative type of infinite mode which says to treat zeros
11141 as if they were positive, so that @samp{1 / 0 = inf}.  While this
11142 is less mathematically correct, it may be the answer you want in
11143 some cases.
11145 Since all infinities are ``as large'' as all others, Calc simplifies,
11146 e.g., @samp{5 inf} to @samp{inf}.  Another example is
11147 @samp{5 - inf = -inf}, where the @samp{-inf} is so large that
11148 adding a finite number like five to it does not affect it.
11149 Note that @samp{a - inf} also results in @samp{-inf}; Calc assumes
11150 that variables like @code{a} always stand for finite quantities.
11151 Just to show that infinities really are all the same size,
11152 note that @samp{sqrt(inf) = inf^2 = exp(inf) = inf} in Calc's
11153 notation.
11155 It's not so easy to define certain formulas like @samp{0 * inf} and
11156 @samp{inf / inf}.  Depending on where these zeros and infinities
11157 came from, the answer could be literally anything.  The latter
11158 formula could be the limit of @expr{x / x} (giving a result of one),
11159 or @expr{2 x / x} (giving two), or @expr{x^2 / x} (giving @code{inf}),
11160 or @expr{x / x^2} (giving zero).  Calc uses the symbol @code{nan}
11161 to represent such an @dfn{indeterminate} value.  (The name ``nan''
11162 comes from analogy with the ``NAN'' concept of IEEE standard
11163 arithmetic; it stands for ``Not A Number.''  This is somewhat of a
11164 misnomer, since @code{nan} @emph{does} stand for some number or
11165 infinity, it's just that @emph{which} number it stands for
11166 cannot be determined.)  In Calc's notation, @samp{0 * inf = nan}
11167 and @samp{inf / inf = nan}.  A few other common indeterminate
11168 expressions are @samp{inf - inf} and @samp{inf ^ 0}.  Also,
11169 @samp{0 / 0 = nan} if you have turned on Infinite mode
11170 (as described above).
11172 Infinities are especially useful as parts of @dfn{intervals}.
11173 @xref{Interval Forms}.
11175 @node Vectors and Matrices, Strings, Infinities, Data Types
11176 @section Vectors and Matrices
11178 @noindent
11179 @cindex Vectors
11180 @cindex Plain vectors
11181 @cindex Matrices
11182 The @dfn{vector} data type is flexible and general.  A vector is simply a
11183 list of zero or more data objects.  When these objects are numbers, the
11184 whole is a vector in the mathematical sense.  When these objects are
11185 themselves vectors of equal (nonzero) length, the whole is a @dfn{matrix}.
11186 A vector which is not a matrix is referred to here as a @dfn{plain vector}.
11188 A vector is displayed as a list of values separated by commas and enclosed
11189 in square brackets:  @samp{[1, 2, 3]}.  Thus the following is a 2 row by
11190 3 column matrix:  @samp{[[1, 2, 3], [4, 5, 6]]}.  Vectors, like complex
11191 numbers, are entered as incomplete objects.  @xref{Incomplete Objects}.
11192 During algebraic entry, vectors are entered all at once in the usual
11193 brackets-and-commas form.  Matrices may be entered algebraically as nested
11194 vectors, or using the shortcut notation @w{@samp{[1, 2, 3; 4, 5, 6]}},
11195 with rows separated by semicolons.  The commas may usually be omitted
11196 when entering vectors:  @samp{[1 2 3]}.  Curly braces may be used in
11197 place of brackets: @samp{@{1, 2, 3@}}, but the commas are required in
11198 this case.
11200 Traditional vector and matrix arithmetic is also supported;
11201 @pxref{Basic Arithmetic} and @pxref{Matrix Functions}.
11202 Many other operations are applied to vectors element-wise.  For example,
11203 the complex conjugate of a vector is a vector of the complex conjugates
11204 of its elements.
11206 @ignore
11207 @starindex
11208 @end ignore
11209 @tindex vec
11210 Algebraic functions for building vectors include @samp{vec(a, b, c)}
11211 to build @samp{[a, b, c]}, @samp{cvec(a, n, m)} to build an 
11212 @texline @math{n\times m}
11213 @infoline @var{n}x@var{m}
11214 matrix of @samp{a}s, and @samp{index(n)} to build a vector of integers
11215 from 1 to @samp{n}.
11217 @node Strings, HMS Forms, Vectors and Matrices, Data Types
11218 @section Strings
11220 @noindent
11221 @kindex "
11222 @cindex Strings
11223 @cindex Character strings
11224 Character strings are not a special data type in the Calculator.
11225 Rather, a string is represented simply as a vector all of whose
11226 elements are integers in the range 0 to 255 (ASCII codes).  You can
11227 enter a string at any time by pressing the @kbd{"} key.  Quotation
11228 marks and backslashes are written @samp{\"} and @samp{\\}, respectively,
11229 inside strings.  Other notations introduced by backslashes are:
11231 @example
11232 @group
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
11241 @end group
11242 @end example
11244 @noindent
11245 Finally, a backslash followed by three octal digits produces any
11246 character from its ASCII code.
11248 @kindex d "
11249 @pindex calc-display-strings
11250 Strings are normally displayed in vector-of-integers form.  The
11251 @w{@kbd{d "}} (@code{calc-display-strings}) command toggles a mode in
11252 which any vectors of small integers are displayed as quoted strings
11253 instead.
11255 The backslash notations shown above are also used for displaying
11256 strings.  Characters 128 and above are not translated by Calc; unless
11257 you have an Emacs modified for 8-bit fonts, these will show up in
11258 backslash-octal-digits notation.  For characters below 32, and
11259 for character 127, Calc uses the backslash-letter combination if
11260 there is one, or otherwise uses a @samp{\^} sequence.
11262 The only Calc feature that uses strings is @dfn{compositions};
11263 @pxref{Compositions}.  Strings also provide a convenient
11264 way to do conversions between ASCII characters and integers.
11266 @ignore
11267 @starindex
11268 @end ignore
11269 @tindex string
11270 There is a @code{string} function which provides a different display
11271 format for strings.  Basically, @samp{string(@var{s})}, where @var{s}
11272 is a vector of integers in the proper range, is displayed as the
11273 corresponding string of characters with no surrounding quotation
11274 marks or other modifications.  Thus @samp{string("ABC")} (or
11275 @samp{string([65 66 67])}) will look like @samp{ABC} on the stack.
11276 This happens regardless of whether @w{@kbd{d "}} has been used.  The
11277 only way to turn it off is to use @kbd{d U} (unformatted language
11278 mode) which will display @samp{string("ABC")} instead.
11280 Control characters are displayed somewhat differently by @code{string}.
11281 Characters below 32, and character 127, are shown using @samp{^} notation
11282 (same as shown above, but without the backslash).  The quote and
11283 backslash characters are left alone, as are characters 128 and above.
11285 @ignore
11286 @starindex
11287 @end ignore
11288 @tindex bstring
11289 The @code{bstring} function is just like @code{string} except that
11290 the resulting string is breakable across multiple lines if it doesn't
11291 fit all on one line.  Potential break points occur at every space
11292 character in the string.
11294 @node HMS Forms, Date Forms, Strings, Data Types
11295 @section HMS Forms
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
11301 argument, the interpretation is Degrees-Minutes-Seconds.  All functions
11302 that operate on angles accept HMS forms.  These are interpreted as
11303 degrees regardless of the current angular mode.  It is also possible to
11304 use HMS as the angular mode so that calculated angles are expressed in
11305 degrees, minutes, and seconds.
11307 @kindex @@
11308 @ignore
11309 @mindex @null
11310 @end ignore
11311 @kindex ' (HMS forms)
11312 @ignore
11313 @mindex @null
11314 @end ignore
11315 @kindex " (HMS forms)
11316 @ignore
11317 @mindex @null
11318 @end ignore
11319 @kindex h (HMS forms)
11320 @ignore
11321 @mindex @null
11322 @end ignore
11323 @kindex o (HMS forms)
11324 @ignore
11325 @mindex @null
11326 @end ignore
11327 @kindex m (HMS forms)
11328 @ignore
11329 @mindex @null
11330 @end ignore
11331 @kindex s (HMS forms)
11332 The 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
11337 accepted in place of @samp{"}.
11338 The @var{hours} value is an integer (or integer-valued float).
11339 The @var{mins} value is an integer or integer-valued float between 0 and 59.
11340 The @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
11343 as @mathit{- @var{hours}} @mathit{-} @var{mins}/60 @mathit{-} @var{secs}/3600.
11344 Display format for HMS forms is quite flexible.  @xref{HMS Formats}.
11346 HMS forms can be added and subtracted.  When they are added to numbers,
11347 the numbers are interpreted according to the current angular mode.  HMS
11348 forms can also be multiplied and divided by real numbers.  Dividing
11349 two HMS forms produces a real-valued ratio of the two angles.
11351 @pindex calc-time
11352 @cindex Time of day
11353 Just for kicks, @kbd{M-x calc-time} pushes the current time of day on
11354 the stack as an HMS form.
11356 @node Date Forms, Modulo Forms, HMS Forms, Data Types
11357 @section Date Forms
11359 @noindent
11360 @cindex Date forms
11361 A @dfn{date form} represents a date and possibly an associated time.
11362 Simple date arithmetic is supported:  Adding a number to a date
11363 produces a new date shifted by that many days; adding an HMS form to
11364 a date shifts it by that many hours.  Subtracting two date forms
11365 computes the number of days between them (represented as a simple
11366 number).  Many other operations, such as multiplying two date forms,
11367 are nonsensical and are not allowed by Calc.
11369 Date forms are entered and displayed enclosed in @samp{< >} brackets.
11370 The default format is, e.g., @samp{<Wed Jan 9, 1991>} for dates,
11371 or @samp{<3:32:20pm Wed Jan 9, 1991>} for dates with times.
11372 Input is flexible; date forms can be entered in any of the usual
11373 notations for dates and times.  @xref{Date Formats}.
11375 Date forms are stored internally as numbers, specifically the number
11376 of days since midnight on the morning of January 1 of the year 1 AD.
11377 If the internal number is an integer, the form represents a date only;
11378 if the internal number is a fraction or float, the form represents
11379 a date and time.  For example, @samp{<6:00am Wed Jan 9, 1991>}
11380 is represented by the number 726842.25.  The standard precision of
11381 12 decimal digits is enough to ensure that a (reasonable) date and
11382 time can be stored without roundoff error.
11384 If the current precision is greater than 12, date forms will keep
11385 additional digits in the seconds position.  For example, if the
11386 precision is 15, the seconds will keep three digits after the
11387 decimal point.  Decreasing the precision below 12 may cause the
11388 time part of a date form to become inaccurate.  This can also happen
11389 if astronomically high years are used, though this will not be an
11390 issue in everyday (or even everymillennium) use.  Note that date
11391 forms without times are stored as exact integers, so roundoff is
11392 never an issue for them.
11394 You can use the @kbd{v p} (@code{calc-pack}) and @kbd{v u}
11395 (@code{calc-unpack}) commands to get at the numerical representation
11396 of a date form.  @xref{Packing and Unpacking}.
11398 Date forms can go arbitrarily far into the future or past.  Negative
11399 year numbers represent years BC.  Calc uses a combination of the
11400 Gregorian and Julian calendars, following the history of Great
11401 Britain and the British colonies.  This is the same calendar that
11402 is used by the @code{cal} program in most Unix implementations.
11404 @cindex Julian calendar
11405 @cindex Gregorian calendar
11406 Some historical background:  The Julian calendar was created by
11407 Julius Caesar in the year 46 BC as an attempt to fix the gradual
11408 drift caused by the lack of leap years in the calendar used
11409 until that time.  The Julian calendar introduced an extra day in
11410 all years divisible by four.  After some initial confusion, the
11411 calendar was adopted around the year we call 8 AD.  Some centuries
11412 later it became apparent that the Julian year of 365.25 days was
11413 itself not quite right.  In 1582 Pope Gregory XIII introduced the
11414 Gregorian calendar, which added the new rule that years divisible
11415 by 100, but not by 400, were not to be considered leap years
11416 despite being divisible by four.  Many countries delayed adoption
11417 of the Gregorian calendar because of religious differences;
11418 in Britain it was put off until the year 1752, by which time
11419 the Julian calendar had fallen eleven days behind the true
11420 seasons.  So the switch to the Gregorian calendar in early
11421 September 1752 introduced a discontinuity:  The day after
11422 Sep 2, 1752 is Sep 14, 1752.  Calc follows this convention.
11423 To take another example, Russia waited until 1918 before
11424 adopting the new calendar, and thus needed to remove thirteen
11425 days (between Feb 1, 1918 and Feb 14, 1918).  This means that
11426 Calc's reckoning will be inconsistent with Russian history between
11427 1752 and 1918, and similarly for various other countries.
11429 Today's timekeepers introduce an occasional ``leap second'' as
11430 well, 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
11432 between, say, @samp{<12:00am Mon Jan 1, 1900>} and
11433 @samp{<12:00am Sat Jan 1, 2000>}.)
11435 Calc uses the Julian calendar for all dates before the year 1752,
11436 including dates BC when the Julian calendar technically had not
11437 yet been invented.  Thus the claim that day number @mathit{-10000} is
11438 called ``August 16, 28 BC'' should be taken with a grain of salt.
11440 Please note that there is no ``year 0''; the day before
11441 @samp{<Sat Jan 1, +1>} is @samp{<Fri Dec 31, -1>}.  These are
11442 days 0 and @mathit{-1} respectively in Calc's internal numbering scheme.
11444 @cindex Julian day counting
11445 Another day counting system in common use is, confusingly, also
11446 called ``Julian.''  It was invented in 1583 by Joseph Justus
11447 Scaliger, who named it in honor of his father Julius Caesar
11448 Scaliger.  For obscure reasons he chose to start his day
11449 numbering on Jan 1, 4713 BC at noon, which in Calc's scheme
11450 is @mathit{-1721423.5} (recall that Calc starts at midnight instead
11451 of noon).  Thus to convert a Calc date code obtained by
11452 unpacking a date form into a Julian day number, simply add
11453 1721423.5.  The Julian code for @samp{6:00am Jan 9, 1991}
11454 is 2448265.75.  The built-in @kbd{t J} command performs
11455 this conversion for you.
11457 @cindex Unix time format
11458 The Unix operating system measures time as an integer number of
11459 seconds since midnight, Jan 1, 1970.  To convert a Calc date
11460 value into a Unix time stamp, first subtract 719164 (the code
11461 for @samp{<Jan 1, 1970>}), then multiply by 86400 (the number of
11462 seconds in a day) and press @kbd{R} to round to the nearest
11463 integer.  If you have a date form, you can simply subtract the
11464 day @samp{<Jan 1, 1970>} instead of unpacking and subtracting
11465 719164.  Likewise, divide by 86400 and add @samp{<Jan 1, 1970>}
11466 to convert from Unix time to a Calc date form.  (Note that
11467 Unix normally maintains the time in the GMT time zone; you may
11468 need to subtract five hours to get New York time, or eight hours
11469 for California time.  The same is usually true of Julian day
11470 counts.)  The built-in @kbd{t U} command performs these
11471 conversions.
11473 @node Modulo Forms, Error Forms, Date Forms, Data Types
11474 @section Modulo Forms
11476 @noindent
11477 @cindex Modulo forms
11478 A @dfn{modulo form} is a real number which is taken modulo (i.e., within
11479 an integer multiple of) some value @var{M}.  Arithmetic modulo @var{M}
11480 often arises in number theory.  Modulo forms are written
11481 `@var{a} @tfn{mod} @var{M}',
11482 where @var{a} and @var{M} are real numbers or HMS forms, and
11483 @texline @math{0 \le a < M}.
11484 @infoline @expr{0 <= a < @var{M}}.
11485 In many applications @expr{a} and @expr{M} will be
11486 integers but this is not required.
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)
11496 To create a modulo form during numeric entry, press the shift-@kbd{M}
11497 key to enter the word @samp{mod}.  As a special convenience, pressing
11498 shift-@kbd{M} a second time automatically enters the value of @expr{M}
11499 that was most recently used before.  During algebraic entry, either
11500 type @samp{mod} by hand or press @kbd{M-m} (that's @kbd{@key{META}-m}).
11501 Once again, pressing this a second time enters the current modulo.
11503 Modulo forms are not to be confused with the modulo operator @samp{%}.
11504 The expression @samp{27 % 10} means to compute 27 modulo 10 to produce
11505 the result 7.  Further computations treat this 7 as just a regular integer.
11506 The expression @samp{27 mod 10} produces the result @samp{7 mod 10};
11507 further computations with this value are again reduced modulo 10 so that
11508 the result always lies in the desired range.
11510 When two modulo forms with identical @expr{M}'s are added or multiplied,
11511 the Calculator simply adds or multiplies the values, then reduces modulo
11512 @expr{M}.  If one argument is a modulo form and the other a plain number,
11513 the plain number is treated like a compatible modulo form.  It is also
11514 possible to raise modulo forms to powers; the result is the value raised
11515 to the power, then reduced modulo @expr{M}.  (When all values involved
11516 are integers, this calculation is done much more efficiently than
11517 actually computing the power and then reducing.)
11519 @cindex Modulo division
11520 Two modulo forms `@var{a} @tfn{mod} @var{M}' and `@var{b} @tfn{mod} @var{M}'
11521 can be divided if @expr{a}, @expr{b}, and @expr{M} are all
11522 integers.  The result is the modulo form which, when multiplied by
11523 `@var{b} @tfn{mod} @var{M}', produces `@var{a} @tfn{mod} @var{M}'.  If
11524 there is no solution to this equation (which can happen only when
11525 @expr{M} is non-prime), or if any of the arguments are non-integers, the
11526 division is left in symbolic form.  Other operations, such as square
11527 roots, are not yet supported for modulo forms.  (Note that, although
11528 @w{`@tfn{(}@var{a} @tfn{mod} @var{M}@tfn{)^.5}'} will compute a ``modulo square root''
11529 in the sense of reducing 
11530 @texline @math{\sqrt a}
11531 @infoline @expr{sqrt(a)} 
11532 modulo @expr{M}, this is not a useful definition from the
11533 number-theoretical point of view.)
11535 It is possible to mix HMS forms and modulo forms.  For example, an
11536 HMS form modulo 24 could be used to manipulate clock times; an HMS
11537 form modulo 360 would be suitable for angles.  Making the modulo @expr{M}
11538 also be an HMS form eliminates troubles that would arise if the angular
11539 mode were inadvertently set to Radians, in which case
11540 @w{@samp{2@@ 0' 0" mod 24}} would be interpreted as two degrees modulo
11541 24 radians!
11543 Modulo forms cannot have variables or formulas for components.  If you
11544 enter the formula @samp{(x + 2) mod 5}, Calc propagates the modulus
11545 to each of the coefficients:  @samp{(1 mod 5) x + (2 mod 5)}.
11547 You can use @kbd{v p} and @kbd{%} to modify modulo forms.
11548 @xref{Packing and Unpacking}.  @xref{Basic Arithmetic}.
11550 @ignore
11551 @starindex
11552 @end ignore
11553 @tindex makemod
11554 The algebraic function @samp{makemod(a, m)} builds the modulo form
11555 @w{@samp{a mod m}}.
11557 @node Error Forms, Interval Forms, Modulo Forms, Data Types
11558 @section Error Forms
11560 @noindent
11561 @cindex Error forms
11562 @cindex Standard deviations
11563 An @dfn{error form} is a number with an associated standard
11564 deviation, as in @samp{2.3 +/- 0.12}.  The notation
11565 @texline `@var{x} @tfn{+/-} @math{\sigma}' 
11566 @infoline `@var{x} @tfn{+/-} sigma' 
11567 stands for an uncertain value which follows
11568 a normal or Gaussian distribution of mean @expr{x} and standard
11569 deviation or ``error'' 
11570 @texline @math{\sigma}.
11571 @infoline @expr{sigma}.
11572 Both the mean and the error can be either numbers or
11573 formulas.  Generally these are real numbers but the mean may also be
11574 complex.  If the error is negative or complex, it is changed to its
11575 absolute value.  An error form with zero error is converted to a
11576 regular number by the Calculator.
11578 All arithmetic and transcendental functions accept error forms as input.
11579 Operations on the mean-value part work just like operations on regular
11580 numbers.  The error part for any function @expr{f(x)} (such as 
11581 @texline @math{\sin x}
11582 @infoline @expr{sin(x)})
11583 is defined by the error of @expr{x} times the derivative of @expr{f}
11584 evaluated 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
11586 of the squares of the errors due to @expr{x} and @expr{y}.
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
11599 Note that this
11600 definition assumes the errors in @expr{x} and @expr{y} are uncorrelated.
11601 A side effect of this definition is that @samp{(2 +/- 1) * (2 +/- 1)}
11602 is not the same as @samp{(2 +/- 1)^2}; the former represents the product
11603 of two independent values which happen to have the same probability
11604 distributions, and the latter is the product of one random value with itself.
11605 The former will produce an answer with less error, since on the average
11606 the two independent errors can be expected to cancel out.
11608 Consult a good text on error analysis for a discussion of the proper use
11609 of standard deviations.  Actual errors often are neither Gaussian-distributed
11610 nor uncorrelated, and the above formulas are valid only when errors
11611 are small.  As an example, the error arising from
11612 @texline `@tfn{sin(}@var{x} @tfn{+/-} @math{\sigma}@tfn{)}' 
11613 @infoline `@tfn{sin(}@var{x} @tfn{+/-} @var{sigma}@tfn{)}' 
11614 is 
11615 @texline `@math{\sigma} @tfn{abs(cos(}@var{x}@tfn{))}'.  
11616 @infoline `@var{sigma} @tfn{abs(cos(}@var{x}@tfn{))}'.  
11617 When @expr{x} is close to zero,
11618 @texline @math{\cos x}
11619 @infoline @expr{cos(x)} 
11620 is close to one so the error in the sine is close to 
11621 @texline @math{\sigma};
11622 @infoline @expr{sigma};
11623 this makes sense, since 
11624 @texline @math{\sin x}
11625 @infoline @expr{sin(x)} 
11626 is approximately @expr{x} near zero, so a given error in @expr{x} will
11627 produce about the same error in the sine.  Likewise, near 90 degrees
11628 @texline @math{\cos x}
11629 @infoline @expr{cos(x)} 
11630 is nearly zero and so the computed error is
11631 small:  The sine curve is nearly flat in that region, so an error in @expr{x}
11632 has relatively little effect on the value of 
11633 @texline @math{\sin x}.
11634 @infoline @expr{sin(x)}.  
11635 However, consider @samp{sin(90 +/- 1000)}.  The cosine of 90 is zero, so
11636 Calc will report zero error!  We get an obviously wrong result because
11637 we have violated the small-error approximation underlying the error
11638 analysis.  If the error in @expr{x} had been small, the error in
11639 @texline @math{\sin x}
11640 @infoline @expr{sin(x)} 
11641 would indeed have been negligible.
11643 @ignore
11644 @mindex p
11645 @end ignore
11646 @kindex p (error forms)
11647 @tindex +/-
11648 To 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
11650 typing @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
11652 type the @samp{+/-} symbol, or type it out by hand.
11654 Error forms and complex numbers can be mixed; the formulas shown above
11655 are used for complex numbers, too; note that if the error part evaluates
11656 to a complex number its absolute value (or the square root of the sum of
11657 the squares of the absolute values of the two error contributions) is
11658 used.  Mathematically, this corresponds to a radially symmetric Gaussian
11659 distribution of numbers on the complex plane.  However, note that Calc
11660 considers an error form with real components to represent a real number,
11661 not a complex distribution around a real mean.
11663 Error forms may also be composed of HMS forms.  For best results, both
11664 the mean and the error should be HMS forms if either one is.
11666 @ignore
11667 @starindex
11668 @end ignore
11669 @tindex sdev
11670 The algebraic function @samp{sdev(a, b)} builds the error form @samp{a +/- b}.
11672 @node Interval Forms, Incomplete Objects, Error Forms, Data Types
11673 @section Interval Forms
11675 @noindent
11676 @cindex Interval forms
11677 An @dfn{interval} is a subset of consecutive real numbers.  For example,
11678 the interval @samp{[2 ..@: 4]} represents all the numbers from 2 to 4,
11679 inclusive.  If you multiply it by the interval @samp{[0.5 ..@: 2]} you
11680 obtain @samp{[1 ..@: 8]}.  This calculation represents the fact that if
11681 you multiply some number in the range @samp{[2 ..@: 4]} by some other
11682 number in the range @samp{[0.5 ..@: 2]}, your result will lie in the range
11683 from 1 to 8.  Interval arithmetic is used to get a worst-case estimate
11684 of the possible range of values a computation will produce, given the
11685 set of possible values of the input.
11687 @ifinfo
11688 Calc supports several varieties of intervals, including @dfn{closed}
11689 intervals 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
11692 uses a round parenthesis and the other a square bracket.  In mathematical
11693 terms,
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}.
11698 @end ifinfo
11699 @tex
11700 Calc supports several varieties of intervals, including \dfn{closed}
11701 intervals 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
11704 uses a round parenthesis and the other a square bracket.  In mathematical
11705 terms,
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
11714 The 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
11716 real-valued, or @samp{-inf} and @samp{inf}.  In general the lower limit
11717 must be less than the upper limit.  A closed interval containing only
11718 one value, @samp{[3 ..@: 3]}, is converted to a plain number (3)
11719 automatically.  An interval containing no values at all (such as
11720 @samp{[3 ..@: 2]} or @samp{[2 ..@: 2)}) can be represented but is not
11721 guaranteed to behave well when used in arithmetic.  Note that the
11722 interval @samp{[3 .. inf)} represents all real numbers greater than
11723 or equal to 3, and @samp{(-inf .. inf)} represents all real numbers.
11724 In fact, @samp{[-inf .. inf]} represents all real numbers including
11725 the real infinities.
11727 Intervals are entered in the notation shown here, either as algebraic
11728 formulas, or using incomplete forms.  (@xref{Incomplete Objects}.)
11729 In algebraic formulas, multiple periods in a row are collected from
11730 left to right, so that @samp{1...1e2} is interpreted as @samp{1.0 ..@: 1e2}
11731 rather than @samp{1 ..@: 0.1e2}.  Add spaces or zeros if you want to
11732 get the other interpretation.  If you omit the lower or upper limit,
11733 a default of @samp{-inf} or @samp{inf} (respectively) is furnished.
11735 Infinite mode also affects operations on intervals
11736 (@pxref{Infinities}).  Calc will always introduce an open infinity,
11737 as in @samp{1 / (0 .. 2] = [0.5 .. inf)}.  But closed infinities,
11738 @w{@samp{1 / [0 .. 2] = [0.5 .. inf]}}, arise only in Infinite mode;
11739 otherwise they are left unevaluated.  Note that the ``direction'' of
11740 a zero is not an issue in this case since the zero is always assumed
11741 to be continuous with the rest of the interval.  For intervals that
11742 contain zero inside them Calc is forced to give the result,
11743 @samp{1 / (-2 .. 2) = [-inf .. inf]}.
11745 While it may seem that intervals and error forms are similar, they are
11746 based on entirely different concepts of inexact quantities.  An error
11747 form 
11748 @texline `@var{x} @tfn{+/-} @math{\sigma}' 
11749 @infoline `@var{x} @tfn{+/-} @var{sigma}' 
11750 means a variable is random, and its value could
11751 be anything but is ``probably'' within one 
11752 @texline @math{\sigma} 
11753 @infoline @var{sigma} 
11754 of the mean value @expr{x}. An interval 
11755 `@tfn{[}@var{a} @tfn{..@:} @var{b}@tfn{]}' means a
11756 variable's value is unknown, but guaranteed to lie in the specified
11757 range.  Error forms are statistical or ``average case'' approximations;
11758 interval arithmetic tends to produce ``worst case'' bounds on an
11759 answer.
11761 Intervals may not contain complex numbers, but they may contain
11762 HMS forms or date forms.
11764 @xref{Set Operations}, for commands that interpret interval forms
11765 as subsets of the set of real numbers.
11767 @ignore
11768 @starindex
11769 @end ignore
11770 @tindex intv
11771 The algebraic function @samp{intv(n, a, b)} builds an interval form
11772 from @samp{a} to @samp{b}; @samp{n} is an integer code which must
11773 be 0 for @samp{(..)}, 1 for @samp{(..]}, 2 for @samp{[..)}, or
11774 3 for @samp{[..]}.
11776 Please note that in fully rigorous interval arithmetic, care would be
11777 taken to make sure that the computation of the lower bound rounds toward
11778 minus infinity, while upper bound computations round toward plus
11779 infinity.  Calc's arithmetic always uses a round-to-nearest mode,
11780 which means that roundoff errors could creep into an interval
11781 calculation to produce intervals slightly smaller than they ought to
11782 be.  For example, entering @samp{[1..2]} and pressing @kbd{Q 2 ^}
11783 should 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
11785 error.
11787 @node Incomplete Objects, Variables, Interval Forms, Data Types
11788 @section Incomplete Objects
11790 @noindent
11791 @ignore
11792 @mindex [ ]
11793 @end ignore
11794 @kindex [
11795 @ignore
11796 @mindex ( )
11797 @end ignore
11798 @kindex (
11799 @kindex ,
11800 @ignore
11801 @mindex @null
11802 @end ignore
11803 @kindex ]
11804 @ignore
11805 @mindex @null
11806 @end ignore
11807 @kindex )
11808 @cindex Incomplete vectors
11809 @cindex Incomplete complex numbers
11810 @cindex Incomplete interval forms
11811 When @kbd{(} or @kbd{[} is typed to begin entering a complex number or
11812 vector, respectively, the effect is to push an @dfn{incomplete} complex
11813 number or vector onto the stack.  The @kbd{,} key adds the value(s) at
11814 the top of the stack onto the current incomplete object.  The @kbd{)}
11815 and @kbd{]} keys ``close'' the incomplete object after adding any values
11816 on the top of the stack in front of the incomplete object.
11818 As a result, the sequence of keystrokes @kbd{[ 2 , 3 @key{RET} 2 * , 9 ]}
11819 pushes the vector @samp{[2, 6, 9]} onto the stack.  Likewise, @kbd{( 1 , 2 Q )}
11820 pushes the complex number @samp{(1, 1.414)} (approximately).
11822 If several values lie on the stack in front of the incomplete object,
11823 all are collected and appended to the object.  Thus the @kbd{,} key
11824 is redundant:  @kbd{[ 2 @key{RET} 3 @key{RET} 2 * 9 ]}.  Some people
11825 prefer the equivalent @key{SPC} key to @key{RET}.
11827 As a special case, typing @kbd{,} immediately after @kbd{(}, @kbd{[}, or
11828 @kbd{,} adds a zero or duplicates the preceding value in the list being
11829 formed.  Typing @key{DEL} during incomplete entry removes the last item
11830 from the list.
11832 @kindex ;
11833 The @kbd{;} key is used in the same way as @kbd{,} to create polar complex
11834 numbers:  @kbd{( 1 ; 2 )}.  When entering a vector, @kbd{;} is useful for
11835 creating a matrix.  In particular, @kbd{[ [ 1 , 2 ; 3 , 4 ; 5 , 6 ] ]} is
11836 equivalent to @kbd{[ [ 1 , 2 ] , [ 3 , 4 ] , [ 5 , 6 ] ]}.
11838 @kindex ..
11839 @pindex calc-dots
11840 Incomplete entry is also used to enter intervals.  For example,
11841 @kbd{[ 2 ..@: 4 )} enters a semi-open interval.  Note that when you type
11842 the first period, it will be interpreted as a decimal point, but when
11843 you type a second period immediately afterward, it is re-interpreted as
11844 part of the interval symbol.  Typing @kbd{..} corresponds to executing
11845 the @code{calc-dots} command.
11847 If you find incomplete entry distracting, you may wish to enter vectors
11848 and complex numbers as algebraic formulas by pressing the apostrophe key.
11850 @node Variables, Formulas, Incomplete Objects, Data Types
11851 @section Variables
11853 @noindent
11854 @cindex Variables, in formulas
11855 A @dfn{variable} is somewhere between a storage register on a conventional
11856 calculator, and a variable in a programming language.  (In fact, a Calc
11857 variable is really just an Emacs Lisp variable that contains a Calc number
11858 or formula.)  A variable's name is normally composed of letters and digits.
11859 Calc also allows apostrophes and @code{#} signs in variable names.
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
11862 Lisp, you don't need to worry about it.  Variable names in algebraic
11863 formulas implicitly have @samp{var-} prefixed to their names.  The
11864 @samp{#} character in variable names used in algebraic formulas
11865 corresponds to a dash @samp{-} in the Lisp variable name.  If the name
11866 contains any dashes, the prefix @samp{var-} is @emph{not} automatically
11867 added.  Thus the two formulas @samp{foo + 1} and @samp{var#foo + 1} both
11868 refer to the same variable.)
11870 In a command that takes a variable name, you can either type the full
11871 name of a variable, or type a single digit to use one of the special
11872 convenience variables @code{q0} through @code{q9}.  For example,
11873 @kbd{3 s s 2} stores the number 3 in variable @code{q2}, and
11874 @w{@kbd{3 s s foo @key{RET}}} stores that number in variable
11875 @code{foo}.
11877 To push a variable itself (as opposed to the variable's value) on the
11878 stack, enter its name as an algebraic expression using the apostrophe
11879 (@key{'}) key.
11881 @kindex =
11882 @pindex calc-evaluate
11883 @cindex Evaluation of variables in a formula
11884 @cindex Variables, evaluation
11885 @cindex Formulas, evaluation
11886 The @kbd{=} (@code{calc-evaluate}) key ``evaluates'' a formula by
11887 replacing 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.
11889 Other variables are left alone.  Thus a variable that has not been
11890 stored acts like an abstract variable in algebra; a variable that has
11891 been stored acts more like a register in a traditional calculator.
11892 With a positive numeric prefix argument, @kbd{=} evaluates the top
11893 @var{n} stack entries; with a negative argument, @kbd{=} evaluates
11894 the @var{n}th stack entry.
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
11906 A 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{=},
11909 their values are calculated if necessary according to the current precision
11910 or complex polar mode.  If you wish to use these symbols for other purposes,
11911 simply undefine or redefine them using @code{calc-store}.
11913 The variables @samp{inf}, @samp{uinf}, and @samp{nan} stand for
11914 infinite or indeterminate values.  It's best not to use them as
11915 regular variables, since Calc uses special algebraic rules when
11916 it manipulates them.  Calc displays a warning message if you store
11917 a value into any of these special variables.
11919 @xref{Store and Recall}, for a discussion of commands dealing with variables.
11921 @node Formulas, , Variables, Data Types
11922 @section Formulas
11924 @noindent
11925 @cindex Formulas
11926 @cindex Expressions
11927 @cindex Operators in formulas
11928 @cindex Precedence of operators
11929 When you press the apostrophe key you may enter any expression or formula
11930 in algebraic form.  (Calc uses the terms ``expression'' and ``formula''
11931 interchangeably.)  An expression is built up of numbers, variable names,
11932 and function calls, combined with various arithmetic operators.
11933 Parentheses may
11934 be used to indicate grouping.  Spaces are ignored within formulas, except
11935 that spaces are not permitted within variable names or numbers.
11936 Arithmetic operators, in order from highest to lowest precedence, and
11937 with their equivalent function names, are:
11939 @samp{_} [@code{subscr}] (subscripts);
11941 postfix @samp{%} [@code{percent}] (as in @samp{25% = 0.25});
11943 prefix @samp{+} and @samp{-} [@code{neg}] (as in @samp{-x})
11944 and prefix @samp{!} [@code{lnot}] (logical ``not,'' as in @samp{!x});
11946 @samp{+/-} [@code{sdev}] (the standard deviation symbol) and
11947 @samp{mod} [@code{makemod}] (the symbol for modulo forms);
11949 postfix @samp{!} [@code{fact}] (factorial, as in @samp{n!})
11950 and postfix @samp{!!} [@code{dfact}] (double factorial);
11952 @samp{^} [@code{pow}] (raised-to-the-power-of);
11954 @samp{*} [@code{mul}];
11956 @samp{/} [@code{div}], @samp{%} [@code{mod}] (modulo), and
11957 @samp{\} [@code{idiv}] (integer division);
11959 infix @samp{+} [@code{add}] and @samp{-} [@code{sub}] (as in @samp{x-y});
11961 @samp{|} [@code{vconcat}] (vector concatenation);
11963 relations @samp{=} [@code{eq}], @samp{!=} [@code{neq}], @samp{<} [@code{lt}],
11964 @samp{>} [@code{gt}], @samp{<=} [@code{leq}], and @samp{>=} [@code{geq}];
11966 @samp{&&} [@code{land}] (logical ``and'');
11968 @samp{||} [@code{lor}] (logical ``or'');
11970 the C-style ``if'' operator @samp{a?b:c} [@code{if}];
11972 @samp{!!!} [@code{pnot}] (rewrite pattern ``not'');
11974 @samp{&&&} [@code{pand}] (rewrite pattern ``and'');
11976 @samp{|||} [@code{por}] (rewrite pattern ``or'');
11978 @samp{:=} [@code{assign}] (for assignments and rewrite rules);
11980 @samp{::} [@code{condition}] (rewrite pattern condition);
11982 @samp{=>} [@code{evalto}].
11984 Note that, unlike in usual computer notation, multiplication binds more
11985 strongly than division:  @samp{a*b/c*d} is equivalent to 
11986 @texline @math{a b \over c d}.
11987 @infoline @expr{(a*b)/(c*d)}.
11989 @cindex Multiplication, implicit
11990 @cindex Implicit multiplication
11991 The multiplication sign @samp{*} may be omitted in many cases.  In particular,
11992 if the righthand side is a number, variable name, or parenthesized
11993 expression, the @samp{*} may be omitted.  Implicit multiplication has the
11994 same precedence as the explicit @samp{*} operator.  The one exception to
11995 the rule is that a variable name followed by a parenthesized expression,
11996 as in @samp{f(x)},
11997 is interpreted as a function call, not an implicit @samp{*}.  In many
11998 cases you must use a space if you omit the @samp{*}:  @samp{2a} is the
11999 same as @samp{2*a}, and @samp{a b} is the same as @samp{a*b}, but @samp{ab}
12000 is a variable called @code{ab}, @emph{not} the product of @samp{a} and
12001 @samp{b}!  Also note that @samp{f (x)} is still a function call.
12003 @cindex Implicit comma in vectors
12004 The rules are slightly different for vectors written with square brackets.
12005 In vectors, the space character is interpreted (like the comma) as a
12006 separator of elements of the vector.  Thus @w{@samp{[ 2a b+c d ]}} is
12007 equivalent to @samp{[2*a, b+c, d]}, whereas @samp{2a b+c d} is equivalent
12008 to @samp{2*a*b + c*d}.
12009 Note that spaces around the brackets, and around explicit commas, are
12010 ignored.  To force spaces to be interpreted as multiplication you can
12011 enclose a formula in parentheses as in @samp{[(a b) 2(c d)]}, which is
12012 interpreted as @samp{[a*b, 2*c*d]}.  An implicit comma is also inserted
12013 between @samp{][}, as in the matrix @samp{[[1 2][3 4]]}.
12015 Vectors that contain commas (not embedded within nested parentheses or
12016 brackets) do not treat spaces specially:  @samp{[a b, 2 c d]} is a vector
12017 of two elements.  Also, if it would be an error to treat spaces as
12018 separators, 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
12020 a vector of two elements.  Finally, vectors entered with curly braces
12021 instead of square brackets do not give spaces any special treatment.
12022 When Calc displays a vector that does not contain any commas, it will
12023 insert parentheses if necessary to make the meaning clear:
12024 @w{@samp{[(a b)]}}.
12026 The expression @samp{5%-2} is ambiguous; is this five-percent minus two,
12027 or five modulo minus-two?  Calc always interprets the leftmost symbol as
12028 an infix operator preferentially (modulo, in this case), so you would
12029 need to write @samp{(5%)-2} to get the former interpretation.
12031 @cindex Function call notation
12032 A 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},
12034 but unless you access the function from within Emacs Lisp, you don't
12035 need to worry about it.)  Most mathematical Calculator commands like
12036 @code{calc-sin} have function equivalents like @code{sin}.
12037 If no Lisp function is defined for a function called by a formula, the
12038 call is left as it is during algebraic manipulation: @samp{f(x+y)} is
12039 left alone.  Beware that many innocent-looking short names like @code{in}
12040 and @code{re} have predefined meanings which could surprise you; however,
12041 single letters or single letters followed by digits are always safe to
12042 use for your own function names.  @xref{Function Index}.
12044 In 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
12046 command @kbd{M-x calc-sinh}, and the algebraic function @code{sinh(x)} all
12047 represent the same operation.
12049 Commands that interpret (``parse'') text as algebraic formulas include
12050 algebraic entry (@kbd{'}), editing commands like @kbd{`} which parse
12051 the contents of the editing buffer when you finish, the @kbd{M-# g}
12052 and @w{@kbd{M-# r}} commands, the @kbd{C-y} command, the X window system
12053 ``paste'' mouse operation, and Embedded mode.  All of these operations
12054 use the same rules for parsing formulas; in particular, language modes
12055 (@pxref{Language Modes}) affect them all in the same way.
12057 When you read a large amount of text into the Calculator (say a vector
12058 which represents a big set of rewrite rules; @pxref{Rewrite Rules}),
12059 you may wish to include comments in the text.  Calc's formula parser
12060 ignores the symbol @samp{%%} and anything following it on a line:
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
12069 @noindent
12070 This is parsed exactly the same as @samp{[ a + b, c + d, e + f ]}.
12072 @xref{Syntax Tables}, for a way to create your own operators and other
12073 input notations.  @xref{Compositions}, for a way to create new display
12074 formats.
12076 @xref{Algebra}, for commands for manipulating formulas symbolically.
12078 @node Stack and Trail, Mode Settings, Data Types, Top
12079 @chapter Stack and Trail Commands
12081 @noindent
12082 This chapter describes the Calc commands for manipulating objects on the
12083 stack and in the trail buffer.  (These commands operate on objects of any
12084 type, such as numbers, vectors, formulas, and incomplete objects.)
12086 @menu
12087 * Stack Manipulation::
12088 * Editing Stack Entries::
12089 * Trail Commands::
12090 * Keep Arguments::
12091 @end menu
12093 @node Stack Manipulation, Editing Stack Entries, Stack and Trail, Stack and Trail
12094 @section Stack Manipulation Commands
12096 @noindent
12097 @kindex @key{RET}
12098 @kindex @key{SPC}
12099 @pindex calc-enter
12100 @cindex Duplicating stack entries
12101 To duplicate the top object on the stack, press @key{RET} or @key{SPC}
12102 (two equivalent keys for the @code{calc-enter} command).
12103 Given a positive numeric prefix argument, these commands duplicate
12104 several elements at the top of the stack.
12105 Given a negative argument,
12106 these commands duplicate the specified element of the stack.
12107 Given an argument of zero, they duplicate the entire stack.
12108 For 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
12112 @kbd{C-u 0 @key{RET}} creates @samp{10 20 30 10 20 30}.
12114 @kindex @key{LFD}
12115 @pindex calc-over
12116 The @key{LFD} (@code{calc-over}) command (on a key marked Line-Feed if you
12117 have it, else on @kbd{C-j}) is like @code{calc-enter}
12118 except that the sign of the numeric prefix argument is interpreted
12119 oppositely.  Also, with no prefix argument the default argument is 2.
12120 Thus with @samp{10 20 30} on the stack, @key{LFD} and @kbd{C-u 2 @key{LFD}}
12121 are both equivalent to @kbd{C-u - 2 @key{RET}}, producing
12122 @samp{10 20 30 20}.
12124 @kindex @key{DEL}
12125 @kindex C-d
12126 @pindex calc-pop
12127 @cindex Removing stack entries
12128 @cindex Deleting stack entries
12129 To remove the top element from the stack, press @key{DEL} (@code{calc-pop}).
12130 The @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
12132 last element is removed from it.)  Given a positive numeric prefix argument,
12133 several elements are removed.  Given a negative argument, the specified
12134 element of the stack is deleted.  Given an argument of zero, the entire
12135 stack is emptied.
12136 For 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
12140 @kbd{C-u 0 @key{DEL}} leaves an empty stack.
12142 @kindex M-@key{DEL}
12143 @pindex calc-pop-above
12144 The @kbd{M-@key{DEL}} (@code{calc-pop-above}) command is to @key{DEL} what
12145 @key{LFD} is to @key{RET}:  It interprets the sign of the numeric
12146 prefix argument in the opposite way, and the default argument is 2.
12147 Thus @kbd{M-@key{DEL}} by itself removes the second-from-top stack element,
12148 leaving the first, third, fourth, and so on; @kbd{M-3 M-@key{DEL}} deletes
12149 the third stack element.
12151 @kindex @key{TAB}
12152 @pindex calc-roll-down
12153 To exchange the top two elements of the stack, press @key{TAB}
12154 (@code{calc-roll-down}).  Given a positive numeric prefix argument, the
12155 specified number of elements at the top of the stack are rotated downward.
12156 Given a negative argument, the entire stack is rotated downward the specified
12157 number of times.  Given an argument of zero, the entire stack is reversed
12158 top-for-bottom.
12159 For 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
12163 @kbd{C-u 0 @key{TAB}} creates @samp{50 40 30 20 10}.
12165 @kindex M-@key{TAB}
12166 @pindex calc-roll-up
12167 The command @kbd{M-@key{TAB}} (@code{calc-roll-up}) is analogous to @key{TAB}
12168 except that it rotates upward instead of downward.  Also, the default
12169 with no prefix argument is to rotate the top 3 elements.
12170 For example, with @samp{10 20 30 40 50} on the stack,
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
12174 @kbd{C-u 0 M-@key{TAB}} creates @samp{50 40 30 20 10}.
12176 A good way to view the operation of @key{TAB} and @kbd{M-@key{TAB}} is in
12177 terms of moving a particular element to a new position in the stack.
12178 With a positive argument @var{n}, @key{TAB} moves the top stack
12179 element down to level @var{n}, making room for it by pulling all the
12180 intervening stack elements toward the top.  @kbd{M-@key{TAB}} moves the
12181 element at level @var{n} up to the top.  (Compare with @key{LFD},
12182 which copies instead of moving the element in level @var{n}.)
12184 With a negative argument @mathit{-@var{n}}, @key{TAB} rotates the stack
12185 to move the object in level @var{n} to the deepest place in the
12186 stack, and the object in level @mathit{@var{n}+1} to the top.  @kbd{M-@key{TAB}}
12187 rotates the deepest stack element to be in level @mathit{n}, also
12188 putting the top stack element in level @mathit{@var{n}+1}.
12190 @xref{Selecting Subformulas}, for a way to apply these commands to
12191 any portion of a vector or formula on the stack.
12193 @node Editing Stack Entries, Trail Commands, Stack Manipulation, Stack and Trail
12194 @section Editing Stack Entries
12196 @noindent
12197 @kindex `
12198 @pindex calc-edit
12199 @pindex calc-edit-finish
12200 @cindex Editing the stack with Emacs
12201 The backquote, @kbd{`} (@code{calc-edit}) command creates a temporary
12202 buffer (@samp{*Calc Edit*}) for editing the top-of-stack value using
12203 regular Emacs commands.  With a numeric prefix argument, it edits the
12204 specified number of stack entries at once.  (An argument of zero edits
12205 the entire stack; a negative argument edits one specific stack entry.)
12207 When you are done editing, press @kbd{C-c C-c} to finish and return
12208 to Calc.  The @key{RET} and @key{LFD} keys also work to finish most
12209 sorts of editing, though in some cases Calc leaves @key{RET} with its
12210 usual meaning (``insert a newline'') if it's a situation where you
12211 might want to insert new lines into the editing buffer.
12213 When you finish editing, the Calculator parses the lines of text in
12214 the @samp{*Calc Edit*} buffer as numbers or formulas, replaces the
12215 original stack elements in the original buffer with these new values,
12216 then kills the @samp{*Calc Edit*} buffer.  The original Calculator buffer
12217 continues to exist during editing, but for best results you should be
12218 careful not to change it until you have finished the edit.  You can
12219 also cancel the edit by killing the buffer with @kbd{C-x k}.
12221 The formula is normally reevaluated as it is put onto the stack.
12222 For example, editing @samp{a + 2} to @samp{3 + 2} and pressing
12223 @kbd{C-c C-c} will push 5 on the stack.  If you use @key{LFD} to
12224 finish, Calc will put the result on the stack without evaluating it.
12226 If you give a prefix argument to @kbd{C-c C-c},
12227 Calc will not kill the @samp{*Calc Edit*} buffer.  You can switch
12228 back to that buffer and continue editing if you wish.  However, you
12229 should understand that if you initiated the edit with @kbd{`}, the
12230 @kbd{C-c C-c} operation will be programmed to replace the top of the
12231 stack with the new edited value, and it will do this even if you have
12232 rearranged the stack in the meanwhile.  This is not so much of a problem
12233 with other editing commands, though, such as @kbd{s e}
12234 (@code{calc-edit-variable}; @pxref{Operations on Variables}).
12236 If the @code{calc-edit} command involves more than one stack entry,
12237 each line of the @samp{*Calc Edit*} buffer is interpreted as a
12238 separate formula.  Otherwise, the entire buffer is interpreted as
12239 one 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}.)
12242 The @kbd{`} key also works during numeric or algebraic entry.  The
12243 text entered so far is moved to the @code{*Calc Edit*} buffer for
12244 more extensive editing than is convenient in the minibuffer.
12246 @node Trail Commands, Keep Arguments, Editing Stack Entries, Stack and Trail
12247 @section Trail Commands
12249 @noindent
12250 @cindex Trail buffer
12251 The commands for manipulating the Calc Trail buffer are two-key sequences
12252 beginning with the @kbd{t} prefix.
12254 @kindex t d
12255 @pindex calc-trail-display
12256 The @kbd{t d} (@code{calc-trail-display}) command turns display of the
12257 trail on and off.  Normally the trail display is toggled on if it was off,
12258 off if it was on.  With a numeric prefix of zero, this command always
12259 turns the trail off; with a prefix of one, it always turns the trail on.
12260 The other trail-manipulation commands described here automatically turn
12261 the trail on.  Note that when the trail is off values are still recorded
12262 there; they are simply not displayed.  To set Emacs to turn the trail
12263 off by default, type @kbd{t d} and then save the mode settings with
12264 @kbd{m m} (@code{calc-save-modes}).
12266 @kindex t i
12267 @pindex calc-trail-in
12268 @kindex t o
12269 @pindex calc-trail-out
12270 The @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
12272 Calc Trail window.  In practice they are rarely used, since the commands
12273 shown below are a more convenient way to move around in the
12274 trail, and they work ``by remote control'' when the cursor is still
12275 in the Calculator window.
12277 @cindex Trail pointer
12278 There is a @dfn{trail pointer} which selects some entry of the trail at
12279 any given time.  The trail pointer looks like a @samp{>} symbol right
12280 before the selected number.  The following commands operate on the
12281 trail pointer in various ways.
12283 @kindex t y
12284 @pindex calc-trail-yank
12285 @cindex Retrieving previous results
12286 The @kbd{t y} (@code{calc-trail-yank}) command reads the selected value in
12287 the trail and pushes it onto the Calculator stack.  It allows you to
12288 re-use any previously computed value without retyping.  With a numeric
12289 prefix argument @var{n}, it yanks the value @var{n} lines above the current
12290 trail pointer.
12292 @kindex t <
12293 @pindex calc-trail-scroll-left
12294 @kindex t >
12295 @pindex calc-trail-scroll-right
12296 The @kbd{t <} (@code{calc-trail-scroll-left}) and @kbd{t >}
12297 (@code{calc-trail-scroll-right}) commands horizontally scroll the trail
12298 window left or right by one half of its width.
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
12308 The @kbd{t n} (@code{calc-trail-next}) and @kbd{t p}
12309 (@code{calc-trail-previous)} commands move the trail pointer down or up
12310 one 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
12312 one screenful at a time.  All of these commands accept numeric prefix
12313 arguments to move several lines or screenfuls at a time.
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
12321 The @kbd{t [} (@code{calc-trail-first}) and @kbd{t ]}
12322 (@code{calc-trail-last}) commands move the trail pointer to the first or
12323 last line of the trail.  The @kbd{t h} (@code{calc-trail-here}) command
12324 moves the trail pointer to the cursor position; unlike the other trail
12325 commands, @kbd{t h} works only when Calc Trail is the selected window.
12327 @kindex t s
12328 @pindex calc-trail-isearch-forward
12329 @kindex t r
12330 @pindex calc-trail-isearch-backward
12331 @ifinfo
12332 The @kbd{t s} (@code{calc-trail-isearch-forward}) and @kbd{t r}
12333 (@code{calc-trail-isearch-backward}) commands perform an incremental
12334 search forward or backward through the trail.  You can press @key{RET}
12335 to terminate the search; the trail pointer moves to the current line.
12336 If you cancel the search with @kbd{C-g}, the trail pointer stays where
12337 it was when the search began.
12338 @end ifinfo
12339 @tex
12340 The @kbd{t s} (@code{calc-trail-isearch-forward}) and @kbd{t r}
12341 (@code{calc-trail-isearch-backward}) com\-mands perform an incremental
12342 search forward or backward through the trail.  You can press @key{RET}
12343 to terminate the search; the trail pointer moves to the current line.
12344 If you cancel the search with @kbd{C-g}, the trail pointer stays where
12345 it was when the search began.
12346 @end tex
12348 @kindex t m
12349 @pindex calc-trail-marker
12350 The @kbd{t m} (@code{calc-trail-marker}) command allows you to enter a
12351 line of text of your own choosing into the trail.  The text is inserted
12352 after the line containing the trail pointer; this usually means it is
12353 added to the end of the trail.  Trail markers are useful mainly as the
12354 targets for later incremental searches in the trail.
12356 @kindex t k
12357 @pindex calc-trail-kill
12358 The @kbd{t k} (@code{calc-trail-kill}) command removes the selected line
12359 from the trail.  The line is saved in the Emacs kill ring suitable for
12360 yanking into another buffer, but it is not easy to yank the text back
12361 into the trail buffer.  With a numeric prefix argument, this command
12362 kills the @var{n} lines below or above the selected one.
12364 The @kbd{t .} (@code{calc-full-trail-vectors}) command is described
12365 elsewhere; @pxref{Vector and Matrix Formats}.
12367 @node Keep Arguments, , Trail Commands, Stack and Trail
12368 @section Keep Arguments
12370 @noindent
12371 @kindex K
12372 @pindex calc-keep-args
12373 The @kbd{K} (@code{calc-keep-args}) command acts like a prefix for
12374 the following command.  It prevents that command from removing its
12375 arguments from the stack.  For example, after @kbd{2 @key{RET} 3 +},
12376 the stack contains the sole number 5, but after @kbd{2 @key{RET} 3 K +},
12377 the stack contains the arguments and the result: @samp{2 3 5}.
12379 With the exception of keyboard macros, this works for all commands that
12380 take arguments off the stack. (To avoid potentially unpleasant behavior,
12381 a @kbd{K} prefix before a keyboard macro will be ignored.  A @kbd{K}
12382 prefix called @emph{within} the keyboard macro will still take effect.)  
12383 As another example, @kbd{K a s} simplifies a formula, pushing the
12384 simplified version of the formula onto the stack after the original
12385 formula (rather than replacing the original formula).  Note that you
12386 could get the same effect by typing @kbd{@key{RET} a s}, copying the
12387 formula and then simplifying the copy. One difference is that for a very
12388 large 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
12390 extra work. 
12392 Even stack manipulation commands are affected.  @key{TAB} works by
12393 popping two values and pushing them back in the opposite order,
12394 so @kbd{2 @key{RET} 3 K @key{TAB}} produces @samp{2 3 3 2}.
12396 A few Calc commands provide other ways of doing the same thing.
12397 For example, @kbd{' sin($)} replaces the number on the stack with
12398 its sine using algebraic entry; to push the sine and keep the
12399 original argument you could use either @kbd{' sin($1)} or
12400 @kbd{K ' sin($)}.  @xref{Algebraic Entry}.  Also, the @kbd{s s}
12401 command is effectively the same as @kbd{K s t}.  @xref{Storing Variables}.
12403 If you execute a command and then decide you really wanted to keep
12404 the argument, you can press @kbd{M-@key{RET}} (@code{calc-last-args}).
12405 This command pushes the last arguments that were popped by any command
12406 onto the stack.  Note that the order of things on the stack will be
12407 different 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}.
12410 @node Mode Settings, Arithmetic, Stack and Trail, Top
12411 @chapter Mode Settings
12413 @noindent
12414 This chapter describes commands that set modes in the Calculator.
12415 They do not affect the contents of the stack, although they may change
12416 the @emph{appearance} or @emph{interpretation} of the stack's contents.
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
12431 @node General Mode Commands, Precision, Mode Settings, Mode Settings
12432 @section General Mode Commands
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
12440 @cindex Calc init file, mode settings
12441 You 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.
12444 This will cause Emacs to reestablish these modes each time it starts up.
12445 The modes saved in the file include everything controlled by the @kbd{m}
12446 and @kbd{d} prefix keys, the current precision and binary word size,
12447 whether or not the trail is displayed, the current height of the Calc
12448 window, and more.  The current interface (used when you type @kbd{M-#
12449 M-#}) is also saved.  If there were already saved mode settings in the
12450 file, they are replaced.  Otherwise, the new mode information is
12451 appended to the end of the file.
12453 @kindex m R
12454 @pindex calc-mode-record-mode
12455 The @kbd{m R} (@code{calc-mode-record-mode}) command tells Calc to
12456 record all the mode settings (as if by pressing @kbd{m m}) every
12457 time a mode setting changes.  If the modes are saved this way, then this
12458 ``automatic mode recording'' mode is also saved.
12459 Type @kbd{m R} again to disable this method of recording the mode
12460 settings.  To turn it off permanently, the @kbd{m m} command will also be
12461 necessary.   (If Embedded mode is enabled, other options for recording
12462 the modes are available; @pxref{Mode Settings in Embedded Mode}.)
12464 @kindex m F
12465 @pindex calc-settings-file-name
12466 The @kbd{m F} (@code{calc-settings-file-name}) command allows you to
12467 choose a different file than the current value of @code{calc-settings-file}
12468 for @kbd{m m}, @kbd{Z P}, and similar commands to save permanent information.
12469 You are prompted for a file name.  All Calc modes are then reset to
12470 their default values, then settings from the file you named are loaded
12471 if this file exists, and this file becomes the one that Calc will
12472 use in the future for commands like @kbd{m m}.  The default settings
12473 file name is @file{~/.calc.el}.  You can see the current file name by
12474 giving a blank response to the @kbd{m F} prompt.  See also the
12475 discussion of the @code{calc-settings-file} variable; @pxref{Customizable Variables}.
12477 If 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
12479 is because your user init file may contain other things you don't want
12480 to reread.  You can give 
12481 a numeric prefix argument of 1 to @kbd{m F} to force it to read the
12482 file no matter what.  Conversely, an argument of @mathit{-1} tells
12483 @kbd{m F} @emph{not} to read the new file.  An argument of 2 or @mathit{-2}
12484 tells @kbd{m F} not to reset the modes to their defaults beforehand,
12485 which is useful if you intend your new file to have a variant of the
12486 modes present in the file you were using before.
12488 @kindex m x
12489 @pindex calc-always-load-extensions
12490 The @kbd{m x} (@code{calc-always-load-extensions}) command enables a mode
12491 in which the first use of Calc loads the entire program, including all
12492 extensions modules.  Otherwise, the extensions modules will not be loaded
12493 until the various advanced Calc features are used.  Since this mode only
12494 has 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
12496 once, rather than always in the future, you can press @kbd{M-# L}.
12498 @kindex m S
12499 @pindex calc-shift-prefix
12500 The @kbd{m S} (@code{calc-shift-prefix}) command enables a mode in which
12501 all of Calc's letter prefix keys may be typed shifted as well as unshifted.
12502 If you are typing, say, @kbd{a S} (@code{calc-solve-for}) quite often
12503 you 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
12505 be on those single shifted letters (e.g., @kbd{A} (@code{calc-abs})) can
12506 now be invoked by pressing the shifted letter twice: @kbd{A A}.  Note
12507 that the @kbd{v} prefix key always works both shifted and unshifted, and
12508 the @kbd{z} and @kbd{Z} prefix keys are always distinct.  Also, the @kbd{h}
12509 prefix is not affected by this mode.  Press @kbd{m S} again to disable
12510 shifted-prefix mode.
12512 @node Precision, Inverse and Hyperbolic, General Mode Commands, Mode Settings
12513 @section Precision
12515 @noindent
12516 @kindex p
12517 @pindex calc-precision
12518 @cindex Precision of calculations
12519 The @kbd{p} (@code{calc-precision}) command controls the precision to
12520 which floating-point calculations are carried.  The precision must be
12521 at least 3 digits and may be arbitrarily high, within the limits of
12522 memory and time.  This affects only floats:  Integer and rational
12523 calculations are always carried out with as many digits as necessary.
12525 The @kbd{p} key prompts for the current precision.  If you wish you
12526 can instead give the precision as a numeric prefix argument.
12528 Many internal calculations are carried to one or two digits higher
12529 precision than normal.  Results are rounded down afterward to the
12530 current precision.  Unless a special display mode has been selected,
12531 floats are always displayed with their full stored precision, i.e.,
12532 what you see is what you get.  Reducing the current precision does not
12533 round values already on the stack, but those values will be rounded
12534 down before being used in any calculation.  The @kbd{c 0} through
12535 @kbd{c 9} commands (@pxref{Conversions}) can be used to round an
12536 existing value to a new precision.
12538 @cindex Accuracy of calculations
12539 It is important to distinguish the concepts of @dfn{precision} and
12540 @dfn{accuracy}.  In the normal usage of these words, the number
12541 123.4567 has a precision of 7 digits but an accuracy of 4 digits.
12542 The precision is the total number of digits not counting leading
12543 or trailing zeros (regardless of the position of the decimal point).
12544 The accuracy is simply the number of digits after the decimal point
12545 (again not counting trailing zeros).  In Calc you control the precision,
12546 not the accuracy of computations.  If you were to set the accuracy
12547 instead, then calculations like @samp{exp(100)} would generate many
12548 more digits than you would typically need, while @samp{exp(-100)} would
12549 probably round to zero!  In Calc, both these computations give you
12550 exactly 12 (or the requested number of) significant digits.
12552 The only Calc features that deal with accuracy instead of precision
12553 are fixed-point display mode for floats (@kbd{d f}; @pxref{Float Formats}),
12554 and the rounding functions like @code{floor} and @code{round}
12555 (@pxref{Integer Truncation}).  Also, @kbd{c 0} through @kbd{c 9}
12556 deal with both precision and accuracy depending on the magnitudes
12557 of the numbers involved.
12559 If you need to work with a particular fixed accuracy (say, dollars and
12560 cents with two digits after the decimal point), one solution is to work
12561 with integers and an ``implied'' decimal point.  For example, $8.99
12562 divided by 6 would be entered @kbd{899 @key{RET} 6 /}, yielding 149.833
12563 (actually $1.49833 with our implied decimal point); pressing @kbd{R}
12564 would round this to 150 cents, i.e., $1.50.
12566 @xref{Floats}, for still more on floating-point precision and related
12567 issues.
12569 @node Inverse and Hyperbolic, Calculation Modes, Precision, Mode Settings
12570 @section Inverse and Hyperbolic Flags
12572 @noindent
12573 @kindex I
12574 @pindex calc-inverse
12575 There is no single-key equivalent to the @code{calc-arcsin} function.
12576 Instead, you must first press @kbd{I} (@code{calc-inverse}) to set
12577 the @dfn{Inverse Flag}, then press @kbd{S} (@code{calc-sin}).
12578 The @kbd{I} key actually toggles the Inverse Flag.  When this flag
12579 is set, the word @samp{Inv} appears in the mode line.
12581 @kindex H
12582 @pindex calc-hyperbolic
12583 Likewise, the @kbd{H} key (@code{calc-hyperbolic}) sets or clears the
12584 Hyperbolic Flag, which transforms @code{calc-sin} into @code{calc-sinh}.
12585 If both of these flags are set at once, the effect will be
12586 @code{calc-arcsinh}.  (The Hyperbolic flag is also used by some
12587 non-trigonometric commands; for example @kbd{H L} computes a base-10,
12588 instead of base-@mathit{e}, logarithm.)
12590 Command names like @code{calc-arcsin} are provided for completeness, and
12591 may be executed with @kbd{x} or @kbd{M-x}.  Their effect is simply to
12592 toggle the Inverse and/or Hyperbolic flags and then execute the
12593 corresponding base command (@code{calc-sin} in this case).
12595 The Inverse and Hyperbolic flags apply only to the next Calculator
12596 command, after which they are automatically cleared.  (They are also
12597 cleared if the next keystroke is not a Calc command.)  Digits you
12598 type after @kbd{I} or @kbd{H} (or @kbd{K}) are treated as prefix
12599 arguments for the next command, not as numeric entries.  The same
12600 is true of @kbd{C-u}, but not of the minus sign (@kbd{K -} means to
12601 subtract and keep arguments).
12603 The third Calc prefix flag, @kbd{K} (keep-arguments), is discussed
12604 elsewhere.  @xref{Keep Arguments}.
12606 @node Calculation Modes, Simplification Modes, Inverse and Hyperbolic, Mode Settings
12607 @section Calculation Modes
12609 @noindent
12610 The commands in this section are two-key sequences beginning with
12611 the @kbd{m} prefix.  (That's the letter @kbd{m}, not the @key{META} key.)
12612 The @samp{m a} (@code{calc-algebraic-mode}) command is described elsewhere
12613 (@pxref{Algebraic Entry}).
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
12626 @node Angular Modes, Polar Mode, Calculation Modes, Calculation Modes
12627 @subsection Angular Modes
12629 @noindent
12630 @cindex Angular mode
12631 The Calculator supports three notations for angles: radians, degrees,
12632 and degrees-minutes-seconds.  When a number is presented to a function
12633 like @code{sin} that requires an angle, the current angular mode is
12634 used to interpret the number as either radians or degrees.  If an HMS
12635 form is presented to @code{sin}, it is always interpreted as
12636 degrees-minutes-seconds.
12638 Functions that compute angles produce a number in radians, a number in
12639 degrees, or an HMS form depending on the current angular mode.  If the
12640 result is a complex number and the current mode is HMS, the number is
12641 instead expressed in degrees.  (Complex-number calculations would
12642 normally be done in Radians mode, though.  Complex numbers are converted
12643 to degrees by calculating the complex result in radians and then
12644 multiplying by 180 over @cpi{}.)
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
12652 The @kbd{m r} (@code{calc-radians-mode}), @kbd{m d} (@code{calc-degrees-mode}),
12653 and @kbd{m h} (@code{calc-hms-mode}) commands control the angular mode.
12654 The current angular mode is displayed on the Emacs mode line.
12655 The default angular mode is Degrees.
12657 @node Polar Mode, Fraction Mode, Angular Modes, Calculation Modes
12658 @subsection Polar Mode
12660 @noindent
12661 @cindex Polar mode
12662 The Calculator normally ``prefers'' rectangular complex numbers in the
12663 sense that rectangular form is used when the proper form can not be
12664 decided from the input.  This might happen by multiplying a rectangular
12665 number by a polar one, by taking the square root of a negative real
12666 number, or by entering @kbd{( 2 @key{SPC} 3 )}.
12668 @kindex m p
12669 @pindex calc-polar-mode
12670 The @kbd{m p} (@code{calc-polar-mode}) command toggles complex-number
12671 preference between rectangular and polar forms.  In Polar mode, all
12672 of the above example situations would produce polar complex numbers.
12674 @node Fraction Mode, Infinite Mode, Polar Mode, Calculation Modes
12675 @subsection Fraction Mode
12677 @noindent
12678 @cindex Fraction mode
12679 @cindex Division of integers
12680 Division of two integers normally yields a floating-point number if the
12681 result cannot be expressed as an integer.  In some cases you would
12682 rather get an exact fractional answer.  One way to accomplish this is
12683 to use the @kbd{:} (@code{calc-fdiv}) [@code{fdiv}] command, which
12684 divides 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}.
12688 @kindex m f
12689 @pindex calc-frac-mode
12690 To set the Calculator to produce fractional results for normal integer
12691 divisions, use the @kbd{m f} (@code{calc-frac-mode}) command.
12692 For example, @expr{8/4} produces @expr{2} in either mode,
12693 but @expr{6/4} produces @expr{3:2} in Fraction mode, @expr{1.5} in
12694 Float mode.
12696 At any time you can use @kbd{c f} (@code{calc-float}) to convert a
12697 fraction to a float, or @kbd{c F} (@code{calc-fraction}) to convert a
12698 float to a fraction.  @xref{Conversions}.
12700 @node Infinite Mode, Symbolic Mode, Fraction Mode, Calculation Modes
12701 @subsection Infinite Mode
12703 @noindent
12704 @cindex Infinite mode
12705 The Calculator normally treats results like @expr{1 / 0} as errors;
12706 formulas like this are left in unsimplified form.  But Calc can be
12707 put into a mode where such calculations instead produce ``infinite''
12708 results.
12710 @kindex m i
12711 @pindex calc-infinite-mode
12712 The @kbd{m i} (@code{calc-infinite-mode}) command turns this mode
12713 on and off.  When the mode is off, infinities do not arise except
12714 in calculations that already had infinities as inputs.  (One exception
12715 is that infinite open intervals like @samp{[0 .. inf)} can be
12716 generated; however, intervals closed at infinity (@samp{[0 .. inf]})
12717 will not be generated when Infinite mode is off.)
12719 With Infinite mode turned on, @samp{1 / 0} will generate @code{uinf},
12720 an undirected infinity.  @xref{Infinities}, for a discussion of the
12721 difference between @code{inf} and @code{uinf}.  Also, @expr{0 / 0}
12722 evaluates to @code{nan}, the ``indeterminate'' symbol.  Various other
12723 functions can also return infinities in this mode; for example,
12724 @samp{ln(0) = -inf}, and @samp{gamma(-7) = uinf}.  Once again,
12725 note that @samp{exp(inf) = inf} regardless of Infinite mode because
12726 this calculation has infinity as an input.
12728 @cindex Positive Infinite mode
12729 The @kbd{m i} command with a numeric prefix argument of zero,
12730 i.e., @kbd{C-u 0 m i}, turns on a Positive Infinite mode in
12731 which zero is treated as positive instead of being directionless.
12732 Thus, @samp{1 / 0 = inf} and @samp{-1 / 0 = -inf} in this mode.
12733 Note that zero never actually has a sign in Calc; there are no
12734 separate representations for @mathit{+0} and @mathit{-0}.  Positive
12735 Infinite mode merely changes the interpretation given to the
12736 single symbol, @samp{0}.  One consequence of this is that, while
12737 you might expect @samp{1 / -0 = -inf}, actually @samp{1 / -0}
12738 is equivalent to @samp{1 / 0}, which is equal to positive @code{inf}.
12740 @node Symbolic Mode, Matrix Mode, Infinite Mode, Calculation Modes
12741 @subsection Symbolic Mode
12743 @noindent
12744 @cindex Symbolic mode
12745 @cindex Inexact results
12746 Calculations are normally performed numerically wherever possible.
12747 For example, the @code{calc-sqrt} command, or @code{sqrt} function in an
12748 algebraic expression, produces a numeric answer if the argument is a
12749 number 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)}.
12752 @kindex m s
12753 @pindex calc-symbolic-mode
12754 In @dfn{Symbolic mode}, controlled by the @kbd{m s} (@code{calc-symbolic-mode})
12755 command, functions which would produce inexact, irrational results are
12756 left in symbolic form.  Thus @kbd{16 Q} pushes 4, but @kbd{2 Q} pushes
12757 @samp{sqrt(2)}.
12759 @kindex N
12760 @pindex calc-eval-num
12761 The shift-@kbd{N} (@code{calc-eval-num}) command evaluates numerically
12762 the expression at the top of the stack, by temporarily disabling
12763 @code{calc-symbolic-mode} and executing @kbd{=} (@code{calc-evaluate}).
12764 Given a numeric prefix argument, it also
12765 sets the floating-point precision to the specified value for the duration
12766 of the command.
12768 To evaluate a formula numerically without expanding the variables it
12769 contains, 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
12771 variables.)
12773 @node Matrix Mode, Automatic Recomputation, Symbolic Mode, Calculation Modes
12774 @subsection Matrix and Scalar Modes
12776 @noindent
12777 @cindex Matrix mode
12778 @cindex Scalar mode
12779 Calc sometimes makes assumptions during algebraic manipulation that
12780 are awkward or incorrect when vectors and matrices are involved.
12781 Calc has two modes, @dfn{Matrix mode} and @dfn{Scalar mode}, which
12782 modify its behavior around vectors in useful ways.
12784 @kindex m v
12785 @pindex calc-matrix-mode
12786 Press @kbd{m v} (@code{calc-matrix-mode}) once to enter Matrix mode.
12787 In this mode, all objects are assumed to be matrices unless provably
12788 otherwise.  One major effect is that Calc will no longer consider
12789 multiplication to be commutative.  (Recall that in matrix arithmetic,
12790 @samp{A*B} is not the same as @samp{B*A}.)  This assumption affects
12791 rewrite rules and algebraic simplification.  Another effect of this
12792 mode is that calculations that would normally produce constants like
12793 0 and 1 (e.g., @expr{a - a} and @expr{a / a}, respectively) will now
12794 produce function calls that represent ``generic'' zero or identity
12795 matrices: @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}
12797 identity matrix; if @var{n} is omitted, it doesn't know what
12798 dimension to use and so the @code{idn} call remains in symbolic
12799 form.  However, if this generic identity matrix is later combined
12800 with a matrix whose size is known, it will be converted into
12801 a true identity matrix of the appropriate size.  On the other hand,
12802 if it is combined with a scalar (as in @samp{idn(1) + 2}), Calc
12803 will assume it really was a scalar after all and produce, e.g., 3.
12805 Press @kbd{m v} a second time to get Scalar mode.  Here, objects are
12806 assumed @emph{not} to be vectors or matrices unless provably so.
12807 For example, normally adding a variable to a vector, as in
12808 @samp{[x, y, z] + a}, will leave the sum in symbolic form because
12809 as far as Calc knows, @samp{a} could represent either a number or
12810 another 3-vector.  In Scalar mode, @samp{a} is assumed to be a
12811 non-vector, and the addition is evaluated to @samp{[x+a, y+a, z+a]}.
12813 Press @kbd{m v} a third time to return to the normal mode of operation.
12815 If you press @kbd{m v} with a numeric prefix argument @var{n}, you
12816 get a special ``dimensioned'' Matrix mode in which matrices of
12817 unknown size are assumed to be @var{n}x@var{n} square matrices.
12818 Then, the function call @samp{idn(1)} will expand into an actual
12819 matrix rather than representing a ``generic'' matrix.
12821 @cindex Declaring scalar variables
12822 Of course these modes are approximations to the true state of
12823 affairs, which is probably that some quantities will be matrices
12824 and others will be scalars.  One solution is to ``declare''
12825 certain variables or functions to be scalar-valued.
12826 @xref{Declarations}, to see how to make declarations in Calc.
12828 There is nothing stopping you from declaring a variable to be
12829 scalar and then storing a matrix in it; however, if you do, the
12830 results you get from Calc may not be valid.  Suppose you let Calc
12831 get 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
12833 for @samp{[x, y, z] + [1, 2, 3]}, but that's because you have broken
12834 your earlier promise to Calc that @samp{a} would be scalar.
12836 Another way to mix scalars and matrices is to use selections
12837 (@pxref{Selecting Subformulas}).  Use Matrix mode when operating on
12838 your formula normally; then, to apply Scalar mode to a certain part
12839 of the formula without affecting the rest just select that part,
12840 change into Scalar mode and press @kbd{=} to resimplify the part
12841 under this mode, then change back to Matrix mode before deselecting.
12843 @node Automatic Recomputation, Working Message, Matrix Mode, Calculation Modes
12844 @subsection Automatic Recomputation
12846 @noindent
12847 The @dfn{evaluates-to} operator, @samp{=>}, has the special
12848 property that any @samp{=>} formulas on the stack are recomputed
12849 whenever variable values or mode settings that might affect them
12850 are changed.  @xref{Evaluates-To Operator}.
12852 @kindex m C
12853 @pindex calc-auto-recompute
12854 The @kbd{m C} (@code{calc-auto-recompute}) command turns this
12855 automatic recomputation on and off.  If you turn it off, Calc will
12856 not update @samp{=>} operators on the stack (nor those in the
12857 attached Embedded mode buffer, if there is one).  They will not
12858 be updated unless you explicitly do so by pressing @kbd{=} or until
12859 you press @kbd{m C} to turn recomputation back on.  (While automatic
12860 recomputation is off, you can think of @kbd{m C m C} as a command
12861 to update all @samp{=>} operators while leaving recomputation off.)
12863 To update @samp{=>} operators in an Embedded buffer while
12864 automatic recomputation is off, use @w{@kbd{M-# u}}.
12865 @xref{Embedded Mode}.
12867 @node Working Message, , Automatic Recomputation, Calculation Modes
12868 @subsection Working Messages
12870 @noindent
12871 @cindex Performance
12872 @cindex Working messages
12873 Since the Calculator is written entirely in Emacs Lisp, which is not
12874 designed for heavy numerical work, many operations are quite slow.
12875 The Calculator normally displays the message @samp{Working...} in the
12876 echo area during any command that may be slow.  In addition, iterative
12877 operations such as square roots and trigonometric functions display the
12878 intermediate result at each step.  Both of these types of messages can
12879 be disabled if you find them distracting.
12881 @kindex m w
12882 @pindex calc-working
12883 Type @kbd{m w} (@code{calc-working}) with a numeric prefix of 0 to
12884 disable all ``working'' messages.  Use a numeric prefix of 1 to enable
12885 only the plain @samp{Working...} message.  Use a numeric prefix of 2 to
12886 see intermediate results as well.  With no numeric prefix this displays
12887 the current mode.
12889 While it may seem that the ``working'' messages will slow Calc down
12890 considerably, experiments have shown that their impact is actually
12891 quite small.  But if your terminal is slow you may find that it helps
12892 to turn the messages off.
12894 @node Simplification Modes, Declarations, Calculation Modes, Mode Settings
12895 @section Simplification Modes
12897 @noindent
12898 The current @dfn{simplification mode} controls how numbers and formulas
12899 are ``normalized'' when being taken from or pushed onto the stack.
12900 Some normalizations are unavoidable, such as rounding floating-point
12901 results to the current precision, and reducing fractions to simplest
12902 form.  Others, such as simplifying a formula like @expr{a+a} (or @expr{2+3}),
12903 are done by default but can be turned off when necessary.
12905 When you press a key like @kbd{+} when @expr{2} and @expr{3} are on the
12906 stack, Calc pops these numbers, normalizes them, creates the formula
12907 @expr{2+3}, normalizes it, and pushes the result.  Of course the standard
12908 rules for normalizing @expr{2+3} will produce the result @expr{5}.
12910 Simplification mode commands consist of the lower-case @kbd{m} prefix key
12911 followed by a shifted letter.
12913 @kindex m O
12914 @pindex calc-no-simplify-mode
12915 The @kbd{m O} (@code{calc-no-simplify-mode}) command turns off all optional
12916 simplifications.  These would leave a formula like @expr{2+3} alone.  In
12917 fact, nothing except simple numbers are ever affected by normalization
12918 in this mode.
12920 @kindex m N
12921 @pindex calc-num-simplify-mode
12922 The @kbd{m N} (@code{calc-num-simplify-mode}) command turns off simplification
12923 of any formulas except those for which all arguments are constants.  For
12924 example, @expr{1+2} is simplified to @expr{3}, and @expr{a+(2-2)} is
12925 simplified to @expr{a+0} but no further, since one argument of the sum
12926 is not a constant.  Unfortunately, @expr{(a+2)-2} is @emph{not} simplified
12927 because the top-level @samp{-} operator's arguments are not both
12928 constant numbers (one of them is the formula @expr{a+2}).
12929 A constant is a number or other numeric object (such as a constant
12930 error form or modulo form), or a vector all of whose
12931 elements are constant.
12933 @kindex m D
12934 @pindex calc-default-simplify-mode
12935 The @kbd{m D} (@code{calc-default-simplify-mode}) command restores the
12936 default simplifications for all formulas.  This includes many easy and
12937 fast 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
12939 @expr{@tfn{deriv}(x^2, x)} to @expr{2 x}.
12941 @kindex m B
12942 @pindex calc-bin-simplify-mode
12943 The @kbd{m B} (@code{calc-bin-simplify-mode}) mode applies the default
12944 simplifications to a result and then, if the result is an integer,
12945 uses the @kbd{b c} (@code{calc-clip}) command to clip the integer according
12946 to the current binary word size.  @xref{Binary Functions}.  Real numbers
12947 are rounded to the nearest integer and then clipped; other kinds of
12948 results (after the default simplifications) are left alone.
12950 @kindex m A
12951 @pindex calc-alg-simplify-mode
12952 The @kbd{m A} (@code{calc-alg-simplify-mode}) mode does algebraic
12953 simplification; it applies all the default simplifications, and also
12954 the more powerful (and slower) simplifications made by @kbd{a s}
12955 (@code{calc-simplify}).  @xref{Algebraic Simplifications}.
12957 @kindex m E
12958 @pindex calc-ext-simplify-mode
12959 The @kbd{m E} (@code{calc-ext-simplify-mode}) mode does ``extended''
12960 algebraic simplification, as by the @kbd{a e} (@code{calc-simplify-extended})
12961 command.  @xref{Unsafe Simplifications}.
12963 @kindex m U
12964 @pindex calc-units-simplify-mode
12965 The @kbd{m U} (@code{calc-units-simplify-mode}) mode does units
12966 simplification; it applies the command @kbd{u s}
12967 (@code{calc-simplify-units}), which in turn
12968 is a superset of @kbd{a s}.  In this mode, variable names which
12969 are identifiable as unit names (like @samp{mm} for ``millimeters'')
12970 are simplified with their unit definitions in mind.
12972 A common technique is to set the simplification mode down to the lowest
12973 amount of simplification you will allow to be applied automatically, then
12974 use manual commands like @kbd{a s} and @kbd{c c} (@code{calc-clean}) to
12975 perform higher types of simplifications on demand.  @xref{Algebraic
12976 Definitions}, for another sample use of No-Simplification mode.
12978 @node Declarations, Display Modes, Simplification Modes, Mode Settings
12979 @section Declarations
12981 @noindent
12982 A @dfn{declaration} is a statement you make that promises you will
12983 use a certain variable or function in a restricted way.  This may
12984 give Calc the freedom to do things that it couldn't do if it had to
12985 take the fully general situation into account.
12987 @menu
12988 * Declaration Basics::
12989 * Kinds of Declarations::
12990 * Functions for Declarations::
12991 @end menu
12993 @node Declaration Basics, Kinds of Declarations, Declarations, Declarations
12994 @subsection Declaration Basics
12996 @noindent
12997 @kindex s d
12998 @pindex calc-declare-variable
12999 The @kbd{s d} (@code{calc-declare-variable}) command is the easiest
13000 way to make a declaration for a variable.  This command prompts for
13001 the variable name, then prompts for the declaration.  The default
13002 at the declaration prompt is the previous declaration, if any.
13003 You can edit this declaration, or press @kbd{C-k} to erase it and
13004 type a new declaration.  (Or, erase it and press @key{RET} to clear
13005 the declaration, effectively ``undeclaring'' the variable.)
13007 A 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,
13009 you can write it directly rather than enclosing it in a vector.
13010 For example, @kbd{s d foo @key{RET} real @key{RET}} declares @code{foo} to
13011 be a real number, and @kbd{s d bar @key{RET} [int, const, [1..6]] @key{RET}}
13012 declares @code{bar} to be a constant integer between 1 and 6.
13013 (Actually, you can omit the outermost brackets and Calc will
13014 provide them for you: @kbd{s d bar @key{RET} int, const, [1..6] @key{RET}}.)
13016 @cindex @code{Decls} variable
13017 @vindex Decls
13018 Declarations in Calc are kept in a special variable called @code{Decls}.
13019 This variable encodes the set of all outstanding declarations in
13020 the form of a matrix.  Each row has two elements:  A variable or
13021 vector of variables declared by that row, and the declaration
13022 specifier as described above.  You can use the @kbd{s D} command to
13023 edit this variable if you wish to see all the declarations at once.
13024 @xref{Operations on Variables}, for a description of this command
13025 and the @kbd{s p} command that allows you to save your declarations
13026 permanently if you wish.
13028 Items being declared can also be function calls.  The arguments in
13029 the call are ignored; the effect is to say that this function returns
13030 values of the declared type for any valid arguments.  The @kbd{s d}
13031 command declares only variables, so if you wish to make a function
13032 declaration you will have to edit the @code{Decls} matrix yourself.
13034 For example, the declaration matrix
13036 @smallexample
13037 @group
13038 [ [ foo,       real       ]
13039   [ [j, k, n], int        ]
13040   [ f(1,2,3),  [0 .. inf) ] ]
13041 @end group
13042 @end smallexample
13044 @noindent
13045 declares that @code{foo} represents a real number, @code{j}, @code{k}
13046 and @code{n} represent integers, and the function @code{f} always
13047 returns a real number in the interval shown.
13049 @vindex All
13050 If there is a declaration for the variable @code{All}, then that
13051 declaration applies to all variables that are not otherwise declared.
13052 It does not apply to function names.  For example, using the row
13053 @samp{[All, real]} says that all your variables are real unless they
13054 are explicitly declared without @code{real} in some other row.
13055 The @kbd{s d} command declares @code{All} if you give a blank
13056 response to the variable-name prompt.
13058 @node Kinds of Declarations, Functions for Declarations, Declaration Basics, Declarations
13059 @subsection Kinds of Declarations
13061 @noindent
13062 The type-specifier part of a declaration (that is, the second prompt
13063 in the @kbd{s d} command) can be a type symbol, an interval, or a
13064 vector consisting of zero or more type symbols followed by zero or
13065 more intervals or numbers that represent the set of possible values
13066 for the variable.
13068 @smallexample
13069 @group
13070 [ [ a, [1, 2, 3, 4, 5] ]
13071   [ b, [1 .. 5]        ]
13072   [ c, [int, 1 .. 5]   ] ]
13073 @end group
13074 @end smallexample
13076 Here @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
13078 since we haven't specified), and @code{c} is any integer in that
13079 interval.  Thus the declarations for @code{a} and @code{c} are
13080 nearly equivalent (see below).
13082 The type-specifier can be the empty vector @samp{[]} to say that
13083 nothing is known about a given variable's value.  This is the same
13084 as not declaring the variable at all except that it overrides any
13085 @code{All} declaration which would otherwise apply.
13087 The initial value of @code{Decls} is the empty vector @samp{[]}.
13088 If @code{Decls} has no stored value or if the value stored in it
13089 is not valid, it is ignored and there are no declarations as far
13090 as Calc is concerned.  (The @kbd{s d} command will replace such a
13091 malformed value with a fresh empty matrix, @samp{[]}, before recording
13092 the new declaration.)  Unrecognized type symbols are ignored.
13094 The following type symbols describe what sorts of numbers will be
13095 stored in a variable:
13097 @table @code
13098 @item int
13099 Integers.
13100 @item numint
13101 Numerical integers.  (Integers or integer-valued floats.)
13102 @item frac
13103 Fractions.  (Rational numbers which are not integers.)
13104 @item rat
13105 Rational numbers.  (Either integers or fractions.)
13106 @item float
13107 Floating-point numbers.
13108 @item real
13109 Real numbers.  (Integers, fractions, or floats.  Actually,
13110 intervals and error forms with real components also count as
13111 reals here.)
13112 @item pos
13113 Positive real numbers.  (Strictly greater than zero.)
13114 @item nonneg
13115 Nonnegative real numbers.  (Greater than or equal to zero.)
13116 @item number
13117 Numbers.  (Real or complex.)
13118 @end table
13120 Calc uses this information to determine when certain simplifications
13121 of formulas are safe.  For example, @samp{(x^y)^z} cannot be
13122 simplified to @samp{x^(y z)} in general; for example,
13123 @samp{((-3)^2)^1:2} is 3, but @samp{(-3)^(2*1:2) = (-3)^1} is @mathit{-3}.
13124 However, this simplification @emph{is} safe if @code{z} is known
13125 to be an integer, or if @code{x} is known to be a nonnegative
13126 real number.  If you have given declarations that allow Calc to
13127 deduce either of these facts, Calc will perform this simplification
13128 of the formula.
13130 Calc can apply a certain amount of logic when using declarations.
13131 For example, @samp{(x^y)^(2n+1)} will be simplified if @code{n}
13132 has been declared @code{int}; Calc knows that an integer times an
13133 integer, plus an integer, must always be an integer.  (In fact,
13134 Calc would simplify @samp{(-x)^(2n+1)} to @samp{-(x^(2n+1))} since
13135 it is able to determine that @samp{2n+1} must be an odd integer.)
13137 Similarly, @samp{(abs(x)^y)^z} will be simplified to @samp{abs(x)^(y z)}
13138 because Calc knows that the @code{abs} function always returns a
13139 nonnegative real.  If you had a @code{myabs} function that also had
13140 this property, you could get Calc to recognize it by adding the row
13141 @samp{[myabs(), nonneg]} to the @code{Decls} matrix.
13143 One instance of this simplification is @samp{sqrt(x^2)} (since the
13144 @code{sqrt} function is effectively a one-half power).  Normally
13145 Calc leaves this formula alone.  After the command
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
13148 simplify this formula all the way to @samp{x}.
13150 If there are any intervals or real numbers in the type specifier,
13151 they comprise the set of possible values that the variable or
13152 function 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
13156 the same as @samp{[0 .. inf]}.  Saying @samp{[real, [-5 .. 5]]} is
13157 redundant because the fact that the variable is real can be
13158 deduced just from the interval, but @samp{[int, [-5 .. 5]]} and
13159 @samp{[rat, [-5 .. 5]]} are useful combinations.
13161 Note that the vector of intervals or numbers is in the same format
13162 used by Calc's set-manipulation commands.  @xref{Set Operations}.
13164 The type specifier @samp{[1, 2, 3]} is equivalent to
13165 @samp{[numint, 1, 2, 3]}, @emph{not} to @samp{[int, 1, 2, 3]}.
13166 In other words, the range of possible values means only that
13167 the variable's value must be numerically equal to a number in
13168 that range, but not that it must be equal in type as well.
13169 Calc's set operations act the same way; @samp{in(2, [1., 2., 3.])}
13170 and @samp{in(1.5, [1:2, 3:2, 5:2])} both report ``true.''
13172 If you use a conflicting combination of type specifiers, the
13173 results are unpredictable.  An example is @samp{[pos, [0 .. 5]]},
13174 where the interval does not lie in the range described by the
13175 type symbol.
13177 ``Real'' declarations mostly affect simplifications involving powers
13178 like the one described above.  Another case where they are used
13179 is in the @kbd{a P} command which returns a list of all roots of a
13180 polynomial; if the variable has been declared real, only the real
13181 roots (if any) will be included in the list.
13183 ``Integer'' declarations are used for simplifications which are valid
13184 only when certain values are integers (such as @samp{(x^y)^z}
13185 shown above).
13187 Another command that makes use of declarations is @kbd{a s}, when
13188 simplifying equations and inequalities.  It will cancel @code{x}
13189 from both sides of @samp{a x = b x} only if it is sure @code{x}
13190 is non-zero, say, because it has a @code{pos} declaration.
13191 To declare specifically that @code{x} is real and non-zero,
13192 use @samp{[[-inf .. 0), (0 .. inf]]}.  (There is no way in the
13193 current notation to say that @code{x} is nonzero but not necessarily
13194 real.)  The @kbd{a e} command does ``unsafe'' simplifications,
13195 including cancelling @samp{x} from the equation when @samp{x} is
13196 not known to be nonzero.
13198 Another set of type symbols distinguish between scalars and vectors.
13200 @table @code
13201 @item scalar
13202 The value is not a vector.
13203 @item vector
13204 The value is a vector.
13205 @item matrix
13206 The value is a matrix (a rectangular vector of vectors).
13207 @end table
13209 These type symbols can be combined with the other type symbols
13210 described above; @samp{[int, matrix]} describes an object which
13211 is a matrix of integers.
13213 Scalar/vector declarations are used to determine whether certain
13214 algebraic operations are safe.  For example, @samp{[a, b, c] + x}
13215 is normally not simplified to @samp{[a + x, b + x, c + x]}, but
13216 it will be if @code{x} has been declared @code{scalar}.  On the
13217 other hand, multiplication is usually assumed to be commutative,
13218 but the terms in @samp{x y} will never be exchanged if both @code{x}
13219 and @code{y} are known to be vectors or matrices.  (Calc currently
13220 never distinguishes between @code{vector} and @code{matrix}
13221 declarations.)
13223 @xref{Matrix Mode}, for a discussion of Matrix mode and
13224 Scalar mode, which are similar to declaring @samp{[All, matrix]}
13225 or @samp{[All, scalar]} but much more convenient.
13227 One more type symbol that is recognized is used with the @kbd{H a d}
13228 command for taking total derivatives of a formula.  @xref{Calculus}.
13230 @table @code
13231 @item const
13232 The value is a constant with respect to other variables.
13233 @end table
13235 Calc does not check the declarations for a variable when you store
13236 a value in it.  However, storing @mathit{-3.5} in a variable that has
13237 been declared @code{pos}, @code{int}, or @code{matrix} may have
13238 unexpected effects; Calc may evaluate @samp{sqrt(x^2)} to @expr{3.5}
13239 if it substitutes the value first, or to @expr{-3.5} if @code{x}
13240 was declared @code{pos} and the formula @samp{sqrt(x^2)} is
13241 simplified to @samp{x} before the value is substituted.  Before
13242 using a variable for a new purpose, it is best to use @kbd{s d}
13243 or @kbd{s D} to check to make sure you don't still have an old
13244 declaration for the variable that will conflict with its new meaning.
13246 @node Functions for Declarations, , Kinds of Declarations, Declarations
13247 @subsection Functions for Declarations
13249 @noindent
13250 Calc has a set of functions for accessing the current declarations
13251 in a convenient manner.  These functions return 1 if the argument
13252 can be shown to have the specified property, or 0 if the argument
13253 can be shown @emph{not} to have that property; otherwise they are
13254 left unevaluated.  These functions are suitable for use with rewrite
13255 rules (@pxref{Conditional Rewrite Rules}) or programming constructs
13256 (@pxref{Conditionals in Macros}).  They can be entered only using
13257 algebraic notation.  @xref{Logical Operations}, for functions
13258 that perform other tests not related to declarations.
13260 For example, @samp{dint(17)} returns 1 because 17 is an integer, as
13261 do @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.
13263 Calc consults knowledge of its own built-in functions as well as your
13264 own declarations: @samp{dint(floor(x))} returns 1.
13266 @ignore
13267 @starindex
13268 @end ignore
13269 @tindex dint
13270 @ignore
13271 @starindex
13272 @end ignore
13273 @tindex dnumint
13274 @ignore
13275 @starindex
13276 @end ignore
13277 @tindex dnatnum
13278 The @code{dint} function checks if its argument is an integer.
13279 The @code{dnatnum} function checks if its argument is a natural
13280 number, i.e., a nonnegative integer.  The @code{dnumint} function
13281 checks if its argument is numerically an integer, i.e., either an
13282 integer or an integer-valued float.  Note that these and the other
13283 data type functions also accept vectors or matrices composed of
13284 suitable elements, and that real infinities @samp{inf} and @samp{-inf}
13285 are considered to be integers for the purposes of these functions.
13287 @ignore
13288 @starindex
13289 @end ignore
13290 @tindex drat
13291 The @code{drat} function checks if its argument is rational, i.e.,
13292 an integer or fraction.  Infinities count as rational, but intervals
13293 and error forms do not.
13295 @ignore
13296 @starindex
13297 @end ignore
13298 @tindex dreal
13299 The @code{dreal} function checks if its argument is real.  This
13300 includes integers, fractions, floats, real error forms, and intervals.
13302 @ignore
13303 @starindex
13304 @end ignore
13305 @tindex dimag
13306 The @code{dimag} function checks if its argument is imaginary,
13307 i.e., is mathematically equal to a real number times @expr{i}.
13309 @ignore
13310 @starindex
13311 @end ignore
13312 @tindex dpos
13313 @ignore
13314 @starindex
13315 @end ignore
13316 @tindex dneg
13317 @ignore
13318 @starindex
13319 @end ignore
13320 @tindex dnonneg
13321 The @code{dpos} function checks for positive (but nonzero) reals.
13322 The @code{dneg} function checks for negative reals.  The @code{dnonneg}
13323 function checks for nonnegative reals, i.e., reals greater than or
13324 equal to zero.  Note that the @kbd{a s} command can simplify an
13325 expression like @expr{x > 0} to 1 or 0 using @code{dpos}, and that
13326 @kbd{a s} is effectively applied to all conditions in rewrite rules,
13327 so the actual functions @code{dpos}, @code{dneg}, and @code{dnonneg}
13328 are rarely necessary.
13330 @ignore
13331 @starindex
13332 @end ignore
13333 @tindex dnonzero
13334 The @code{dnonzero} function checks that its argument is nonzero.
13335 This includes all nonzero real or complex numbers, all intervals that
13336 do not include zero, all nonzero modulo forms, vectors all of whose
13337 elements are nonzero, and variables or formulas whose values can be
13338 deduced to be nonzero.  It does not include error forms, since they
13339 represent values which could be anything including zero.  (This is
13340 also the set of objects considered ``true'' in conditional contexts.)
13342 @ignore
13343 @starindex
13344 @end ignore
13345 @tindex deven
13346 @ignore
13347 @starindex
13348 @end ignore
13349 @tindex dodd
13350 The @code{deven} function returns 1 if its argument is known to be
13351 an even integer (or integer-valued float); it returns 0 if its argument
13352 is known not to be even (because it is known to be odd or a non-integer).
13353 The @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.
13356 @ignore
13357 @starindex
13358 @end ignore
13359 @tindex drange
13360 The @code{drange} function returns a set (an interval or a vector
13361 of intervals and/or numbers; @pxref{Set Operations}) that describes
13362 the set of possible values of its argument.  If the argument is
13363 a variable or a function with a declaration, the range is copied
13364 from the declaration.  Otherwise, the possible signs of the
13365 expression are determined using a method similar to @code{dpos},
13366 etc., and a suitable set like @samp{[0 .. inf]} is returned.  If
13367 the expression is not provably real, the @code{drange} function
13368 remains unevaluated.
13370 @ignore
13371 @starindex
13372 @end ignore
13373 @tindex dscalar
13374 The @code{dscalar} function returns 1 if its argument is provably
13375 scalar, or 0 if its argument is provably non-scalar.  It is left
13376 unevaluated if this cannot be determined.  (If Matrix mode or Scalar
13377 mode is in effect, this function returns 1 or 0, respectively,
13378 if 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
13381 provably scalar, and @samp{!dscalar(a)} is ``true'' only if @code{a}
13382 is provably non-scalar; both are ``false'' if there is insufficient
13383 information to tell.
13385 @node Display Modes, Language Modes, Declarations, Mode Settings
13386 @section Display Modes
13388 @noindent
13389 The 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.
13393 Display formats for vectors and matrices are also covered elsewhere;
13394 @pxref{Vector and Matrix Formats}.
13396 One 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
13398 refresh the stack to leave the stack display alone.  The word ``Dirty''
13399 will appear in the mode line when Calc thinks the stack display may not
13400 reflect the latest mode settings.
13402 @kindex d @key{RET}
13403 @pindex calc-refresh-top
13404 The @kbd{d @key{RET}} (@code{calc-refresh-top}) command reformats the
13405 top stack entry according to all the current modes.  Positive prefix
13406 arguments reformat the top @var{n} entries; negative prefix arguments
13407 reformat the specified entry, and a prefix of zero is equivalent to
13408 @kbd{d @key{SPC}} (@code{calc-refresh}), which reformats the entire stack.
13409 For example, @kbd{H d s M-2 d @key{RET}} changes to scientific notation
13410 but reformats only the top two stack entries in the new mode.
13412 The @kbd{I} prefix has another effect on the display modes.  The mode
13413 is set only temporarily; the top stack entry is reformatted according
13414 to that mode, then the original mode setting is restored.  In other
13415 words, @kbd{I d s} is equivalent to @kbd{H d s d @key{RET} H d (@var{old mode})}.
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
13430 @node Radix Modes, Grouping Digits, Display Modes, Display Modes
13431 @subsection Radix Modes
13433 @noindent
13434 @cindex Radix display
13435 @cindex Non-decimal numbers
13436 @cindex Decimal and non-decimal numbers
13437 Calc normally displays numbers in decimal (@dfn{base-10} or @dfn{radix-10})
13438 notation.  Calc can actually display in any radix from two (binary) to 36.
13439 When the radix is above 10, the letters @code{A} to @code{Z} are used as
13440 digits.  When entering such a number, letter keys are interpreted as
13441 potential digits rather than terminating numeric entry mode.
13443 @kindex d 2
13444 @kindex d 8
13445 @kindex d 6
13446 @kindex d 0
13447 @cindex Hexadecimal integers
13448 @cindex Octal integers
13449 The key sequences @kbd{d 2}, @kbd{d 8}, @kbd{d 6}, and @kbd{d 0} select
13450 binary, octal, hexadecimal, and decimal as the current display radix,
13451 respectively.  Numbers can always be entered in any radix, though the
13452 current radix is used as a default if you press @kbd{#} without any initial
13453 digits.  A number entered without a @kbd{#} is @emph{always} interpreted
13454 as decimal.
13456 @kindex d r
13457 @pindex calc-radix
13458 To set the radix generally, use @kbd{d r} (@code{calc-radix}) and enter
13459 an integer from 2 to 36.  You can specify the radix as a numeric prefix
13460 argument; otherwise you will be prompted for it.
13462 @kindex d z
13463 @pindex calc-leading-zeros
13464 @cindex Leading zeros
13465 Integers normally are displayed with however many digits are necessary to
13466 represent the integer and no more.  The @kbd{d z} (@code{calc-leading-zeros})
13467 command causes integers to be padded out with leading zeros according to the
13468 current binary word size.  (@xref{Binary Functions}, for a discussion of
13469 word size.)  If the absolute value of the word size is @expr{w}, all integers
13470 are displayed with at least enough digits to represent 
13471 @texline @math{2^w-1}
13472 @infoline @expr{(2^w)-1} 
13473 in the current radix.  (Larger integers will still be displayed in their
13474 entirety.) 
13476 @node Grouping Digits, Float Formats, Radix Modes, Display Modes
13477 @subsection Grouping Digits
13479 @noindent
13480 @kindex d g
13481 @pindex calc-group-digits
13482 @cindex Grouping digits
13483 @cindex Digit grouping
13484 Long numbers can be hard to read if they have too many digits.  For
13485 example, the factorial of 30 is 33 digits long!  Press @kbd{d g}
13486 (@code{calc-group-digits}) to enable @dfn{Grouping} mode, in which digits
13487 are displayed in clumps of 3 or 4 (depending on the current radix)
13488 separated by commas.
13490 The @kbd{d g} command toggles grouping on and off.
13491 With a numeric prefix of 0, this command displays the current state of
13492 the grouping flag; with an argument of minus one it disables grouping;
13493 with a positive argument @expr{N} it enables grouping on every @expr{N}
13494 digits.  For floating-point numbers, grouping normally occurs only
13495 before the decimal point.  A negative prefix argument @expr{-N} enables
13496 grouping every @expr{N} digits both before and after the decimal point.
13498 @kindex d ,
13499 @pindex calc-group-char
13500 The @kbd{d ,} (@code{calc-group-char}) command allows you to choose any
13501 character as the grouping separator.  The default is the comma character.
13502 If you find it difficult to read vectors of large integers grouped with
13503 commas, you may wish to use spaces or some other character instead.
13504 This command takes the next character you type, whatever it is, and
13505 uses it as the digit separator.  As a special case, @kbd{d , \} selects
13506 @samp{\,} (@TeX{}'s thin-space symbol) as the digit separator.
13508 Please note that grouped numbers will not generally be parsed correctly
13509 if 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
13511 the @samp{\,} separator, which doesn't interfere with parsing because it
13512 is ignored by @TeX{} language mode.
13514 @node Float Formats, Complex Formats, Grouping Digits, Display Modes
13515 @subsection Float Formats
13517 @noindent
13518 Floating-point quantities are normally displayed in standard decimal
13519 form, with scientific notation used if the exponent is especially high
13520 or low.  All significant digits are normally displayed.  The commands
13521 in this section allow you to choose among several alternative display
13522 formats for floats.
13524 @kindex d n
13525 @pindex calc-normal-notation
13526 The @kbd{d n} (@code{calc-normal-notation}) command selects the normal
13527 display format.  All significant figures in a number are displayed.
13528 With a positive numeric prefix, numbers are rounded if necessary to
13529 that number of significant digits.  With a negative numerix prefix,
13530 the specified number of significant digits less than the current
13531 precision is used.  (Thus @kbd{C-u -2 d n} displays 10 digits if the
13532 current precision is 12.)
13534 @kindex d f
13535 @pindex calc-fix-notation
13536 The @kbd{d f} (@code{calc-fix-notation}) command selects fixed-point
13537 notation.  The numeric argument is the number of digits after the
13538 decimal point, zero or more.  This format will relax into scientific
13539 notation if a nonzero number would otherwise have been rounded all the
13540 way to zero.  Specifying a negative number of digits is the same as
13541 for a positive number, except that small nonzero numbers will be rounded
13542 to zero rather than switching to scientific notation.
13544 @kindex d s
13545 @pindex calc-sci-notation
13546 @cindex Scientific notation, display of
13547 The @kbd{d s} (@code{calc-sci-notation}) command selects scientific
13548 notation.  A positive argument sets the number of significant figures
13549 displayed, of which one will be before and the rest after the decimal
13550 point.  A negative argument works the same as for @kbd{d n} format.
13551 The default is to display all significant digits.
13553 @kindex d e
13554 @pindex calc-eng-notation
13555 @cindex Engineering notation, display of
13556 The @kbd{d e} (@code{calc-eng-notation}) command selects engineering
13557 notation.  This is similar to scientific notation except that the
13558 exponent is rounded down to a multiple of three, with from one to three
13559 digits before the decimal point.  An optional numeric prefix sets the
13560 number of significant digits to display, as for @kbd{d s}.
13562 It is important to distinguish between the current @emph{precision} and
13563 the current @emph{display format}.  After the commands @kbd{C-u 10 p}
13564 and @kbd{C-u 6 d n} the Calculator computes all results to ten
13565 significant figures but displays only six.  (In fact, intermediate
13566 calculations are often carried to one or two more significant figures,
13567 but values placed on the stack will be rounded down to ten figures.)
13568 Numbers are never actually rounded to the display precision for storage,
13569 except by commands like @kbd{C-k} and @kbd{M-# y} which operate on the
13570 actual displayed text in the Calculator buffer.
13572 @kindex d .
13573 @pindex calc-point-char
13574 The @kbd{d .} (@code{calc-point-char}) command selects the character used
13575 as a decimal point.  Normally this is a period; users in some countries
13576 may wish to change this to a comma.  Note that this is only a display
13577 style; on entry, periods must always be used to denote floating-point
13578 numbers, and commas to separate elements in a list.
13580 @node Complex Formats, Fraction Formats, Float Formats, Display Modes
13581 @subsection Complex Formats
13583 @noindent
13584 @kindex d c
13585 @pindex calc-complex-notation
13586 There are three supported notations for complex numbers in rectangular
13587 form.  The default is as a pair of real numbers enclosed in parentheses
13588 and separated by a comma: @samp{(a,b)}.  The @kbd{d c}
13589 (@code{calc-complex-notation}) command selects this style.
13591 @kindex d i
13592 @pindex calc-i-notation
13593 @kindex d j
13594 @pindex calc-j-notation
13595 The other notations are @kbd{d i} (@code{calc-i-notation}), in which
13596 numbers are displayed in @samp{a+bi} form, and @kbd{d j}
13597 (@code{calc-j-notation}) which displays the form @samp{a+bj} preferred
13598 in some disciplines.
13600 @cindex @code{i} variable
13601 @vindex i
13602 Complex numbers are normally entered in @samp{(a,b)} format.
13603 If you enter @samp{2+3i} as an algebraic formula, it will be stored as
13604 the formula @samp{2 + 3 * i}.  However, if you use @kbd{=} to evaluate
13605 this formula and you have not changed the variable @samp{i}, the @samp{i}
13606 will be interpreted as @samp{(0,1)} and the formula will be simplified
13607 to @samp{(2,3)}.  Other commands (like @code{calc-sin}) will @emph{not}
13608 interpret the formula @samp{2 + 3 * i} as a complex number.
13609 @xref{Variables}, under ``special constants.''
13611 @node Fraction Formats, HMS Formats, Complex Formats, Display Modes
13612 @subsection Fraction Formats
13614 @noindent
13615 @kindex d o
13616 @pindex calc-over-notation
13617 Display of fractional numbers is controlled by the @kbd{d o}
13618 (@code{calc-over-notation}) command.  By default, a number like
13619 eight thirds is displayed in the form @samp{8:3}.  The @kbd{d o} command
13620 prompts for a one- or two-character format.  If you give one character,
13621 that character is used as the fraction separator.  Common separators are
13622 @samp{:} and @samp{/}.  (During input of numbers, the @kbd{:} key must be
13623 used regardless of the display format; in particular, the @kbd{/} is used
13624 for RPN-style division, @emph{not} for entering fractions.)
13626 If you give two characters, fractions use ``integer-plus-fractional-part''
13627 notation.  For example, the format @samp{+/} would display eight thirds
13628 as @samp{2+2/3}.  If two colons are present in a number being entered,
13629 the number is interpreted in this form (so that the entries @kbd{2:2:3}
13630 and @kbd{8:3} are equivalent).
13632 It is also possible to follow the one- or two-character format with
13633 a number.  For example:  @samp{:10} or @samp{+/3}.  In this case,
13634 Calc adjusts all fractions that are displayed to have the specified
13635 denominator, if possible.  Otherwise it adjusts the denominator to
13636 be a multiple of the specified value.  For example, in @samp{:6} mode
13637 the fraction @expr{1:6} will be unaffected, but @expr{2:3} will be
13638 displayed as @expr{4:6}, @expr{1:2} will be displayed as @expr{3:6},
13639 and @expr{1:8} will be displayed as @expr{3:24}.  Integers are also
13640 affected by this mode:  3 is displayed as @expr{18:6}.  Note that the
13641 format @samp{:1} writes fractions the same as @samp{:}, but it writes
13642 integers as @expr{n:1}.
13644 The fraction format does not affect the way fractions or integers are
13645 stored, only the way they appear on the screen.  The fraction format
13646 never affects floats.
13648 @node HMS Formats, Date Formats, Fraction Formats, Display Modes
13649 @subsection HMS Formats
13651 @noindent
13652 @kindex d h
13653 @pindex calc-hms-notation
13654 The @kbd{d h} (@code{calc-hms-notation}) command controls the display of
13655 HMS (hours-minutes-seconds) forms.  It prompts for a string which
13656 consists basically of an ``hours'' marker, optional punctuation, a
13657 ``minutes'' marker, more optional punctuation, and a ``seconds'' marker.
13658 Punctuation is zero or more spaces, commas, or semicolons.  The hours
13659 marker is one or more non-punctuation characters.  The minutes and
13660 seconds markers must be single non-punctuation characters.
13662 The 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
13664 value as @samp{23deg, 30m15.75s}.  During numeric entry, the @kbd{h} or @kbd{o}
13665 keys are recognized as synonyms for @kbd{@@} regardless of display format.
13666 The @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
13668 already 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.''
13671 The @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
13673 entry.
13675 @node Date Formats, Truncating the Stack, HMS Formats, Display Modes
13676 @subsection Date Formats
13678 @noindent
13679 @kindex d d
13680 @pindex calc-date-notation
13681 The @kbd{d d} (@code{calc-date-notation}) command controls the display
13682 of date forms (@pxref{Date Forms}).  It prompts for a string which
13683 contains letters that represent the various parts of a date and time.
13684 To show which parts should be omitted when the form represents a pure
13685 date with no time, parts of the string can be enclosed in @samp{< >}
13686 marks.  If you don't include @samp{< >} markers in the format, Calc
13687 guesses at which parts, if any, should be omitted when formatting
13688 pure dates.
13690 The default format is:  @samp{<H:mm:SSpp >Www Mmm D, YYYY}.
13691 An example string in this format is @samp{3:32pm Wed Jan 9, 1991}.
13692 If you enter a blank format string, this default format is
13693 reestablished.
13695 Calc uses @samp{< >} notation for nameless functions as well as for
13696 dates.  @xref{Specifying Operators}.  To avoid confusion with nameless
13697 functions, your date formats should avoid using the @samp{#} character.
13699 @menu
13700 * Date Formatting Codes::
13701 * Free-Form Dates::
13702 * Standard Date Formats::
13703 @end menu
13705 @node Date Formatting Codes, Free-Form Dates, Date Formats, Date Formats
13706 @subsubsection Date Formatting Codes
13708 @noindent
13709 When displaying a date, the current date format is used.  All
13710 characters except for letters and @samp{<} and @samp{>} are
13711 copied literally when dates are formatted.  The portion between
13712 @samp{< >} markers is omitted for pure dates, or included for
13713 date/time forms.  Letters are interpreted according to the table
13714 below.
13716 When dates are read in during algebraic entry, Calc first tries to
13717 match the input string to the current format either with or without
13718 the time part.  The punctuation characters (including spaces) must
13719 match exactly; letter fields must correspond to suitable text in
13720 the input.  If this doesn't work, Calc checks if the input is a
13721 simple number; if so, the number is interpreted as a number of days
13722 since Jan 1, 1 AD.  Otherwise, Calc tries a much more relaxed and
13723 flexible algorithm which is described in the next section.
13725 Weekday names are ignored during reading.
13727 Two-digit year numbers are interpreted as lying in the range
13728 from 1941 to 2039.  Years outside that range are always
13729 entered and displayed in full.  Year numbers with a leading
13730 @samp{+} sign are always interpreted exactly, allowing the
13731 entry and display of the years 1 through 99 AD.
13733 Here is a complete list of the formatting codes for dates:
13735 @table @asis
13736 @item Y
13737 Year:  ``91'' for 1991, ``7'' for 2007, ``+23'' for 23 AD.
13738 @item YY
13739 Year:  ``91'' for 1991, ``07'' for 2007, ``+23'' for 23 AD.
13740 @item BY
13741 Year:  ``91'' for 1991, `` 7'' for 2007, ``+23'' for 23 AD.
13742 @item YYY
13743 Year:  ``1991'' for 1991, ``23'' for 23 AD.
13744 @item YYYY
13745 Year:  ``1991'' for 1991, ``+23'' for 23 AD.
13746 @item aa
13747 Year:  ``ad'' or blank.
13748 @item AA
13749 Year:  ``AD'' or blank.
13750 @item aaa
13751 Year:  ``ad '' or blank.  (Note trailing space.)
13752 @item AAA
13753 Year:  ``AD '' or blank.
13754 @item aaaa
13755 Year:  ``a.d.'' or blank.
13756 @item AAAA
13757 Year:  ``A.D.'' or blank.
13758 @item bb
13759 Year:  ``bc'' or blank.
13760 @item BB
13761 Year:  ``BC'' or blank.
13762 @item bbb
13763 Year:  `` bc'' or blank.  (Note leading space.)
13764 @item BBB
13765 Year:  `` BC'' or blank.
13766 @item bbbb
13767 Year:  ``b.c.'' or blank.
13768 @item BBBB
13769 Year:  ``B.C.'' or blank.
13770 @item M
13771 Month:  ``8'' for August.
13772 @item MM
13773 Month:  ``08'' for August.
13774 @item BM
13775 Month:  `` 8'' for August.
13776 @item MMM
13777 Month:  ``AUG'' for August.
13778 @item Mmm
13779 Month:  ``Aug'' for August.
13780 @item mmm
13781 Month:  ``aug'' for August.
13782 @item MMMM
13783 Month:  ``AUGUST'' for August.
13784 @item Mmmm
13785 Month:  ``August'' for August.
13786 @item D
13787 Day:  ``7'' for 7th day of month.
13788 @item DD
13789 Day:  ``07'' for 7th day of month.
13790 @item BD
13791 Day:  `` 7'' for 7th day of month.
13792 @item W
13793 Weekday:  ``0'' for Sunday, ``6'' for Saturday.
13794 @item WWW
13795 Weekday:  ``SUN'' for Sunday.
13796 @item Www
13797 Weekday:  ``Sun'' for Sunday.
13798 @item www
13799 Weekday:  ``sun'' for Sunday.
13800 @item WWWW
13801 Weekday:  ``SUNDAY'' for Sunday.
13802 @item Wwww
13803 Weekday:  ``Sunday'' for Sunday.
13804 @item d
13805 Day of year:  ``34'' for Feb. 3.
13806 @item ddd
13807 Day of year:  ``034'' for Feb. 3.
13808 @item bdd
13809 Day of year:  `` 34'' for Feb. 3.
13810 @item h
13811 Hour:  ``5'' for 5 AM; ``17'' for 5 PM.
13812 @item hh
13813 Hour:  ``05'' for 5 AM; ``17'' for 5 PM.
13814 @item bh
13815 Hour:  `` 5'' for 5 AM; ``17'' for 5 PM.
13816 @item H
13817 Hour:  ``5'' for 5 AM and 5 PM.
13818 @item HH
13819 Hour:  ``05'' for 5 AM and 5 PM.
13820 @item BH
13821 Hour:  `` 5'' for 5 AM and 5 PM.
13822 @item p
13823 AM/PM:  ``a'' or ``p''.
13824 @item P
13825 AM/PM:  ``A'' or ``P''.
13826 @item pp
13827 AM/PM:  ``am'' or ``pm''.
13828 @item PP
13829 AM/PM:  ``AM'' or ``PM''.
13830 @item pppp
13831 AM/PM:  ``a.m.'' or ``p.m.''.
13832 @item PPPP
13833 AM/PM:  ``A.M.'' or ``P.M.''.
13834 @item m
13835 Minutes:  ``7'' for 7.
13836 @item mm
13837 Minutes:  ``07'' for 7.
13838 @item bm
13839 Minutes:  `` 7'' for 7.
13840 @item s
13841 Seconds:  ``7'' for 7;  ``7.23'' for 7.23.
13842 @item ss
13843 Seconds:  ``07'' for 7;  ``07.23'' for 7.23.
13844 @item bs
13845 Seconds:  `` 7'' for 7;  `` 7.23'' for 7.23.
13846 @item SS
13847 Optional seconds:  ``07'' for 7;  blank for 0.
13848 @item BS
13849 Optional seconds:  `` 7'' for 7;  blank for 0.
13850 @item N
13851 Numeric date/time:  ``726842.25'' for 6:00am Wed Jan 9, 1991.
13852 @item n
13853 Numeric date:  ``726842'' for any time on Wed Jan 9, 1991.
13854 @item J
13855 Julian date/time:  ``2448265.75'' for 6:00am Wed Jan 9, 1991.
13856 @item j
13857 Julian date:  ``2448266'' for any time on Wed Jan 9, 1991.
13858 @item U
13859 Unix time:  ``663400800'' for 6:00am Wed Jan 9, 1991.
13860 @item X
13861 Brackets suppression.  An ``X'' at the front of the format
13862 causes the surrounding @w{@samp{< >}} delimiters to be omitted
13863 when formatting dates.  Note that the brackets are still
13864 required for algebraic entry.
13865 @end table
13867 If ``SS'' or ``BS'' (optional seconds) is preceded by a colon, the
13868 colon is also omitted if the seconds part is zero.
13870 If ``bb,'' ``bbb'' or ``bbbb'' or their upper-case equivalents
13871 appear in the format, then negative year numbers are displayed
13872 without a minus sign.  Note that ``aa'' and ``bb'' are mutually
13873 exclusive.  Some typical usages would be @samp{YYYY AABB};
13874 @samp{AAAYYYYBBB}; @samp{YYYYBBB}.
13876 The formats ``YY,'' ``YYYY,'' ``MM,'' ``DD,'' ``ddd,'' ``hh,'' ``HH,''
13877 ``mm,'' ``ss,'' and ``SS'' actually match any number of digits during
13878 reading unless several of these codes are strung together with no
13879 punctuation in between, in which case the input must have exactly as
13880 many digits as there are letters in the format.
13882 The ``j,'' ``J,'' and ``U'' formats do not make any time zone
13883 adjustment.  They effectively use @samp{julian(x,0)} and
13884 @samp{unixtime(x,0)} to make the conversion; @pxref{Date Arithmetic}.
13886 @node Free-Form Dates, Standard Date Formats, Date Formatting Codes, Date Formats
13887 @subsubsection Free-Form Dates
13889 @noindent
13890 When reading a date form during algebraic entry, Calc falls back
13891 on the algorithm described here if the input does not exactly
13892 match the current date format.  This algorithm generally
13893 ``does the right thing'' and you don't have to worry about it,
13894 but it is described here in full detail for the curious.
13896 Calc does not distinguish between upper- and lower-case letters
13897 while interpreting dates.
13899 First, the time portion, if present, is located somewhere in the
13900 text and then removed.  The remaining text is then interpreted as
13901 the date.
13903 A time is of the form @samp{hh:mm:ss}, possibly with the seconds
13904 part omitted and possibly with an AM/PM indicator added to indicate
13905 12-hour time.  If the AM/PM is present, the minutes may also be
13906 omitted.  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
13908 abbreviated 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.
13911 The words @samp{noon}, @samp{mid}, and @samp{midnight} are also
13912 recognized with no number attached.
13914 If there is no AM/PM indicator, the time is interpreted in 24-hour
13915 format.
13917 To read the date portion, all words and numbers are isolated
13918 from the string; other characters are ignored.  All words must
13919 be either month names or day-of-week names (the latter of which
13920 are ignored).  Names can be written in full or as three-letter
13921 abbreviations.
13923 Large numbers, or numbers with @samp{+} or @samp{-} signs,
13924 are interpreted as years.  If one of the other numbers is
13925 greater than 12, then that must be the day and the remaining
13926 number in the input is therefore the month.  Otherwise, Calc
13927 assumes the month, day and year are in the same order that they
13928 appear in the current date format.  If the year is omitted, the
13929 current year is taken from the system clock.
13931 If there are too many or too few numbers, or any unrecognizable
13932 words, then the input is rejected.
13934 If there are any large numbers (of five digits or more) other than
13935 the year, they are ignored on the assumption that they are something
13936 like Julian dates that were included along with the traditional
13937 date components when the date was formatted.
13939 One of the words @samp{ad}, @samp{a.d.}, @samp{bc}, or @samp{b.c.}
13940 may optionally be used; the latter two are equivalent to a
13941 minus sign on the year value.
13943 If you always enter a four-digit year, and use a name instead
13944 of a number for the month, there is no danger of ambiguity.
13946 @node Standard Date Formats, , Free-Form Dates, Date Formats
13947 @subsubsection Standard Date Formats
13949 @noindent
13950 There are actually ten standard date formats, numbered 0 through 9.
13951 Entering a blank line at the @kbd{d d} command's prompt gives
13952 you format number 1, Calc's usual format.  You can enter any digit
13953 to select the other formats.
13955 To create your own standard date formats, give a numeric prefix
13956 argument from 0 to 9 to the @w{@kbd{d d}} command.  The format you
13957 enter will be recorded as the new standard format of that
13958 number, as well as becoming the new current date format.
13959 You can save your formats permanently with the @w{@kbd{m m}}
13960 command (@pxref{Mode Settings}).
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
13985 @node Truncating the Stack, Justification, Date Formats, Display Modes
13986 @subsection Truncating the Stack
13988 @noindent
13989 @kindex d t
13990 @pindex calc-truncate-stack
13991 @cindex Truncating the stack
13992 @cindex Narrowing the stack
13993 The @kbd{d t} (@code{calc-truncate-stack}) command moves the @samp{.}@:
13994 line that marks the top-of-stack up or down in the Calculator buffer.
13995 The number right above that line is considered to the be at the top of
13996 the stack.  Any numbers below that line are ``hidden'' from all stack
13997 operations (although still visible to the user).  This is similar to the
13998 Emacs ``narrowing'' feature, except that the values below the @samp{.}
13999 are @emph{visible}, just temporarily frozen.  This feature allows you to
14000 keep several independent calculations running at once in different parts
14001 of the stack, or to apply a certain command to an element buried deep in
14002 the stack.
14004 Pressing @kbd{d t} by itself moves the @samp{.} to the line the cursor
14005 is on.  Thus, this line and all those below it become hidden.  To un-hide
14006 these lines, move down to the end of the buffer and press @w{@kbd{d t}}.
14007 With a positive numeric prefix argument @expr{n}, @kbd{d t} hides the
14008 bottom @expr{n} values in the buffer.  With a negative argument, it hides
14009 all but the top @expr{n} values.  With an argument of zero, it hides zero
14010 values, i.e., moves the @samp{.} all the way down to the bottom.
14012 @kindex d [
14013 @pindex calc-truncate-up
14014 @kindex d ]
14015 @pindex calc-truncate-down
14016 The @kbd{d [} (@code{calc-truncate-up}) and @kbd{d ]}
14017 (@code{calc-truncate-down}) commands move the @samp{.} up or down one
14018 line at a time (or several lines with a prefix argument).
14020 @node Justification, Labels, Truncating the Stack, Display Modes
14021 @subsection Justification
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
14030 Values on the stack are normally left-justified in the window.  You can
14031 control this arrangement by typing @kbd{d <} (@code{calc-left-justify}),
14032 @kbd{d >} (@code{calc-right-justify}), or @kbd{d =}
14033 (@code{calc-center-justify}).  For example, in Right-Justification mode,
14034 stack entries are displayed flush-right against the right edge of the
14035 window.
14037 If you change the width of the Calculator window you may have to type
14038 @kbd{d @key{SPC}} (@code{calc-refresh}) to re-align right-justified or centered
14039 text.
14041 Right-justification is especially useful together with fixed-point
14042 notation (see @code{d f}; @code{calc-fix-notation}).  With these modes
14043 together, the decimal points on numbers will always line up.
14045 With a numeric prefix argument, the justification commands give you
14046 a little extra control over the display.  The argument specifies the
14047 horizontal ``origin'' of a display line.  It is also possible to
14048 specify a maximum line width using the @kbd{d b} command (@pxref{Normal
14049 Language Modes}).  For reference, the precise rules for formatting and
14050 breaking lines are given below.  Notice that the interaction between
14051 origin and line width is slightly different in each justification
14052 mode.
14054 In Left-Justified mode, the line is indented by a number of spaces
14055 given by the origin (default zero).  If the result is longer than the
14056 maximum line width, if given, or too wide to fit in the Calc window
14057 otherwise, then it is broken into lines which will fit; each broken
14058 line is indented to the origin.
14060 In Right-Justified mode, lines are shifted right so that the rightmost
14061 character is just before the origin, or just before the current
14062 window width if no origin was specified.  If the line is too long
14063 for this, then it is broken; the current line width is used, if
14064 specified, or else the origin is used as a width if that is
14065 specified, or else the line is broken to fit in the window.
14067 In Centering mode, the origin is the column number of the center of
14068 each stack entry.  If a line width is specified, lines will not be
14069 allowed to go past that width; Calc will either indent less or
14070 break the lines if necessary.  If no origin is specified, half the
14071 line width or Calc window width is used.
14073 Note that, in each case, if line numbering is enabled the display
14074 is indented an additional four spaces to make room for the line
14075 number.  The width of the line number is taken into account when
14076 positioning according to the current Calc window width, but not
14077 when positioning by explicit origins and widths.  In the latter
14078 case, the display is formatted as specified, and then uniformly
14079 shifted over four spaces to fit the line numbers.
14081 @node Labels, , Justification, Display Modes
14082 @subsection Labels
14084 @noindent
14085 @kindex d @{
14086 @pindex calc-left-label
14087 The @kbd{d @{} (@code{calc-left-label}) command prompts for a string,
14088 then displays that string to the left of every stack entry.  If the
14089 entries are left-justified (@pxref{Justification}), then they will
14090 appear immediately after the label (unless you specified an origin
14091 greater than the length of the label).  If the entries are centered
14092 or right-justified, the label appears on the far left and does not
14093 affect the horizontal position of the stack entry.
14095 Give a blank string (with @kbd{d @{ @key{RET}}) to turn the label off.
14097 @kindex d @}
14098 @pindex calc-right-label
14099 The @kbd{d @}} (@code{calc-right-label}) command similarly adds a
14100 label on the righthand side.  It does not affect positioning of
14101 the stack entries unless they are right-justified.  Also, if both
14102 a line width and an origin are given in Right-Justified mode, the
14103 stack entry is justified to the origin and the righthand label is
14104 justified to the line width.
14106 One application of labels would be to add equation numbers to
14107 formulas you are manipulating in Calc and then copying into a
14108 document (possibly using Embedded mode).  The equations would
14109 typically be centered, and the equation numbers would be on the
14110 left or right as you prefer.
14112 @node Language Modes, Modes Variable, Display Modes, Mode Settings
14113 @section Language Modes
14115 @noindent
14116 The commands in this section change Calc to use a different notation for
14117 entry and display of formulas, corresponding to the conventions of some
14118 other common language such as Pascal or La@TeX{}.  Objects displayed on the
14119 stack or yanked from the Calculator to an editing buffer will be formatted
14120 in the current language; objects entered in algebraic entry or yanked from
14121 another buffer will be interpreted according to the current language.
14123 The current language has no effect on things written to or read from the
14124 trail buffer, nor does it affect numeric entry.  Only algebraic entry is
14125 affected.  You can make even algebraic entry ignore the current language
14126 and use the standard notation by giving a numeric prefix, e.g., @kbd{C-u '}.
14128 For example, suppose the formula @samp{2*a[1] + atan(a[2])} occurs in a C
14129 program; elsewhere in the program you need the derivatives of this formula
14130 with respect to @samp{a[1]} and @samp{a[2]}.  First, type @kbd{d C}
14131 to switch to C notation.  Now use @code{C-u M-# g} to grab the formula
14132 into the Calculator, @kbd{a d a[1] @key{RET}} to differentiate with respect
14133 to the first variable, and @kbd{M-# y} to yank the formula for the derivative
14134 back into your C program.  Press @kbd{U} to undo the differentiation and
14135 repeat with @kbd{a d a[2] @key{RET}} for the other derivative.
14137 Without being switched into C mode first, Calc would have misinterpreted
14138 the 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,
14140 and would have written the formula back with notations (like implicit
14141 multiplication) which would not have been valid for a C program.
14143 As another example, suppose you are maintaining a C program and a La@TeX{}
14144 document, each of which needs a copy of the same formula.  You can grab the
14145 formula from the program in C mode, switch to La@TeX{} mode, and yank the
14146 formula into the document in La@TeX{} math-mode format.
14148 Language modes are selected by typing the letter @kbd{d} followed by a
14149 shifted letter key.
14151 @menu
14152 * Normal Language Modes::
14153 * C FORTRAN Pascal::
14154 * TeX and LaTeX Language Modes::
14155 * Eqn Language Mode::
14156 * Mathematica Language Mode::
14157 * Maple Language Mode::
14158 * Compositions::
14159 * Syntax Tables::
14160 @end menu
14162 @node Normal Language Modes, C FORTRAN Pascal, Language Modes, Language Modes
14163 @subsection Normal Language Modes
14165 @noindent
14166 @kindex d N
14167 @pindex calc-normal-language
14168 The @kbd{d N} (@code{calc-normal-language}) command selects the usual
14169 notation for Calc formulas, as described in the rest of this manual.
14170 Matrices are displayed in a multi-line tabular format, but all other
14171 objects are written in linear form, as they would be typed from the
14172 keyboard.
14174 @kindex d O
14175 @pindex calc-flat-language
14176 @cindex Matrix display
14177 The @kbd{d O} (@code{calc-flat-language}) command selects a language
14178 identical with the normal one, except that matrices are written in
14179 one-line form along with everything else.  In some applications this
14180 form may be more suitable for yanking data into other buffers.
14182 @kindex d b
14183 @pindex calc-line-breaking
14184 @cindex Line breaking
14185 @cindex Breaking up long lines
14186 Even in one-line mode, long formulas or vectors will still be split
14187 across multiple lines if they exceed the width of the Calculator window.
14188 The @kbd{d b} (@code{calc-line-breaking}) command turns this line-breaking
14189 feature on and off.  (It works independently of the current language.)
14190 If you give a numeric prefix argument of five or greater to the @kbd{d b}
14191 command, that argument will specify the line width used when breaking
14192 long lines.
14194 @kindex d B
14195 @pindex calc-big-language
14196 The @kbd{d B} (@code{calc-big-language}) command selects a language
14197 which uses textual approximations to various mathematical notations,
14198 such as powers, quotients, and square roots:
14200 @example
14201   ____________
14202  | a + 1    2
14203  | ----- + c
14204 \|   b
14205 @end example
14207 @noindent
14208 in place of @samp{sqrt((a+1)/b + c^2)}.
14210 Subscripts like @samp{a_i} are displayed as actual subscripts in Big
14211 mode.  Double subscripts, @samp{a_i_j} (@samp{subscr(subscr(a, i), j)})
14212 are displayed as @samp{a} with subscripts separated by commas:
14213 @samp{i, j}.  They must still be entered in the usual underscore
14214 notation.
14216 One slight ambiguity of Big notation is that
14218 @example
14219   3
14220 - -
14221   4
14222 @end example
14224 @noindent
14225 can represent either the negative rational number @expr{-3:4}, or the
14226 actual expression @samp{-(3/4)}; but the latter formula would normally
14227 never be displayed because it would immediately be evaluated to
14228 @expr{-3:4} or @expr{-0.75}, so this ambiguity is not a problem in
14229 typical use.
14231 Non-decimal numbers are displayed with subscripts.  Thus there is no
14232 way to tell the difference between @samp{16#C2} and @samp{C2_16},
14233 though generally you will know which interpretation is correct.
14234 Logarithms @samp{log(x,b)} and @samp{log10(x)} also use subscripts
14235 in Big mode.
14237 In Big mode, stack entries often take up several lines.  To aid
14238 readability, stack entries are separated by a blank line in this mode.
14239 You 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
14241 one on the screen with @kbd{C-x 1} (@code{delete-other-windows}).
14243 Long lines are currently not rearranged to fit the window width in
14244 Big mode, so you may need to use the @kbd{<} and @kbd{>} keys
14245 to scroll across a wide formula.  For really big formulas, you may
14246 even need to use @kbd{@{} and @kbd{@}} to scroll up and down.
14248 @kindex d U
14249 @pindex calc-unformatted-language
14250 The @kbd{d U} (@code{calc-unformatted-language}) command altogether disables
14251 the use of operator notation in formulas.  In this mode, the formula
14252 shown above would be displayed:
14254 @example
14255 sqrt(add(div(add(a, 1), b), pow(c, 2)))
14256 @end example
14258 These four modes differ only in display format, not in the format
14259 expected for algebraic entry.  The standard Calc operators work in
14260 all four modes, and unformatted notation works in any language mode
14261 (except that Mathematica mode expects square brackets instead of
14262 parentheses).
14264 @node C FORTRAN Pascal, TeX and LaTeX Language Modes, Normal Language Modes, Language Modes
14265 @subsection C, FORTRAN, and Pascal Modes
14267 @noindent
14268 @kindex d C
14269 @pindex calc-c-language
14270 @cindex C language
14271 The @kbd{d C} (@code{calc-c-language}) command selects the conventions
14272 of the C language for display and entry of formulas.  This differs from
14273 the normal language mode in a variety of (mostly minor) ways.  In
14274 particular, C language operators and operator precedences are used in
14275 place of Calc's usual ones.  For example, @samp{a^b} means @samp{xor(a,b)}
14276 in C mode; a value raised to a power is written as a function call,
14277 @samp{pow(a,b)}.
14279 In C mode, vectors and matrices use curly braces instead of brackets.
14280 Octal and hexadecimal values are written with leading @samp{0} or @samp{0x}
14281 rather than using the @samp{#} symbol.  Array subscripting is
14282 translated into @code{subscr} calls, so that @samp{a[i]} in C
14283 mode is the same as @samp{a_i} in Normal mode.  Assignments
14284 turn into the @code{assign} function, which Calc normally displays
14285 using the @samp{:=} symbol.
14287 The variables @code{pi} and @code{e} would be displayed @samp{pi}
14288 and @samp{e} in Normal mode, but in C mode they are displayed as
14289 @samp{M_PI} and @samp{M_E}, corresponding to the names of constants
14290 typically provided in the @file{<math.h>} header.  Functions whose
14291 names are different in C are translated automatically for entry and
14292 display purposes.  For example, entering @samp{asin(x)} will push the
14293 formula @samp{arcsin(x)} onto the stack; this formula will be displayed
14294 as @samp{asin(x)} as long as C mode is in effect.
14296 @kindex d P
14297 @pindex calc-pascal-language
14298 @cindex Pascal language
14299 The @kbd{d P} (@code{calc-pascal-language}) command selects Pascal
14300 conventions.  Like C mode, Pascal mode interprets array brackets and uses
14301 a different table of operators.  Hexadecimal numbers are entered and
14302 displayed 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
14305 always.)  No special provisions are made for other non-decimal numbers,
14306 vectors, and so on, since there is no universally accepted standard way
14307 of handling these in Pascal.
14309 @kindex d F
14310 @pindex calc-fortran-language
14311 @cindex FORTRAN language
14312 The @kbd{d F} (@code{calc-fortran-language}) command selects FORTRAN
14313 conventions.  Various function names are transformed into FORTRAN
14314 equivalents.  Vectors are written as @samp{/1, 2, 3/}, and may be
14315 entered this way or using square brackets.  Since FORTRAN uses round
14316 parentheses for both function calls and array subscripts, Calc displays
14317 both in the same way; @samp{a(i)} is interpreted as a function call
14318 upon reading, and subscripts must be entered as @samp{subscr(a, i)}.
14319 Also, 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
14321 subscript.  (@xref{Declarations}.)  Usually it doesn't matter, though;
14322 if you enter the subscript expression @samp{a(i)} and Calc interprets
14323 it as a function call, you'll never know the difference unless you
14324 switch to another language mode or replace @code{a} with an actual
14325 vector (or unless @code{a} happens to be the name of a built-in
14326 function!).
14328 Underscores are allowed in variable and function names in all of these
14329 language modes.  The underscore here is equivalent to the @samp{#} in
14330 Normal mode, or to hyphens in the underlying Emacs Lisp variable names.
14332 FORTRAN and Pascal modes normally do not adjust the case of letters in
14333 formulas.  Most built-in Calc names use lower-case letters.  If you use a
14334 positive numeric prefix argument with @kbd{d P} or @kbd{d F}, these
14335 modes will use upper-case letters exclusively for display, and will
14336 convert to lower-case on input.  With a negative prefix, these modes
14337 convert to lower-case for display and input.
14339 @node TeX and LaTeX Language Modes, Eqn Language Mode, C FORTRAN Pascal, Language Modes
14340 @subsection @TeX{} and La@TeX{} Language Modes
14342 @noindent
14343 @kindex d T
14344 @pindex calc-tex-language
14345 @cindex TeX language
14346 @kindex d L
14347 @pindex calc-latex-language
14348 @cindex LaTeX language
14349 The @kbd{d T} (@code{calc-tex-language}) command selects the conventions
14350 of ``math mode'' in Donald Knuth's @TeX{} typesetting language,
14351 and the @kbd{d L} (@code{calc-latex-language}) command selects the
14352 conventions of ``math mode'' in La@TeX{}, a typesetting language that
14353 uses @TeX{} as its formatting engine.  Calc's La@TeX{} language mode can
14354 read any formula that the @TeX{} language mode can, although La@TeX{}
14355 mode may display it differently.
14357 Formulas are entered and displayed in the appropriate notation;
14358 @texline @math{\sin(a/b)}
14359 @infoline @expr{sin(a/b)}
14360 will appear as @samp{\sin\left( a \over b \right)} in @TeX{} mode and
14361 @samp{\sin\left(\frac@{a@}@{b@}\right)} in La@TeX{} mode.
14362 Math formulas are often enclosed by @samp{$ $} signs in @TeX{} and
14363 La@TeX{}; these should be omitted when interfacing with Calc.  To Calc,
14364 the @samp{$} sign has the same meaning it always does in algebraic
14365 formulas (a reference to an existing entry on the stack).
14367 Complex numbers are displayed as in @samp{3 + 4i}.  Fractions and
14368 quotients are written using @code{\over} in @TeX{} mode (as in 
14369 @code{@{a \over b@}}) and @code{\frac} in La@TeX{} mode (as in
14370 @code{\frac@{a@}@{b@}});  binomial coefficients are written with
14371 @code{\choose} in @TeX{} mode (as in @code{@{a \choose b@}}) and
14372 @code{\binom} in La@TeX{} mode (as in @code{\binom@{a@}@{b@}}).
14373 Interval forms are written with @code{\ldots}, and error forms are
14374 written 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
14377 @code{\right} are ignored when reading formulas in @TeX{} and La@TeX{}
14378 modes.  Both @code{inf} and @code{uinf} are written as @code{\infty};
14379 when read, @code{\infty} always translates to @code{inf}.
14381 Function calls are written the usual way, with the function name followed
14382 by the arguments in parentheses.  However, functions for which @TeX{}
14383 and La@TeX{} have special names (like @code{\sin}) will use curly braces
14384 instead of parentheses for very simple arguments.  During input, curly
14385 braces and parentheses work equally well for grouping, but when the
14386 document is formatted the curly braces will be invisible.  Thus the
14387 printed result is 
14388 @texline @math{\sin{2 x}}
14389 @infoline @expr{sin 2x} 
14390 but 
14391 @texline @math{\sin(2 + x)}.
14392 @infoline @expr{sin(2 + x)}.
14394 Function and variable names not treated specially by @TeX{} and La@TeX{}
14395 are simply written out as-is, which will cause them to come out in
14396 italic 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
14398 one character will instead be enclosed in a protective commands that
14399 will prevent them from being typeset in the math italics; they will be
14400 written @samp{\hbox@{@var{name}@}} in @TeX{} mode and 
14401 @samp{\text@{@var{name}@}} in La@TeX{} mode.  The
14402 @samp{\hbox@{ @}} and @samp{\text@{ @}} notations are ignored during
14403 reading.  If you use a negative prefix argument, such function names are
14404 written @samp{\@var{name}}, and function names that begin with @code{\} during
14405 reading have the @code{\} removed.  (Note that in this mode, long
14406 variable names are still written with @code{\hbox} or @code{\text}.
14407 However, you can always make an actual variable name like @code{\bar} in
14408 any @TeX{} mode.)
14410 During reading, text of the form @samp{\matrix@{ ...@: @}} is replaced
14411 by @samp{[ ...@: ]}.  The same also applies to @code{\pmatrix} and
14412 @code{\bmatrix}.  In La@TeX{} mode this also applies to 
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@}}.
14417 The symbol @samp{&} is interpreted as a comma,
14418 and the symbols @samp{\cr} and @samp{\\} are interpreted as semicolons.
14419 During output, matrices are displayed in @samp{\matrix@{ a & b \\ c & d@}}
14420 format in @TeX{} mode and in 
14421 @samp{\begin@{pmatrix@} a & b \\ c & d \end@{pmatrix@}} format in
14422 La@TeX{} mode; you may need to edit this afterwards to change to your
14423 preferred matrix form.  If you invoke @kbd{d T} or @kbd{d L} with an
14424 argument of 2 or -2, then matrices will be displayed in two-dimensional
14425 form, such as 
14427 @example
14428 \begin@{pmatrix@}
14429 a & b \\
14430 c & d
14431 \end@{pmatrix@}
14432 @end example
14434 @noindent
14435 This may be convenient for isolated matrices, but could lead to
14436 expressions being displayed like
14438 @example
14439 \begin@{pmatrix@} \times x
14440 a & b \\
14441 c & d
14442 \end@{pmatrix@}
14443 @end example
14445 @noindent
14446 While this wouldn't bother Calc, it is incorrect La@TeX{}.
14447 (Similarly for @TeX{}.)
14449 Accents like @code{\tilde} and @code{\bar} translate into function
14450 calls internally (@samp{tilde(x)}, @samp{bar(x)}).  The @code{\underline}
14451 sequence is treated as an accent.  The @code{\vec} accent corresponds
14452 to the function name @code{Vec}, because @code{vec} is the name of
14453 a built-in Calc function.  The following table shows the accents
14454 in Calc, @TeX{}, La@TeX{} and @dfn{eqn} (described in the next section):
14456 @iftex
14457 @begingroup
14458 @let@calcindexershow=@calcindexernoshow  @c Suppress marginal notes
14459 @let@calcindexersh=@calcindexernoshow
14460 @end iftex
14461 @ignore
14462 @starindex
14463 @end ignore
14464 @tindex acute
14465 @ignore
14466 @starindex
14467 @end ignore
14468 @tindex Acute
14469 @ignore
14470 @starindex
14471 @end ignore
14472 @tindex bar
14473 @ignore
14474 @starindex
14475 @end ignore
14476 @tindex Bar
14477 @ignore
14478 @starindex
14479 @end ignore
14480 @tindex breve
14481 @ignore
14482 @starindex
14483 @end ignore
14484 @tindex Breve
14485 @ignore
14486 @starindex
14487 @end ignore
14488 @tindex check
14489 @ignore
14490 @starindex
14491 @end ignore
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
14504 @tindex dot
14505 @ignore
14506 @starindex
14507 @end ignore
14508 @tindex Dot
14509 @ignore
14510 @starindex
14511 @end ignore
14512 @tindex dotdot
14513 @ignore
14514 @starindex
14515 @end ignore
14516 @tindex DotDot
14517 @ignore
14518 @starindex
14519 @end ignore
14520 @tindex dyad
14521 @ignore
14522 @starindex
14523 @end ignore
14524 @tindex grave
14525 @ignore
14526 @starindex
14527 @end ignore
14528 @tindex Grave
14529 @ignore
14530 @starindex
14531 @end ignore
14532 @tindex hat
14533 @ignore
14534 @starindex
14535 @end ignore
14536 @tindex Hat
14537 @ignore
14538 @starindex
14539 @end ignore
14540 @tindex Prime
14541 @ignore
14542 @starindex
14543 @end ignore
14544 @tindex tilde
14545 @ignore
14546 @starindex
14547 @end ignore
14548 @tindex Tilde
14549 @ignore
14550 @starindex
14551 @end ignore
14552 @tindex under
14553 @ignore
14554 @starindex
14555 @end ignore
14556 @tindex Vec
14557 @ignore
14558 @starindex
14559 @end ignore
14560 @tindex VEC
14561 @iftex
14562 @endgroup
14563 @end iftex
14564 @example
14565 Calc      TeX           LaTeX         eqn
14566 ----      ---           -----         ---
14567 acute     \acute        \acute        
14568 Acute                   \Acute        
14569 bar       \bar          \bar          bar
14570 Bar                     \Bar
14571 breve     \breve        \breve        
14572 Breve                   \Breve        
14573 check     \check        \check        
14574 Check                   \Check        
14575 dddot                   \dddot
14576 ddddot                  \ddddot
14577 dot       \dot          \dot          dot
14578 Dot                     \Dot
14579 dotdot    \ddot         \ddot         dotdot
14580 DotDot                  \Ddot         
14581 dyad                                  dyad
14582 grave     \grave        \grave        
14583 Grave                   \Grave        
14584 hat       \hat          \hat          hat
14585 Hat                     \Hat          
14586 Prime                                 prime
14587 tilde     \tilde        \tilde        tilde
14588 Tilde                   \Tilde
14589 under     \underline    \underline    under
14590 Vec       \vec          \vec          vec
14591 VEC                     \Vec
14592 @end example
14594 The @samp{=>} (evaluates-to) operator appears as a @code{\to} symbol:
14595 @samp{@{@var{a} \to @var{b}@}}.  @TeX{} defines @code{\to} as an
14596 alias for @code{\rightarrow}.  However, if the @samp{=>} is the
14597 top-level expression being formatted, a slightly different notation
14598 is used:  @samp{\evalto @var{a} \to @var{b}}.  The @code{\evalto}
14599 word is ignored by Calc's input routines, and is undefined in @TeX{}.
14600 You will typically want to include one of the following definitions
14601 at the top of a @TeX{} file that uses @code{\evalto}:
14603 @example
14604 \def\evalto@{@}
14605 \def\evalto#1\to@{@}
14606 @end example
14608 The first definition formats evaluates-to operators in the usual
14609 way.  The second causes only the @var{b} part to appear in the
14610 printed document; the @var{a} part and the arrow are hidden.
14611 Another definition you may wish to use is @samp{\let\to=\Rightarrow}
14612 which causes @code{\to} to appear more like Calc's @samp{=>} symbol.
14613 @xref{Evaluates-To Operator}, for a discussion of @code{evalto}.
14615 The complete set of @TeX{} control sequences that are ignored during
14616 reading is:
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
14628 Note that, because these symbols are ignored, reading a @TeX{} or
14629 La@TeX{} formula into Calc and writing it back out may lose spacing and
14630 font information. 
14632 Also, the ``discretionary multiplication sign'' @samp{\*} is read
14633 the same as @samp{*}.
14635 @ifinfo
14636 The @TeX{} version of this manual includes some printed examples at the
14637 end of this section.
14638 @end ifinfo
14639 @iftex
14640 Here are some examples of how various Calc formulas are formatted in @TeX{}:
14642 @example
14643 @group
14644 sin(a^2 / b_i)
14645 \sin\left( {a^2 \over b_i} \right)
14646 @end group
14647 @end example
14648 @tex
14649 $$ \sin\left( a^2 \over b_i \right) $$
14650 @end tex
14651 @sp 1
14653 @example
14654 @group
14655 [(3, 4), 3:4, 3 +/- 4, [3 .. inf)]
14656 [3 + 4i, @{3 \over 4@}, 3 \pm 4, [3 \ldots \infty)]
14657 @end group
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
14665 @example
14666 @group
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]
14670 @end group
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
14678 @example
14679 @group
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)]
14683 @end group
14684 @end example
14685 @tex
14686 \turnoffactive
14687 $$ [\sin{a}, \sin{2 a}, \sin(2 + a), \sin\left( {a \over b} \right)] $$
14688 @end tex
14689 @sp 2
14691 First 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)@}}:
14695 @example
14696 @group
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@}]
14701 @end group
14702 @end example
14703 @tex
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
14710 First with @samp{\def\evalto@{@}}, then with @samp{\def\evalto#1\to@{@}}:
14712 @example
14713 @group
14714 2 + 3 => 5
14715 \evalto 2 + 3 \to 5
14716 @end group
14717 @end example
14718 @tex
14719 \turnoffactive
14720 $$ 2 + 3 \to 5 $$
14721 $$ 5 $$
14722 @end tex
14723 @sp 2
14725 First with standard @code{\to}, then with @samp{\let\to\Rightarrow}:
14727 @example
14728 @group
14729 [2 + 3 => 5, a / 2 => (b + c) / 2]
14730 [@{2 + 3 \to 5@}, @{@{a \over 2@} \to @{b + c \over 2@}@}]
14731 @end group
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
14741 Matrices normally, then changing @code{\matrix} to @code{\pmatrix}:
14743 @example
14744 @group
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)@} @}
14748 @end group
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
14756 @end iftex
14758 @node Eqn Language Mode, Mathematica Language Mode, TeX and LaTeX Language Modes, Language Modes
14759 @subsection Eqn Language Mode
14761 @noindent
14762 @kindex d E
14763 @pindex calc-eqn-language
14764 @dfn{Eqn} is another popular formatter for math formulas.  It is
14765 designed for use with the TROFF text formatter, and comes standard
14766 with many versions of Unix.  The @kbd{d E} (@code{calc-eqn-language})
14767 command selects @dfn{eqn} notation.
14769 The @dfn{eqn} language's main idiosyncrasy is that whitespace plays
14770 a 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
14773 grouping using curly braces:  @samp{sqrt@{x+1@} + y}.  Braces are
14774 required only when the argument contains spaces.
14776 In Calc's @dfn{eqn} mode, however, curly braces are required to
14777 delimit arguments of operators like @code{sqrt}.  The first of the
14778 above 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
14781 in the @dfn{eqn} language.  If you always surround the argument
14782 with curly braces, Calc will never misunderstand.
14784 Calc also understands parentheses as grouping characters.  Another
14785 peculiarity of @dfn{eqn}'s syntax makes it advisable to separate
14786 words with spaces from any surrounding characters that aren't curly
14787 braces, so Calc writes @samp{sin ( x + y )} in @dfn{eqn} mode.
14788 (The spaces around @code{sin} are important to make @dfn{eqn}
14789 recognize that @code{sin} should be typeset in a roman font, and
14790 the spaces around @code{x} and @code{y} are a good idea just in
14791 case the @dfn{eqn} document has defined special meanings for these
14792 names, too.)
14794 Powers and subscripts are written with the @code{sub} and @code{sup}
14795 operators, respectively.  Note that the caret symbol @samp{^} is
14796 treated the same as a space in @dfn{eqn} mode, as is the @samp{~}
14797 symbol (these are used to introduce spaces of various widths into
14798 the typeset output of @dfn{eqn}).
14800 As in La@TeX{} mode, Calc's formatter omits parentheses around the
14801 arguments of functions like @code{ln} and @code{sin} if they are
14802 ``simple-looking''; in this case Calc surrounds the argument with
14803 braces, separated by a @samp{~} from the function name: @samp{sin~@{x@}}.
14805 Font 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
14809 are 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
14811 of quotes in @dfn{eqn}, but it is good enough for most uses.
14813 Accent codes (@samp{@var{x} dot}) are handled by treating them as
14814 function calls (@samp{dot(@var{x})}) internally.  
14815 @xref{TeX and LaTeX Language Modes}, for a table of these accent
14816 functions.  The @code{prime} accent is treated specially if it occurs on
14817 a variable or function name: @samp{f prime prime @w{( x prime )}} is
14818 stored internally as @samp{f'@w{'}(x')}.  For example, taking the
14819 derivative of @samp{f(2 x)} with @kbd{a d x} will produce @samp{2 f'(2
14820 x)}, which @dfn{eqn} mode will display as @samp{2 f prime ( 2 x )}.
14822 Assignments are written with the @samp{<-} (left-arrow) symbol,
14823 and @code{evalto} operators are written with @samp{->} or
14824 @samp{evalto ... ->} (@pxref{TeX and LaTeX Language Modes}, for a discussion
14825 of this).  The regular Calc symbols @samp{:=} and @samp{=>} are also
14826 recognized for these operators during reading.
14828 Vectors in @dfn{eqn} mode use regular Calc square brackets, but
14829 matrices are formatted as @samp{matrix @{ ccol @{ a above b @} ... @}}.
14830 The words @code{lcol} and @code{rcol} are recognized as synonyms
14831 for @code{ccol} during input, and are generated instead of @code{ccol}
14832 if the matrix justification mode so specifies.
14834 @node Mathematica Language Mode, Maple Language Mode, Eqn Language Mode, Language Modes
14835 @subsection Mathematica Language Mode
14837 @noindent
14838 @kindex d M
14839 @pindex calc-mathematica-language
14840 @cindex Mathematica language
14841 The @kbd{d M} (@code{calc-mathematica-language}) command selects the
14842 conventions of Mathematica.  Notable differences in Mathematica mode
14843 are that the names of built-in functions are capitalized, and function
14844 calls use square brackets instead of parentheses.  Thus the Calc
14845 formula @samp{sin(2 x)} is entered and displayed @w{@samp{Sin[2 x]}} in
14846 Mathematica mode.
14848 Vectors and matrices use curly braces in Mathematica.  Complex numbers
14849 are written @samp{3 + 4 I}.  The standard special constants in Calc are
14850 written @code{Pi}, @code{E}, @code{I}, @code{GoldenRatio}, @code{EulerGamma},
14851 @code{Infinity}, @code{ComplexInfinity}, and @code{Indeterminate} in
14852 Mathematica mode.
14853 Non-decimal numbers are written, e.g., @samp{16^^7fff}.  Floating-point
14854 numbers in scientific notation are written @samp{1.23*10.^3}.
14855 Subscripts use double square brackets: @samp{a[[i]]}.
14857 @node Maple Language Mode, Compositions, Mathematica Language Mode, Language Modes
14858 @subsection Maple Language Mode
14860 @noindent
14861 @kindex d W
14862 @pindex calc-maple-language
14863 @cindex Maple language
14864 The @kbd{d W} (@code{calc-maple-language}) command selects the
14865 conventions of Maple.
14867 Maple's language is much like C.  Underscores are allowed in symbol
14868 names; square brackets are used for subscripts; explicit @samp{*}s for
14869 multiplications are required.  Use either @samp{^} or @samp{**} to
14870 denote powers.
14872 Maple uses square brackets for lists and curly braces for sets.  Calc
14873 interprets both notations as vectors, and displays vectors with square
14874 brackets.  This means Maple sets will be converted to lists when they
14875 pass through Calc.  As a special case, matrices are written as calls
14876 to the function @code{matrix}, given a list of lists as the argument,
14877 and can be read in this form or with all-capitals @code{MATRIX}.
14879 The Maple interval notation @samp{2 .. 3} has no surrounding brackets;
14880 Calc reads @samp{2 .. 3} as the closed interval @samp{[2 .. 3]}, and
14881 writes any kind of interval as @samp{2 .. 3}.  This means you cannot
14882 see the difference between an open and a closed interval while in
14883 Maple display mode.
14885 Maple writes complex numbers as @samp{3 + 4*I}.  Its special constants
14886 are @code{Pi}, @code{E}, @code{I}, and @code{infinity} (all three of
14887 @code{inf}, @code{uinf}, and @code{nan} display as @code{infinity}).
14888 Floating-point numbers are written @samp{1.23*10.^3}.
14890 Among things not currently handled by Calc's Maple mode are the
14891 various quote symbols, procedures and functional operators, and
14892 inert (@samp{&}) operators.
14894 @node Compositions, Syntax Tables, Maple Language Mode, Language Modes
14895 @subsection Compositions
14897 @noindent
14898 @cindex Compositions
14899 There are several @dfn{composition functions} which allow you to get
14900 displays in a variety of formats similar to those in Big language
14901 mode.  Most of these functions do not evaluate to anything; they are
14902 placeholders which are left in symbolic form by Calc's evaluator but
14903 are recognized by Calc's display formatting routines.
14905 Two 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
14908 the variable @code{ABC}, but internally it will be stored as
14909 @samp{string([65, 66, 67])} and can still be manipulated this way; for
14910 example, the selection and vector commands @kbd{j 1 v v j u} would
14911 select the vector portion of this object and reverse the elements, then
14912 deselect to reveal a string whose characters had been reversed.
14914 The composition functions do the same thing in all language modes
14915 (although their components will of course be formatted in the current
14916 language mode).  The one exception is Unformatted mode (@kbd{d U}),
14917 which does not give the composition functions any special treatment.
14918 The functions are discussed here because of their relationship to
14919 the language modes.
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
14930 @node Composition Basics, Horizontal Compositions, Compositions, Compositions
14931 @subsubsection Composition Basics
14933 @noindent
14934 Compositions are generally formed by stacking formulas together
14935 horizontally or vertically in various ways.  Those formulas are
14936 themselves compositions.  @TeX{} users will find this analogous
14937 to @TeX{}'s ``boxes.''  Each multi-line composition has a
14938 @dfn{baseline}; horizontal compositions use the baselines to
14939 decide how formulas should be positioned relative to one another.
14940 For example, in the Big mode formula
14942 @example
14943 @group
14944           2
14945      a + b
14946 17 + ------
14947        c
14948 @end group
14949 @end example
14951 @noindent
14952 the second term of the sum is four lines tall and has line three as
14953 its baseline.  Thus when the term is combined with 17, line three
14954 is placed on the same level as the baseline of 17.
14956 @tex
14957 \bigskip
14958 @end tex
14960 Another important composition concept is @dfn{precedence}.  This is
14961 an integer that represents the binding strength of various operators.
14962 For example, @samp{*} has higher precedence (195) than @samp{+} (180),
14963 which means that @samp{(a * b) + c} will be formatted without the
14964 parentheses, but @samp{a * (b + c)} will keep the parentheses.
14966 The operator table used by normal and Big language modes has the
14967 following precedences:
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)}
14974 mod    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
14995 The general rule is that if an operator with precedence @expr{n}
14996 occurs as an argument to an operator with precedence @expr{m}, then
14997 the argument is enclosed in parentheses if @expr{n < m}.  Top-level
14998 expressions and expressions which are function arguments, vector
14999 components, etc., are formatted with precedence zero (so that they
15000 normally never get additional parentheses).
15002 For binary left-associative operators like @samp{+}, the righthand
15003 argument is actually formatted with one-higher precedence than shown
15004 in the table.  This makes sure @samp{(a + b) + c} omits the parentheses,
15005 but the unnatural form @samp{a + (b + c)} keeps its parentheses.
15006 Right-associative operators like @samp{^} format the lefthand argument
15007 with one-higher precedence.
15009 @ignore
15010 @starindex
15011 @end ignore
15012 @tindex cprec
15013 The @code{cprec} function formats an expression with an arbitrary
15014 precedence.  For example, @samp{cprec(abc, 185)} will combine into
15015 sums and products as follows:  @samp{7 + abc}, @samp{7 (abc)} (because
15016 this @code{cprec} form has higher precedence than addition, but lower
15017 precedence than multiplication).
15019 @tex
15020 \bigskip
15021 @end tex
15023 A final composition issue is @dfn{line breaking}.  Calc uses two
15024 different strategies for ``flat'' and ``non-flat'' compositions.
15025 A non-flat composition is anything that appears on multiple lines
15026 (not counting line breaking).  Examples would be matrices and Big
15027 mode powers and quotients.  Non-flat compositions are displayed
15028 exactly as specified.  If they come out wider than the current
15029 window, you must use horizontal scrolling (@kbd{<} and @kbd{>}) to
15030 view them.
15032 Flat compositions, on the other hand, will be broken across several
15033 lines if they are too wide to fit the window.  Certain points in a
15034 composition are noted internally as @dfn{break points}.  Calc's
15035 general strategy is to fill each line as much as possible, then to
15036 move down to the next line starting at the first break point that
15037 didn't fit.  However, the line breaker understands the hierarchical
15038 structure of formulas.  It will not break an ``inner'' formula if
15039 it can use an earlier break point from an ``outer'' formula instead.
15040 For example, a vector of sums might be formatted as:
15042 @example
15043 @group
15044 [ a + b + c, d + e + f,
15045   g + h + i, j + k + l, m ]
15046 @end group
15047 @end example
15049 @noindent
15050 If the @samp{m} can fit, then so, it seems, could the @samp{g}.
15051 But Calc prefers to break at the comma since the comma is part
15052 of a ``more outer'' formula.  Calc would break at a plus sign
15053 only if it had to, say, if the very first sum in the vector had
15054 itself been too large to fit.
15056 Of the composition functions described below, only @code{choriz}
15057 generates break points.  The @code{bstring} function (@pxref{Strings})
15058 also generates breakable items:  A break point is added after every
15059 space (or group of spaces) except for spaces at the very beginning or
15060 end of the string.
15062 Composition functions themselves count as levels in the formula
15063 hierarchy, 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,
15065 if 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
15067 in a function call), then the break points in that @code{bstring}
15068 will be on the same level as the break points of the surrounding
15069 object.
15071 @node Horizontal Compositions, Vertical Compositions, Composition Basics, Compositions
15072 @subsubsection Horizontal Compositions
15074 @noindent
15075 @ignore
15076 @starindex
15077 @end ignore
15078 @tindex choriz
15079 The @code{choriz} function takes a vector of objects and composes
15080 them horizontally.  For example, @samp{choriz([17, a b/c, d])} formats
15081 as @w{@samp{17a b / cd}} in Normal language mode, or as
15083 @example
15084 @group
15085   a b
15086 17---d
15087    c
15088 @end group
15089 @end example
15091 @noindent
15092 in Big language mode.  This is actually one case of the general
15093 function @samp{choriz(@var{vec}, @var{sep}, @var{prec})}, where
15094 either or both of @var{sep} and @var{prec} may be omitted.
15095 @var{Prec} gives the @dfn{precedence} to use when formatting
15096 each of the components of @var{vec}.  The default precedence is
15097 the precedence from the surrounding environment.
15099 @var{Sep} is a string (i.e., a vector of character codes as might
15100 be entered with @code{" "} notation) which should separate components
15101 of the composition.  Also, if @var{sep} is given, the line breaker
15102 will allow lines to be broken after each occurrence of @var{sep}.
15103 If @var{sep} is omitted, the composition will not be breakable
15104 (unless any of its component compositions are breakable).
15106 For example, @samp{2 choriz([a, b c, d = e], " + ", 180)} is
15107 formatted as @samp{2 a + b c + (d = e)}.  To get the @code{choriz}
15108 to have precedence 180 ``outwards'' as well as ``inwards,''
15109 enclose it in a @code{cprec} form:  @samp{2 cprec(choriz(...), 180)}
15110 formats as @samp{2 (a + b c + (d = e))}.
15112 The baseline of a horizontal composition is the same as the
15113 baselines of the component compositions, which are all aligned.
15115 @node Vertical Compositions, Other Compositions, Horizontal Compositions, Compositions
15116 @subsubsection Vertical Compositions
15118 @noindent
15119 @ignore
15120 @starindex
15121 @end ignore
15122 @tindex cvert
15123 The @code{cvert} function makes a vertical composition.  Each
15124 component of the vector is centered in a column.  The baseline of
15125 the result is by default the top line of the resulting composition.
15126 For example, @samp{f(cvert([a, bb, ccc]), cvert([a^2 + 1, b^2]))}
15127 formats in Big mode as
15129 @example
15130 @group
15131 f( a ,  2    )
15132   bb   a  + 1
15133   ccc     2
15134          b
15135 @end group
15136 @end example
15138 @ignore
15139 @starindex
15140 @end ignore
15141 @tindex cbase
15142 There are several special composition functions that work only as
15143 components of a vertical composition.  The @code{cbase} function
15144 controls the baseline of the vertical composition; the baseline
15145 will be the same as the baseline of whatever component is enclosed
15146 in @code{cbase}.  Thus @samp{f(cvert([a, cbase(bb), ccc]),
15147 cvert([a^2 + 1, cbase(b^2)]))} displays as
15149 @example
15150 @group
15151         2
15152        a  + 1
15153    a      2
15154 f(bb ,   b   )
15155   ccc
15156 @end group
15157 @end example
15159 @ignore
15160 @starindex
15161 @end ignore
15162 @tindex ctbase
15163 @ignore
15164 @starindex
15165 @end ignore
15166 @tindex cbbase
15167 There are also @code{ctbase} and @code{cbbase} functions which
15168 make the baseline of the vertical composition equal to the top
15169 or bottom line (rather than the baseline) of that component.
15170 Thus @samp{cvert([cbase(a / b)]) + cvert([ctbase(a / b)]) +
15171 cvert([cbbase(a / b)])} gives
15173 @example
15174 @group
15175         a
15176 a       -
15177 - + a + b
15178 b   -
15179     b
15180 @end group
15181 @end example
15183 There should be only one @code{cbase}, @code{ctbase}, or @code{cbbase}
15184 function in a given vertical composition.  These functions can also
15185 be written with no arguments:  @samp{ctbase()} is a zero-height object
15186 which 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
15188 item.
15190 @ignore
15191 @starindex
15192 @end ignore
15193 @tindex crule
15194 The @code{crule} function builds a ``rule,'' or horizontal line,
15195 across a vertical composition.  By itself @samp{crule()} uses @samp{-}
15196 characters to build the rule.  You can specify any other character,
15197 e.g., @samp{crule("=")}.  The argument must be a character code or
15198 vector of exactly one character code.  It is repeated to match the
15199 width of the widest item in the stack.  For example, a quotient
15200 with a thick line is @samp{cvert([a + 1, cbase(crule("=")), b^2])}:
15202 @example
15203 @group
15204 a + 1
15205 =====
15206   2
15208 @end group
15209 @end example
15211 @ignore
15212 @starindex
15213 @end ignore
15214 @tindex clvert
15215 @ignore
15216 @starindex
15217 @end ignore
15218 @tindex crvert
15219 Finally, the functions @code{clvert} and @code{crvert} act exactly
15220 like @code{cvert} except that the items are left- or right-justified
15221 in the stack.  Thus @samp{clvert([a, bb, ccc]) + crvert([a, bb, ccc])}
15222 gives:
15224 @example
15225 @group
15226 a   +   a
15227 bb     bb
15228 ccc   ccc
15229 @end group
15230 @end example
15232 Like @code{choriz}, the vertical compositions accept a second argument
15233 which gives the precedence to use when formatting the components.
15234 Vertical compositions do not support separator strings.
15236 @node Other Compositions, Information about Compositions, Vertical Compositions, Compositions
15237 @subsubsection Other Compositions
15239 @noindent
15240 @ignore
15241 @starindex
15242 @end ignore
15243 @tindex csup
15244 The @code{csup} function builds a superscripted expression.  For
15245 example, @samp{csup(a, b)} looks the same as @samp{a^b} does in Big
15246 language mode.  This is essentially a horizontal composition of
15247 @samp{a} and @samp{b}, where @samp{b} is shifted up so that its
15248 bottom line is one above the baseline.
15250 @ignore
15251 @starindex
15252 @end ignore
15253 @tindex csub
15254 Likewise, the @code{csub} function builds a subscripted expression.
15255 This shifts @samp{b} down so that its top line is one below the
15256 bottom 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.
15260 @ignore
15261 @starindex
15262 @end ignore
15263 @tindex cflat
15264 The @code{cflat} function formats its argument in ``flat'' mode,
15265 as obtained by @samp{d O}, if the current language mode is normal
15266 or 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))}
15268 to improve its readability.
15270 @ignore
15271 @starindex
15272 @end ignore
15273 @tindex cspace
15274 The @code{cspace} function creates horizontal space.  For example,
15275 @samp{cspace(4)} is effectively the same as @samp{string("    ")}.
15276 A second string (i.e., vector of characters) argument is repeated
15277 instead of the space character.  For example, @samp{cspace(4, "ab")}
15278 looks like @samp{abababab}.  If the second argument is not a string,
15279 it is formatted in the normal way and then several copies of that
15280 are composed together:  @samp{cspace(4, a^2)} yields
15282 @example
15283 @group
15284  2 2 2 2
15285 a a a a
15286 @end group
15287 @end example
15289 @noindent
15290 If the number argument is zero, this is a zero-width object.
15292 @ignore
15293 @starindex
15294 @end ignore
15295 @tindex cvspace
15296 The @code{cvspace} function creates vertical space, or a vertical
15297 stack of copies of a certain string or formatted object.  The
15298 baseline is the center line of the resulting stack.  A numerical
15299 argument of zero will produce an object which contributes zero
15300 height if used in a vertical composition.
15302 @ignore
15303 @starindex
15304 @end ignore
15305 @tindex ctspace
15306 @ignore
15307 @starindex
15308 @end ignore
15309 @tindex cbspace
15310 There are also @code{ctspace} and @code{cbspace} functions which
15311 create vertical space with the baseline the same as the baseline
15312 of the top or bottom copy, respectively, of the second argument.
15313 Thus @samp{cvspace(2, a/b) + ctspace(2, a/b) + cbspace(2, a/b)}
15314 displays as:
15316 @example
15317 @group
15318         a
15319         -
15320 a       b
15321 -   a   a
15322 b + - + -
15323 a   b   b
15324 -   a
15325 b   -
15326     b
15327 @end group
15328 @end example
15330 @node Information about Compositions, User-Defined Compositions, Other Compositions, Compositions
15331 @subsubsection Information about Compositions
15333 @noindent
15334 The functions in this section are actual functions; they compose their
15335 arguments according to the current language and other display modes,
15336 then return a certain measurement of the composition as an integer.
15338 @ignore
15339 @starindex
15340 @end ignore
15341 @tindex cwidth
15342 The @code{cwidth} function measures the width, in characters, of a
15343 composition.  For example, @samp{cwidth(a + b)} is 5, and
15344 @samp{cwidth(a / b)} is 5 in Normal mode, 1 in Big mode, and 11 in
15345 @TeX{} mode (for @samp{@{a \over b@}}).  The argument may involve
15346 the composition functions described in this section.
15348 @ignore
15349 @starindex
15350 @end ignore
15351 @tindex cheight
15352 The @code{cheight} function measures the height of a composition.
15353 This is the total number of lines in the argument's printed form.
15355 @ignore
15356 @starindex
15357 @end ignore
15358 @tindex cascent
15359 @ignore
15360 @starindex
15361 @end ignore
15362 @tindex cdescent
15363 The functions @code{cascent} and @code{cdescent} measure the amount
15364 of the height that is above (and including) the baseline, or below
15365 the baseline, respectively.  Thus @samp{cascent(@var{x}) + cdescent(@var{x})}
15366 always equals @samp{cheight(@var{x})}.  For a one-line formula like
15367 @samp{a + b}, @code{cascent} returns 1 and @code{cdescent} returns 0.
15368 For @samp{a / b} in Big mode, @code{cascent} returns 2 and @code{cdescent}
15369 returns 1.  The only formula for which @code{cascent} will return zero
15370 is @samp{cvspace(0)} or equivalents.
15372 @node User-Defined Compositions, , Information about Compositions, Compositions
15373 @subsubsection User-Defined Compositions
15375 @noindent
15376 @kindex Z C
15377 @pindex calc-user-define-composition
15378 The @kbd{Z C} (@code{calc-user-define-composition}) command lets you
15379 define the display format for any algebraic function.  You provide a
15380 formula containing a certain number of argument variables on the stack.
15381 Any time Calc formats a call to the specified function in the current
15382 language mode and with that number of arguments, Calc effectively
15383 replaces the function call with that formula with the arguments
15384 replaced.
15386 Calc builds the default argument list by sorting all the variable names
15387 that appear in the formula into alphabetical order.  You can edit this
15388 argument list before pressing @key{RET} if you wish.  Any variables in
15389 the formula that do not appear in the argument list will be displayed
15390 literally; any arguments that do not appear in the formula will not
15391 affect the display at all.
15393 You can define formats for built-in functions, for functions you have
15394 defined with @kbd{Z F} (@pxref{Algebraic Definitions}), or for functions
15395 which have no definitions but are being used as purely syntactic objects.
15396 You can define different formats for each language mode, and for each
15397 number of arguments, using a succession of @kbd{Z C} commands.  When
15398 Calc formats a function call, it first searches for a format defined
15399 for the current language mode (and number of arguments); if there is
15400 none, it uses the format defined for the Normal language mode.  If
15401 neither format exists, Calc uses its built-in standard format for that
15402 function (usually just @samp{@var{func}(@var{args})}).
15404 If you execute @kbd{Z C} with the number 0 on the stack instead of a
15405 formula, any defined formats for the function in the current language
15406 mode will be removed.  The function will revert to its standard format.
15408 For example, the default format for the binomial coefficient function
15409 @samp{choose(n, m)} in the Big language mode is
15411 @example
15412 @group
15414 ( )
15416 @end group
15417 @end example
15419 @noindent
15420 You might prefer the notation,
15422 @example
15423 @group
15425 n m
15426 @end group
15427 @end example
15429 @noindent
15430 To define this notation, first make sure you are in Big mode,
15431 then put the formula
15433 @smallexample
15434 choriz([cvert([cvspace(1), n]), C, cvert([cvspace(1), m])])
15435 @end smallexample
15437 @noindent
15438 on the stack and type @kbd{Z C}.  Answer the first prompt with
15439 @code{choose}.  The second prompt will be the default argument list
15440 of @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
15442 off with @kbd{m O} and enter @samp{choose(a,b) + choose(7,3)}
15443 as an algebraic entry.
15445 @example
15446 @group
15447  C  +  C
15448 a b   7 3
15449 @end group
15450 @end example
15452 As another example, let's define the usual notation for Stirling
15453 numbers of the first kind, @samp{stir1(n, m)}.  This is just like
15454 the regular format for binomial coefficients but with square brackets
15455 instead of parentheses.
15457 @smallexample
15458 choriz([string("["), cvert([n, cbase(cvspace(1)), m]), string("]")])
15459 @end smallexample
15461 Now type @kbd{Z C stir1 @key{RET}}, edit the argument list to
15462 @samp{(n m)}, and type @key{RET}.
15464 The formula provided to @kbd{Z C} usually will involve composition
15465 functions, but it doesn't have to.  Putting the formula @samp{a + b + c}
15466 onto the stack and typing @kbd{Z C foo @key{RET} @key{RET}} would define
15467 the function @samp{foo(x,y,z)} to display like @samp{x + y + z}.
15468 This ``sum'' will act exactly like a real sum for all formatting
15469 purposes (it will be parenthesized the same, and so on).  However
15470 it will be computationally unrelated to a sum.  For example, the
15471 formula @samp{2 * foo(1, 2, 3)} will display as @samp{2 (1 + 2 + 3)}.
15472 Operator precedences have caused the ``sum'' to be written in
15473 parentheses, but the arguments have not actually been summed.
15474 (Generally a display format like this would be undesirable, since
15475 it can easily be confused with a real sum.)
15477 The special function @code{eval} can be used inside a @kbd{Z C}
15478 composition formula to cause all or part of the formula to be
15479 evaluated at display time.  For example, if the formula is
15480 @samp{a + eval(b + c)}, then @samp{foo(1, 2, 3)} will be displayed
15481 as @samp{1 + 5}.  Evaluation will use the default simplifications,
15482 regardless 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''
15485 operate only in the context of composition formulas (and also in
15486 rewrite rules, where they serve a similar purpose; @pxref{Rewrite
15487 Rules}).  On the stack, a call to @code{eval} will be left in
15488 symbolic form.
15490 It is not a good idea to use @code{eval} except as a last resort.
15491 It can cause the display of formulas to be extremely slow.  For
15492 example, while @samp{eval(a + b)} might seem quite fast and simple,
15493 there are several situations where it could be slow.  For example,
15494 @samp{a} and/or @samp{b} could be polar complex numbers, in which
15495 case doing the sum requires trigonometry.  Or, @samp{a} could be
15496 the factorial @samp{fact(100)} which is unevaluated because you
15497 have typed @kbd{m O}; @code{eval} will evaluate it anyway to
15498 produce a large, unwieldy integer.
15500 You can save your display formats permanently using the @kbd{Z P}
15501 command (@pxref{Creating User Keys}).
15503 @node Syntax Tables, , Compositions, Language Modes
15504 @subsection Syntax Tables
15506 @noindent
15507 @cindex Syntax tables
15508 @cindex Parsing formulas, customized
15509 Syntax tables do for input what compositions do for output:  They
15510 allow you to teach custom notations to Calc's formula parser.
15511 Calc keeps a separate syntax table for each language mode.
15513 (Note that the Calc ``syntax tables'' discussed here are completely
15514 unrelated to the syntax tables described in the Emacs manual.)
15516 @kindex Z S
15517 @pindex calc-edit-user-syntax
15518 The @kbd{Z S} (@code{calc-edit-user-syntax}) command edits the
15519 syntax table for the current language mode.  If you want your
15520 syntax to work in any language, define it in the Normal language
15521 mode.  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
15523 the syntax tables along with the other mode settings;
15524 @pxref{General Mode Commands}.
15526 @menu
15527 * Syntax Table Basics::
15528 * Precedence in Syntax Tables::
15529 * Advanced Syntax Patterns::
15530 * Conditional Syntax Rules::
15531 @end menu
15533 @node Syntax Table Basics, Precedence in Syntax Tables, Syntax Tables, Syntax Tables
15534 @subsubsection Syntax Table Basics
15536 @noindent
15537 @dfn{Parsing} is the process of converting a raw string of characters,
15538 such as you would type in during algebraic entry, into a Calc formula.
15539 Calc's parser works in two stages.  First, the input is broken down
15540 into @dfn{tokens}, such as words, numbers, and punctuation symbols
15541 like @samp{+}, @samp{:=}, and @samp{+/-}.  Space between tokens is
15542 ignored (except when it serves to separate adjacent words).  Next,
15543 the parser matches this string of tokens against various built-in
15544 syntactic patterns, such as ``an expression followed by @samp{+}
15545 followed by another expression'' or ``a name followed by @samp{(},
15546 zero or more expressions separated by commas, and @samp{)}.''
15548 A @dfn{syntax table} is a list of user-defined @dfn{syntax rules},
15549 which allow you to specify new patterns to define your own
15550 favorite input notations.  Calc's parser always checks the syntax
15551 table for the current language mode, then the table for the Normal
15552 language mode, before it uses its built-in rules to parse an
15553 algebraic formula you have entered.  Each syntax rule should go on
15554 its own line; it consists of a @dfn{pattern}, a @samp{:=} symbol,
15555 and a Calc formula with an optional @dfn{condition}.  (Syntax rules
15556 resemble algebraic rewrite rules, but the notation for patterns is
15557 completely different.)
15559 A syntax pattern is a list of tokens, separated by spaces.
15560 Except for a few special symbols, tokens in syntax patterns are
15561 matched literally, from left to right.  For example, the rule,
15563 @example
15564 foo ( ) := 2+3
15565 @end example
15567 @noindent
15568 would cause Calc to parse the formula @samp{4+foo()*5} as if it
15569 were @samp{4+(2+3)*5}.  Notice that the parentheses were written
15570 as two separate tokens in the rule.  As a result, the rule works
15571 for both @samp{foo()} and @w{@samp{foo (  )}}.  If we had written
15572 the rule as @samp{foo () := 2+3}, then Calc would treat @samp{()}
15573 as a single, indivisible token, so that @w{@samp{foo( )}} would
15574 not be recognized by the rule.  (It would be parsed as a regular
15575 zero-argument function call instead.)  In fact, this rule would
15576 also make trouble for the rest of Calc's parser:  An unrelated
15577 formula like @samp{bar()} would now be tokenized into @samp{bar ()}
15578 instead of @samp{bar ( )}, so that the standard parser for function
15579 calls would no longer recognize it!
15581 While it is possible to make a token with a mixture of letters
15582 and punctuation symbols, this is not recommended.  It is better to
15583 break it into several tokens, as we did with @samp{foo()} above.
15585 The symbol @samp{#} in a syntax pattern matches any Calc expression.
15586 On the righthand side, the things that matched the @samp{#}s can
15587 be referred to as @samp{#1}, @samp{#2}, and so on (where @samp{#1}
15588 matches the leftmost @samp{#} in the pattern).  For example, these
15589 rules match a user-defined function, prefix operator, infix operator,
15590 and postfix operator, respectively:
15592 @example
15593 foo ( # ) := myfunc(#1)
15594 foo # := myprefix(#1)
15595 # foo # := myinfix(#1,#2)
15596 # foo := mypostfix(#1)
15597 @end example
15599 Thus @samp{foo(3)} will parse as @samp{myfunc(3)}, and @samp{2+3 foo}
15600 will parse as @samp{mypostfix(2+3)}.
15602 It is important to write the first two rules in the order shown,
15603 because Calc tries rules in order from first to last.  If the
15604 pattern @samp{foo #} came first, it would match anything that could
15605 match the @samp{foo ( # )} rule, since an expression in parentheses
15606 is itself a valid expression.  Thus the @w{@samp{foo ( # )}} rule would
15607 never get to match anything.  Likewise, the last two rules must be
15608 written 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
15610 ambiguities is not to use the same symbol in more than one way at
15611 the same time!  In case you're not convinced, try the following
15612 exercise:  How will the above rules parse the input @samp{foo(3,4)},
15613 if at all?  Work it out for yourself, then try it in Calc and see.)
15615 Calc is quite flexible about what sorts of patterns are allowed.
15616 The only rule is that every pattern must begin with a literal
15617 token (like @samp{foo} in the first two patterns above), or with
15618 a @samp{#} followed by a literal token (as in the last two
15619 patterns).  After that, any mixture is allowed, although putting
15620 two @samp{#}s in a row will not be very useful since two
15621 expressions with nothing between them will be parsed as one
15622 expression that uses implicit multiplication.
15624 As 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
15626 recognize at present.  To handle this syntax, we simply add the
15627 rule,
15629 @example
15630 sum ( # , # = # .. # ) := sum(#1,#2,#3,#4)
15631 @end example
15633 @noindent
15634 to the Maple mode syntax table.  As another example, C mode can't
15635 read assignment operators like @samp{++} and @samp{*=}.  We can
15636 define these operators quite easily:
15638 @example
15639 # *= # := muleq(#1,#2)
15640 # ++ := postinc(#1)
15641 ++ # := preinc(#1)
15642 @end example
15644 @noindent
15645 To complete the job, we would use corresponding composition functions
15646 and @kbd{Z C} to cause these functions to display in their respective
15647 Maple and C notations.  (Note that the C example ignores issues of
15648 operator precedence, which are discussed in the next section.)
15650 You can enclose any token in quotes to prevent its usual
15651 interpretation in syntax patterns:
15653 @example
15654 # ":=" # := becomes(#1,#2)
15655 @end example
15657 Quotes also allow you to include spaces in a token, although once
15658 again it is generally better to use two tokens than one token with
15659 an embedded space.  To include an actual quotation mark in a quoted
15660 token, precede it with a backslash.  (This also works to include
15661 backslashes in tokens.)
15663 @example
15664 # "bad token" # "/\"\\" # := silly(#1,#2,#3)
15665 @end example
15667 @noindent
15668 This will parse @samp{3 bad token 4 /"\ 5} to @samp{silly(3,4,5)}.
15670 The token @kbd{#} has a predefined meaning in Calc's formula parser;
15671 it is not valid to use @samp{"#"} in a syntax rule.  However, longer
15672 tokens that include the @samp{#} character are allowed.  Also, while
15673 @samp{"$"} and @samp{"\""} are allowed as tokens, their presence in
15674 the syntax table will prevent those characters from working in their
15675 usual ways (referring to stack entries and quoting strings,
15676 respectively).
15678 Finally, the notation @samp{%%} anywhere in a syntax table causes
15679 the rest of the line to be ignored as a comment.
15681 @node Precedence in Syntax Tables, Advanced Syntax Patterns, Syntax Table Basics, Syntax Tables
15682 @subsubsection Precedence
15684 @noindent
15685 Different operators are generally assigned different @dfn{precedences}.
15686 By default, an operator defined by a rule like
15688 @example
15689 # foo # := foo(#1,#2)
15690 @end example
15692 @noindent
15693 will have an extremely low precedence, so that @samp{2*3+4 foo 5 == 6}
15694 will be parsed as @samp{(2*3+4) foo (5 == 6)}.  To change the
15695 precedence of an operator, use the notation @samp{#/@var{p}} in
15696 place of @samp{#}, where @var{p} is an integer precedence level.
15697 For example, 185 lies between the precedences for @samp{+} and
15698 @samp{*}, so if we change this rule to
15700 @example
15701 #/185 foo #/186 := foo(#1,#2)
15702 @end example
15704 @noindent
15705 then @samp{2+3 foo 4*5} will be parsed as @samp{2+(3 foo (4*5))}.
15706 Also, because we've given the righthand expression slightly higher
15707 precedence, our new operator will be left-associative:
15708 @samp{1 foo 2 foo 3} will be parsed as @samp{(1 foo 2) foo 3}.
15709 By raising the precedence of the lefthand expression instead, we
15710 can create a right-associative operator.
15712 @xref{Composition Basics}, for a table of precedences of the
15713 standard Calc operators.  For the precedences of operators in other
15714 language modes, look in the Calc source file @file{calc-lang.el}.
15716 @node Advanced Syntax Patterns, Conditional Syntax Rules, Precedence in Syntax Tables, Syntax Tables
15717 @subsubsection Advanced Syntax Patterns
15719 @noindent
15720 To match a function with a variable number of arguments, you could
15721 write
15723 @example
15724 foo ( # ) := myfunc(#1)
15725 foo ( # , # ) := myfunc(#1,#2)
15726 foo ( # , # , # ) := myfunc(#1,#2,#3)
15727 @end example
15729 @noindent
15730 but this isn't very elegant.  To match variable numbers of items,
15731 Calc uses some notations inspired regular expressions and the
15732 ``extended BNF'' style used by some language designers.
15734 @example
15735 foo ( @{ # @}*, ) := apply(myfunc,#1)
15736 @end example
15738 The token @samp{@{} introduces a repeated or optional portion.
15739 One of the three tokens @samp{@}*}, @samp{@}+}, or @samp{@}?}
15740 ends the portion.  These will match zero or more, one or more,
15741 or zero or one copies of the enclosed pattern, respectively.
15742 In addition, @samp{@}*} and @samp{@}+} can be followed by a
15743 separator token (with no space in between, as shown above).
15744 Thus @samp{@{ # @}*,} matches nothing, or one expression, or
15745 several expressions separated by commas.
15747 A complete @samp{@{ ... @}} item matches as a vector of the
15748 items that matched inside it.  For example, the above rule will
15749 match @samp{foo(1,2,3)} to get @samp{apply(myfunc,[1,2,3])}.
15750 The Calc @code{apply} function takes a function name and a vector
15751 of arguments and builds a call to the function with those
15752 arguments, so the net result is the formula @samp{myfunc(1,2,3)}.
15754 If the body of a @samp{@{ ... @}} contains several @samp{#}s
15755 (or nested @samp{@{ ... @}} constructs), then the items will be
15756 strung together into the resulting vector.  If the body
15757 does not contain anything but literal tokens, the result will
15758 always be an empty vector.
15760 @example
15761 foo ( @{ # , # @}+, ) := bar(#1)
15762 foo ( @{ @{ # @}*, @}*; ) := matrix(#1)
15763 @end example
15765 @noindent
15766 will 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
15768 some thought it's easy to see how this pair of rules will parse
15769 @samp{foo(1, 2, 3)} as @samp{matrix([[1, 2, 3]])}, since the first
15770 rule will only match an even number of arguments.  The rule
15772 @example
15773 foo ( # @{ , # , # @}? ) := bar(#1,#2)
15774 @end example
15776 @noindent
15777 will parse @samp{foo(2,3,4)} as @samp{bar(2,[3,4])}, and
15778 @samp{foo(2)} as @samp{bar(2,[])}.
15780 The notation @samp{@{ ... @}?.} (note the trailing period) works
15781 just the same as regular @samp{@{ ... @}?}, except that it does not
15782 count as an argument; the following two rules are equivalent:
15784 @example
15785 foo ( # , @{ also @}? # ) := bar(#1,#3)
15786 foo ( # , @{ also @}?. # ) := bar(#1,#2)
15787 @end example
15789 @noindent
15790 Note that in the first case the optional text counts as @samp{#2},
15791 which will always be an empty vector, but in the second case no
15792 empty vector is produced.
15794 Another variant is @samp{@{ ... @}?$}, which means the body is
15795 optional only at the end of the input formula.  All built-in syntax
15796 rules in Calc use this for closing delimiters, so that during
15797 algebraic entry you can type @kbd{[sqrt(2), sqrt(3 @key{RET}}, omitting
15798 the closing parenthesis and bracket.  Calc does this automatically
15799 for trailing @samp{)}, @samp{]}, and @samp{>} tokens in syntax
15800 rules, but you can use @samp{@{ ... @}?$} explicitly to get
15801 this effect with any token (such as @samp{"@}"} or @samp{end}).
15802 Like @samp{@{ ... @}?.}, this notation does not count as an
15803 argument.  Conversely, you can use quotes, as in @samp{")"}, to
15804 prevent a closing-delimiter token from being automatically treated
15805 as optional.
15807 Calc's parser does not have full backtracking, which means some
15808 patterns will not work as you might expect:
15810 @example
15811 foo ( @{ # , @}? # , # ) := bar(#1,#2,#3)
15812 @end example
15814 @noindent
15815 Here we are trying to make the first argument optional, so that
15816 @samp{foo(2,3)} parses as @samp{bar([],2,3)}.  Unfortunately, Calc
15817 first tries to match @samp{2,} against the optional part of the
15818 pattern, finds a match, and so goes ahead to match the rest of the
15819 pattern.  Later on it will fail to match the second comma, but it
15820 doesn't know how to go back and try the other alternative at that
15821 point.  One way to get around this would be to use two rules:
15823 @example
15824 foo ( # , # , # ) := bar([#1],#2,#3)
15825 foo ( # , # ) := bar([],#1,#2)
15826 @end example
15828 More precisely, when Calc wants to match an optional or repeated
15829 part of a pattern, it scans forward attempting to match that part.
15830 If it reaches the end of the optional part without failing, it
15831 ``finalizes'' its choice and proceeds.  If it fails, though, it
15832 backs up and tries the other alternative.  Thus Calc has ``partial''
15833 backtracking.  A fully backtracking parser would go on to make sure
15834 the rest of the pattern matched before finalizing the choice.
15836 @node Conditional Syntax Rules, , Advanced Syntax Patterns, Syntax Tables
15837 @subsubsection Conditional Syntax Rules
15839 @noindent
15840 It is possible to attach a @dfn{condition} to a syntax rule.  For
15841 example, the rules
15843 @example
15844 foo ( # ) := ifoo(#1) :: integer(#1)
15845 foo ( # ) := gfoo(#1)
15846 @end example
15848 @noindent
15849 will 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
15851 number of conditions may be attached; all must be true for the
15852 rule to succeed.  A condition is ``true'' if it evaluates to a
15853 nonzero number.  @xref{Logical Operations}, for a list of Calc
15854 functions like @code{integer} that perform logical tests.
15856 The exact sequence of events is as follows:  When Calc tries a
15857 rule, it first matches the pattern as usual.  It then substitutes
15858 @samp{#1}, @samp{#2}, etc., in the conditions, if any.  Next, the
15859 conditions are simplified and evaluated in order from left to right,
15860 as if by the @w{@kbd{a s}} algebra command (@pxref{Simplifying Formulas}).
15861 Each result is true if it is a nonzero number, or an expression
15862 that can be proven to be nonzero (@pxref{Declarations}).  If the
15863 results of all conditions are true, the expression (such as
15864 @samp{ifoo(#1)}) has its @samp{#}s substituted, and that is the
15865 result of the parse.  If the result of any condition is false, Calc
15866 goes on to try the next rule in the syntax table.
15868 Syntax rules also support @code{let} conditions, which operate in
15869 exactly the same way as they do in algebraic rewrite rules.
15870 @xref{Other Features of Rewrite Rules}, for details.  A @code{let}
15871 condition is always true, but as a side effect it defines a
15872 variable which can be used in later conditions, and also in the
15873 expression after the @samp{:=} sign:
15875 @example
15876 foo ( # ) := hifoo(x) :: let(x := #1 + 0.5) :: dnumint(x)
15877 @end example
15879 @noindent
15880 The @code{dnumint} function tests if a value is numerically an
15881 integer, i.e., either a true integer or an integer-valued float.
15882 This rule will parse @code{foo} with a half-integer argument,
15883 like @samp{foo(3.5)}, to a call like @samp{hifoo(4.)}.
15885 The lefthand side of a syntax rule @code{let} must be a simple
15886 variable, not the arbitrary pattern that is allowed in rewrite
15887 rules.
15889 The @code{matches} function is also treated specially in syntax
15890 rule conditions (again, in the same way as in rewrite rules).
15891 @xref{Matching Commands}.  If the matching pattern contains
15892 meta-variables, then those meta-variables may be used in later
15893 conditions and in the result expression.  The arguments to
15894 @code{matches} are not evaluated in this situation.
15896 @example
15897 sum ( # , # ) := sum(#1,a,b,c) :: matches(#2, a=[b..c])
15898 @end example
15900 @noindent
15901 This is another way to implement the Maple mode @code{sum} notation.
15902 In 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
15904 its components.  If the expression turns out not to match the pattern,
15905 the syntax rule will fail.  Note that @kbd{Z S} always uses Calc's
15906 Normal language mode for editing expressions in syntax rules, so we
15907 must use regular Calc notation for the interval @samp{[b..c]} that
15908 will correspond to the Maple mode interval @samp{1..10}.
15910 @node Modes Variable, Calc Mode Line, Language Modes, Mode Settings
15911 @section The @code{Modes} Variable
15913 @noindent
15914 @kindex m g
15915 @pindex calc-get-modes
15916 The @kbd{m g} (@code{calc-get-modes}) command pushes onto the stack
15917 a vector of numbers that describes the various mode settings that
15918 are 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
15920 macros can use the @kbd{m g} command to modify their behavior based
15921 on the current mode settings.
15923 @cindex @code{Modes} variable
15924 @vindex Modes
15925 The modes vector is also available in the special variable
15926 @code{Modes}.  In other words, @kbd{m g} is like @kbd{s r Modes @key{RET}}.
15927 It 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}
15929 command will continue to work, however.)
15931 In general, each number in this vector is suitable as a numeric
15932 prefix argument to the associated mode-setting command.  (Recall
15933 that the @kbd{~} key takes a number from the stack and gives it as
15934 a numeric prefix to the next command.)
15936 The elements of the modes vector are as follows:
15938 @enumerate
15939 @item
15940 Current precision.  Default is 12; associated command is @kbd{p}.
15942 @item
15943 Binary word size.  Default is 32; associated command is @kbd{b w}.
15945 @item
15946 Stack size (not counting the value about to be pushed by @kbd{m g}).
15947 This is zero if @kbd{m g} is executed with an empty stack.
15949 @item
15950 Number radix.  Default is 10; command is @kbd{d r}.
15952 @item
15953 Floating-point format.  This is the number of digits, plus the
15954 constant 0 for normal notation, 10000 for scientific notation,
15955 20000 for engineering notation, or 30000 for fixed-point notation.
15956 These codes are acceptable as prefix arguments to the @kbd{d n}
15957 command, 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
15959 identical) effects if the current precision is 12, but they both
15960 produce 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
15962 will still be frozen at 12 significant figures.
15964 @item
15965 Angular mode.  Default is 1 (degrees).  Other values are 2 (radians)
15966 and 3 (HMS).  The @kbd{m d} command accepts these prefixes.
15968 @item
15969 Symbolic mode.  Value is 0 or 1; default is 0.  Command is @kbd{m s}.
15971 @item
15972 Fraction mode.  Value is 0 or 1; default is 0.  Command is @kbd{m f}.
15974 @item
15975 Polar mode.  Value is 0 (rectangular) or 1 (polar); default is 0.
15976 Command is @kbd{m p}.
15978 @item
15979 Matrix/Scalar mode.  Default value is @mathit{-1}.  Value is 0 for Scalar
15980 mode, @mathit{-2} for Matrix mode, or @var{N} for 
15981 @texline @math{N\times N}
15982 @infoline @var{N}x@var{N} 
15983 Matrix mode.  Command is @kbd{m v}.
15985 @item
15986 Simplification mode.  Default is 1.  Value is @mathit{-1} for off (@kbd{m O}),
15987 0 for @kbd{m N}, 2 for @kbd{m B}, 3 for @kbd{m A}, 4 for @kbd{m E},
15988 or 5 for @w{@kbd{m U}}.  The @kbd{m D} command accepts these prefixes.
15990 @item
15991 Infinite mode.  Default is @mathit{-1} (off).  Value is 1 if the mode is on,
15992 or 0 if the mode is on with positive zeros.  Command is @kbd{m i}.
15993 @end enumerate
15995 For example, the sequence @kbd{M-1 m g @key{RET} 2 + ~ p} increases the
15996 precision by two, leaving a copy of the old precision on the stack.
15997 Later, @kbd{~ p} will restore the original precision using that
15998 stack value.  (This sequence might be especially useful inside a
15999 keyboard macro.)
16001 As another example, @kbd{M-3 m g 1 - ~ @key{DEL}} deletes all but the
16002 oldest (bottommost) stack entry.
16004 Yet another example:  The HP-48 ``round'' command rounds a number
16005 to the current displayed precision.  You could roughly emulate this
16006 in Calc with the sequence @kbd{M-5 m g 10000 % ~ c c}.  (This
16007 would not work for fixed-point mode, but it wouldn't be hard to
16008 do a full emulation with the help of the @kbd{Z [} and @kbd{Z ]}
16009 programming commands.  @xref{Conditionals in Macros}.)
16011 @node Calc Mode Line, , Modes Variable, Mode Settings
16012 @section The Calc Mode Line
16014 @noindent
16015 @cindex Mode line indicators
16016 This section is a summary of all symbols that can appear on the
16017 Calc mode line, the highlighted bar that appears under the Calc
16018 stack window (or under an editing window in Embedded mode).
16020 The basic mode line format is:
16022 @example
16023 --%%-Calc: 12 Deg @var{other modes}       (Calculator)
16024 @end example
16026 The @samp{%%} is the Emacs symbol for ``read-only''; it shows that
16027 regular Emacs commands are not allowed to edit the stack buffer
16028 as if it were text.
16030 The word @samp{Calc:} changes to @samp{CalcEmbed:} if Embedded mode
16031 is enabled.  The words after this describe the various Calc modes
16032 that are in effect.
16034 The first mode is always the current precision, an integer.
16035 The second mode is always the angular mode, either @code{Deg},
16036 @code{Rad}, or @code{Hms}.
16038 Here is a complete list of the remaining symbols that can appear
16039 on the mode line:
16041 @table @code
16042 @item Alg
16043 Algebraic mode (@kbd{m a}; @pxref{Algebraic Entry}).
16045 @item Alg[(
16046 Incomplete algebraic mode (@kbd{C-u m a}).
16048 @item Alg*
16049 Total algebraic mode (@kbd{m t}).
16051 @item Symb
16052 Symbolic mode (@kbd{m s}; @pxref{Symbolic Mode}).
16054 @item Matrix
16055 Matrix mode (@kbd{m v}; @pxref{Matrix Mode}).
16057 @item Matrix@var{n}
16058 Dimensioned Matrix mode (@kbd{C-u @var{n} m v}).
16060 @item Scalar
16061 Scalar mode (@kbd{m v}; @pxref{Matrix Mode}).
16063 @item Polar
16064 Polar complex mode (@kbd{m p}; @pxref{Polar Mode}).
16066 @item Frac
16067 Fraction mode (@kbd{m f}; @pxref{Fraction Mode}).
16069 @item Inf
16070 Infinite mode (@kbd{m i}; @pxref{Infinite Mode}).
16072 @item +Inf
16073 Positive Infinite mode (@kbd{C-u 0 m i}).
16075 @item NoSimp
16076 Default simplifications off (@kbd{m O}; @pxref{Simplification Modes}).
16078 @item NumSimp
16079 Default simplifications for numeric arguments only (@kbd{m N}).
16081 @item BinSimp@var{w}
16082 Binary-integer simplification mode; word size @var{w} (@kbd{m B}, @kbd{b w}).
16084 @item AlgSimp
16085 Algebraic simplification mode (@kbd{m A}).
16087 @item ExtSimp
16088 Extended algebraic simplification mode (@kbd{m E}).
16090 @item UnitSimp
16091 Units simplification mode (@kbd{m U}).
16093 @item Bin
16094 Current radix is 2 (@kbd{d 2}; @pxref{Radix Modes}).
16096 @item Oct
16097 Current radix is 8 (@kbd{d 8}).
16099 @item Hex
16100 Current radix is 16 (@kbd{d 6}).
16102 @item Radix@var{n}
16103 Current radix is @var{n} (@kbd{d r}).
16105 @item Zero
16106 Leading zeros (@kbd{d z}; @pxref{Radix Modes}).
16108 @item Big
16109 Big language mode (@kbd{d B}; @pxref{Normal Language Modes}).
16111 @item Flat
16112 One-line normal language mode (@kbd{d O}).
16114 @item Unform
16115 Unformatted language mode (@kbd{d U}).
16117 @item C
16118 C language mode (@kbd{d C}; @pxref{C FORTRAN Pascal}).
16120 @item Pascal
16121 Pascal language mode (@kbd{d P}).
16123 @item Fortran
16124 FORTRAN language mode (@kbd{d F}).
16126 @item TeX
16127 @TeX{} language mode (@kbd{d T}; @pxref{TeX and LaTeX Language Modes}).
16129 @item LaTeX
16130 La@TeX{} language mode (@kbd{d L}; @pxref{TeX and LaTeX Language Modes}).
16132 @item Eqn
16133 @dfn{Eqn} language mode (@kbd{d E}; @pxref{Eqn Language Mode}).
16135 @item Math
16136 Mathematica language mode (@kbd{d M}; @pxref{Mathematica Language Mode}).
16138 @item Maple
16139 Maple language mode (@kbd{d W}; @pxref{Maple Language Mode}).
16141 @item Norm@var{n}
16142 Normal float mode with @var{n} digits (@kbd{d n}; @pxref{Float Formats}).
16144 @item Fix@var{n}
16145 Fixed point mode with @var{n} digits after the point (@kbd{d f}).
16147 @item Sci
16148 Scientific notation mode (@kbd{d s}).
16150 @item Sci@var{n}
16151 Scientific notation with @var{n} digits (@kbd{d s}).
16153 @item Eng
16154 Engineering notation mode (@kbd{d e}).
16156 @item Eng@var{n}
16157 Engineering notation with @var{n} digits (@kbd{d e}).
16159 @item Left@var{n}
16160 Left-justified display indented by @var{n} (@kbd{d <}; @pxref{Justification}).
16162 @item Right
16163 Right-justified display (@kbd{d >}).
16165 @item Right@var{n}
16166 Right-justified display with width @var{n} (@kbd{d >}).
16168 @item Center
16169 Centered display (@kbd{d =}).
16171 @item Center@var{n}
16172 Centered display with center column @var{n} (@kbd{d =}).
16174 @item Wid@var{n}
16175 Line breaking with width @var{n} (@kbd{d b}; @pxref{Normal Language Modes}).
16177 @item Wide
16178 No line breaking (@kbd{d b}).
16180 @item Break
16181 Selections show deep structure (@kbd{j b}; @pxref{Making Selections}).
16183 @item Save
16184 Record modes in @file{~/.calc.el} (@kbd{m R}; @pxref{General Mode Commands}).
16186 @item Local
16187 Record modes in Embedded buffer (@kbd{m R}).
16189 @item LocEdit
16190 Record modes as editing-only in Embedded buffer (@kbd{m R}).
16192 @item LocPerm
16193 Record modes as permanent-only in Embedded buffer (@kbd{m R}).
16195 @item Global
16196 Record modes as global in Embedded buffer (@kbd{m R}).
16198 @item Manual
16199 Automatic recomputation turned off (@kbd{m C}; @pxref{Automatic
16200 Recomputation}).
16202 @item Graph
16203 GNUPLOT process is alive in background (@pxref{Graphics}).
16205 @item Sel
16206 Top-of-stack has a selection (Embedded only; @pxref{Making Selections}).
16208 @item Dirty
16209 The stack display may not be up-to-date (@pxref{Display Modes}).
16211 @item Inv
16212 ``Inverse'' prefix was pressed (@kbd{I}; @pxref{Inverse and Hyperbolic}).
16214 @item Hyp
16215 ``Hyperbolic'' prefix was pressed (@kbd{H}).
16217 @item Keep
16218 ``Keep-arguments'' prefix was pressed (@kbd{K}).
16220 @item Narrow
16221 Stack is truncated (@kbd{d t}; @pxref{Truncating the Stack}).
16222 @end table
16224 In addition, the symbols @code{Active} and @code{~Active} can appear
16225 as minor modes on an Embedded buffer's mode line.  @xref{Embedded Mode}.
16227 @node Arithmetic, Scientific Functions, Mode Settings, Top
16228 @chapter Arithmetic Functions
16230 @noindent
16231 This chapter describes the Calc commands for doing simple calculations
16232 on numbers, such as addition, absolute value, and square roots.  These
16233 commands work by removing the top one or two values from the stack,
16234 performing the desired operation, and pushing the result back onto the
16235 stack.  If the operation cannot be performed, the result pushed is a
16236 formula instead of a number, such as @samp{2/0} (because division by zero
16237 is invalid) or @samp{sqrt(x)} (because the argument @samp{x} is a formula).
16239 Most of the commands described here can be invoked by a single keystroke.
16240 Some of the more obscure ones are two-letter sequences beginning with
16241 the @kbd{f} (``functions'') prefix key.
16243 @xref{Prefix Arguments}, for a discussion of the effect of numeric
16244 prefix arguments on commands in this chapter which do not otherwise
16245 interpret a prefix argument.
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
16257 @node Basic Arithmetic, Integer Truncation, Arithmetic, Arithmetic
16258 @section Basic Arithmetic
16260 @noindent
16261 @kindex +
16262 @pindex calc-plus
16263 @ignore
16264 @mindex @null
16265 @end ignore
16266 @tindex +
16267 The @kbd{+} (@code{calc-plus}) command adds two numbers.  The numbers may
16268 be any of the standard Calc data types.  The resulting sum is pushed back
16269 onto the stack.
16271 If both arguments of @kbd{+} are vectors or matrices (of matching dimensions),
16272 the result is a vector or matrix sum.  If one argument is a vector and the
16273 other a scalar (i.e., a non-vector), the scalar is added to each of the
16274 elements of the vector to form a new vector.  If the scalar is not a
16275 number, the operation is left in symbolic form:  Suppose you added @samp{x}
16276 to the vector @samp{[1,2]}.  You may want the result @samp{[1+x,2+x]}, or
16277 you may plan to substitute a 2-vector for @samp{x} in the future.  Since
16278 the Calculator can't tell which interpretation you want, it makes the
16279 safest assumption.  @xref{Reducing and Mapping}, for a way to add @samp{x}
16280 to every element of a vector.
16282 If either argument of @kbd{+} is a complex number, the result will in general
16283 be complex.  If one argument is in rectangular form and the other polar,
16284 the current Polar mode determines the form of the result.  If Symbolic
16285 mode is enabled, the sum may be left as a formula if the necessary
16286 conversions for polar addition are non-trivial.
16288 If both arguments of @kbd{+} are HMS forms, the forms are added according to
16289 the usual conventions of hours-minutes-seconds notation.  If one argument
16290 is an HMS form and the other is a number, that number is converted from
16291 degrees or radians (depending on the current Angular mode) to HMS format
16292 and then the two HMS forms are added.
16294 If one argument of @kbd{+} is a date form, the other can be either a
16295 real number, which advances the date by a certain number of days, or
16296 an HMS form, which advances the date by a certain amount of time.
16297 Subtracting two date forms yields the number of days between them.
16298 Adding two date forms is meaningless, but Calc interprets it as the
16299 subtraction of one date form and the negative of the other.  (The
16300 negative of a date form can be understood by remembering that dates
16301 are stored as the number of days before or after Jan 1, 1 AD.)
16303 If both arguments of @kbd{+} are error forms, the result is an error form
16304 with an appropriately computed standard deviation.  If one argument is an
16305 error form and the other is a number, the number is taken to have zero error.
16306 Error forms may have symbolic formulas as their mean and/or error parts;
16307 adding these will produce a symbolic error form result.  However, adding an
16308 error form to a plain symbolic formula (as in @samp{(a +/- b) + c}) will not
16309 work, for the same reasons just mentioned for vectors.  Instead you must
16310 write @samp{(a +/- b) + (c +/- 0)}.
16312 If both arguments of @kbd{+} are modulo forms with equal values of @expr{M},
16313 or if one argument is a modulo form and the other a plain number, the
16314 result is a modulo form which represents the sum, modulo @expr{M}, of
16315 the two values.
16317 If both arguments of @kbd{+} are intervals, the result is an interval
16318 which describes all possible sums of the possible input values.  If
16319 one argument is a plain number, it is treated as the interval
16320 @w{@samp{[x ..@: x]}}.
16322 If one argument of @kbd{+} is an infinity and the other is not, the
16323 result is that same infinity.  If both arguments are infinite and in
16324 the same direction, the result is the same infinity, but if they are
16325 infinite in different directions the result is @code{nan}.
16327 @kindex -
16328 @pindex calc-minus
16329 @ignore
16330 @mindex @null
16331 @end ignore
16332 @tindex -
16333 The @kbd{-} (@code{calc-minus}) command subtracts two values.  The top
16334 number on the stack is subtracted from the one behind it, so that the
16335 computation @kbd{5 @key{RET} 2 -} produces 3, not @mathit{-3}.  All options
16336 available for @kbd{+} are available for @kbd{-} as well.
16338 @kindex *
16339 @pindex calc-times
16340 @ignore
16341 @mindex @null
16342 @end ignore
16343 @tindex *
16344 The @kbd{*} (@code{calc-times}) command multiplies two numbers.  If one
16345 argument is a vector and the other a scalar, the scalar is multiplied by
16346 the elements of the vector to produce a new vector.  If both arguments
16347 are vectors, the interpretation depends on the dimensions of the
16348 vectors:  If both arguments are matrices, a matrix multiplication is
16349 done.  If one argument is a matrix and the other a plain vector, the
16350 vector is interpreted as a row vector or column vector, whichever is
16351 dimensionally correct.  If both arguments are plain vectors, the result
16352 is a single scalar number which is the dot product of the two vectors.
16354 If one argument of @kbd{*} is an HMS form and the other a number, the
16355 HMS form is multiplied by that amount.  It is an error to multiply two
16356 HMS forms together, or to attempt any multiplication involving date
16357 forms.  Error forms, modulo forms, and intervals can be multiplied;
16358 see the comments for addition of those forms.  When two error forms
16359 or intervals are multiplied they are considered to be statistically
16360 independent; thus, @samp{[-2 ..@: 3] * [-2 ..@: 3]} is @samp{[-6 ..@: 9]},
16361 whereas @w{@samp{[-2 ..@: 3] ^ 2}} is @samp{[0 ..@: 9]}.
16363 @kindex /
16364 @pindex calc-divide
16365 @ignore
16366 @mindex @null
16367 @end ignore
16368 @tindex /
16369 The @kbd{/} (@code{calc-divide}) command divides two numbers.  When
16370 dividing a scalar @expr{B} by a square matrix @expr{A}, the computation
16371 performed is @expr{B} times the inverse of @expr{A}.  This also occurs
16372 if @expr{B} is itself a vector or matrix, in which case the effect is
16373 to solve the set of linear equations represented by @expr{B}.  If @expr{B}
16374 is a matrix with the same number of rows as @expr{A}, or a plain vector
16375 (which is interpreted here as a column vector), then the equation
16376 @expr{A X = B} is solved for the vector or matrix @expr{X}.  Otherwise,
16377 if @expr{B} is a non-square matrix with the same number of @emph{columns}
16378 as @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},
16380 make it into a one-row matrix with @kbd{C-u 1 v p} first.  To force a
16381 left-handed solution with a square matrix @expr{B}, transpose @expr{A} and
16382 @expr{B} before dividing, then transpose the result.
16384 HMS forms can be divided by real numbers or by other HMS forms.  Error
16385 forms can be divided in any combination of ways.  Modulo forms where both
16386 values and the modulo are integers can be divided to get an integer modulo
16387 form result.  Intervals can be divided; dividing by an interval that
16388 encompasses zero or has zero as a limit will result in an infinite
16389 interval.
16391 @kindex ^
16392 @pindex calc-power
16393 @ignore
16394 @mindex @null
16395 @end ignore
16396 @tindex ^
16397 The @kbd{^} (@code{calc-power}) command raises a number to a power.  If
16398 the power is an integer, an exact result is computed using repeated
16399 multiplications.  For non-integer powers, Calc uses Newton's method or
16400 logarithms and exponentials.  Square matrices can be raised to integer
16401 powers.  If either argument is an error (or interval or modulo) form,
16402 the result is also an error (or interval or modulo) form.
16404 @kindex I ^
16405 @tindex nroot
16406 If you press the @kbd{I} (inverse) key first, the @kbd{I ^} command
16407 computes 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 ^}.)
16410 @kindex \
16411 @pindex calc-idiv
16412 @tindex idiv
16413 @ignore
16414 @mindex @null
16415 @end ignore
16416 @tindex \
16417 The @kbd{\} (@code{calc-idiv}) command divides two numbers on the stack
16418 to produce an integer result.  It is equivalent to dividing with
16419 @key{/}, then rounding down with @kbd{F} (@code{calc-floor}), only a bit
16420 more convenient and efficient.  Also, since it is an all-integer
16421 operation when the arguments are integers, it avoids problems that
16422 @kbd{/ F} would have with floating-point roundoff.
16424 @kindex %
16425 @pindex calc-mod
16426 @ignore
16427 @mindex @null
16428 @end ignore
16429 @tindex %
16430 The @kbd{%} (@code{calc-mod}) command performs a ``modulo'' (or ``remainder'')
16431 operation.  Mathematically, @samp{a%b = a - (a\b)*b}, and is defined
16432 for all real numbers @expr{a} and @expr{b} (except @expr{b=0}).  For
16433 positive @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.
16435 If @expr{a} is a modulo form, its modulo is changed to @expr{b}, which
16436 must be positive real number.
16438 @kindex :
16439 @pindex calc-fdiv
16440 @tindex fdiv
16441 The @kbd{:} (@code{calc-fdiv}) [@code{fdiv}] command
16442 divides the two integers on the top of the stack to produce a fractional
16443 result.  This is a convenient shorthand for enabling Fraction mode (with
16444 @kbd{m f}) temporarily and using @samp{/}.  Note that during numeric entry
16445 the @kbd{:} key is interpreted as a fraction separator, so to divide 8 by 6
16446 you would have to type @kbd{8 @key{RET} 6 @key{RET} :}.  (Of course, in
16447 this case, it would be much easier simply to enter the fraction directly
16448 as @kbd{8:6 @key{RET}}!)
16450 @kindex n
16451 @pindex calc-change-sign
16452 The @kbd{n} (@code{calc-change-sign}) command negates the number on the top
16453 of the stack.  It works on numbers, vectors and matrices, HMS forms, date
16454 forms, error forms, intervals, and modulo forms.
16456 @kindex A
16457 @pindex calc-abs
16458 @tindex abs
16459 The @kbd{A} (@code{calc-abs}) [@code{abs}] command computes the absolute
16460 value of a number.  The result of @code{abs} is always a nonnegative
16461 real number:  With a complex argument, it computes the complex magnitude.
16462 With a vector or matrix argument, it computes the Frobenius norm, i.e.,
16463 the square root of the sum of the squares of the absolute values of the
16464 elements.  The absolute value of an error form is defined by replacing
16465 the mean part with its absolute value and leaving the error part the same.
16466 The absolute value of a modulo form is undefined.  The absolute value of
16467 an interval is defined in the obvious way.
16469 @kindex f A
16470 @pindex calc-abssqr
16471 @tindex abssqr
16472 The @kbd{f A} (@code{calc-abssqr}) [@code{abssqr}] command computes the
16473 absolute value squared of a number, vector or matrix, or error form.
16475 @kindex f s
16476 @pindex calc-sign
16477 @tindex sign
16478 The @kbd{f s} (@code{calc-sign}) [@code{sign}] command returns 1 if its
16479 argument is positive, @mathit{-1} if its argument is negative, or 0 if its
16480 argument is zero.  In algebraic form, you can also write @samp{sign(a,x)}
16481 which evaluates to @samp{x * sign(a)}, i.e., either @samp{x}, @samp{-x}, or
16482 zero depending on the sign of @samp{a}.
16484 @kindex &
16485 @pindex calc-inv
16486 @tindex inv
16487 @cindex Reciprocal
16488 The @kbd{&} (@code{calc-inv}) [@code{inv}] command computes the
16489 reciprocal of a number, i.e., @expr{1 / x}.  Operating on a square
16490 matrix, it computes the inverse of that matrix.
16492 @kindex Q
16493 @pindex calc-sqrt
16494 @tindex sqrt
16495 The @kbd{Q} (@code{calc-sqrt}) [@code{sqrt}] command computes the square
16496 root of a number.  For a negative real argument, the result will be a
16497 complex number whose form is determined by the current Polar mode.
16499 @kindex f h
16500 @pindex calc-hypot
16501 @tindex hypot
16502 The @kbd{f h} (@code{calc-hypot}) [@code{hypot}] command computes the square
16503 root of the sum of the squares of two numbers.  That is, @samp{hypot(a,b)}
16504 is the length of the hypotenuse of a right triangle with sides @expr{a}
16505 and @expr{b}.  If the arguments are complex numbers, their squared
16506 magnitudes are used.
16508 @kindex f Q
16509 @pindex calc-isqrt
16510 @tindex isqrt
16511 The @kbd{f Q} (@code{calc-isqrt}) [@code{isqrt}] command computes the
16512 integer square root of an integer.  This is the true square root of the
16513 number, rounded down to an integer.  For example, @samp{isqrt(10)}
16514 produces 3.  Note that, like @kbd{\} [@code{idiv}], this uses exact
16515 integer arithmetic throughout to avoid roundoff problems.  If the input
16516 is a floating-point number or other non-integer value, this is exactly
16517 the same as @samp{floor(sqrt(x))}.
16519 @kindex f n
16520 @kindex f x
16521 @pindex calc-min
16522 @tindex min
16523 @pindex calc-max
16524 @tindex max
16525 The @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,
16527 respectively.  These commands also work on HMS forms, date forms,
16528 intervals, and infinities.  (In algebraic expressions, these functions
16529 take any number of arguments and return the maximum or minimum among
16530 all the arguments.)
16532 @kindex f M
16533 @kindex f X
16534 @pindex calc-mant-part
16535 @tindex mant
16536 @pindex calc-xpon-part
16537 @tindex xpon
16538 The @kbd{f M} (@code{calc-mant-part}) [@code{mant}] function extracts
16539 the ``mantissa'' part @expr{m} of its floating-point argument; @kbd{f X}
16540 (@code{calc-xpon-part}) [@code{xpon}] extracts the ``exponent'' part
16541 @expr{e}.  The original number is equal to 
16542 @texline @math{m \times 10^e},
16543 @infoline @expr{m * 10^e},
16544 where @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
16546 and fractions, @code{mant} returns the number unchanged and @code{xpon}
16547 returns zero.  The @kbd{v u} (@code{calc-unpack}) command can also be
16548 used to ``unpack'' a floating-point number; this produces an integer
16549 mantissa and exponent, with the constraint that the mantissa is not
16550 a multiple of ten (again except for the @expr{m=e=0} case).
16552 @kindex f S
16553 @pindex calc-scale-float
16554 @tindex scf
16555 The @kbd{f S} (@code{calc-scale-float}) [@code{scf}] function scales a number
16556 by a given power of ten.  Thus, @samp{scf(mant(x), xpon(x)) = x} for any
16557 real @samp{x}.  The second argument must be an integer, but the first
16558 may actually be any numeric value.  For example, @samp{scf(5,-2) = 0.05}
16559 or @samp{1:20} depending on the current Fraction mode.
16561 @kindex f [
16562 @kindex f ]
16563 @pindex calc-decrement
16564 @pindex calc-increment
16565 @tindex decr
16566 @tindex incr
16567 The @kbd{f [} (@code{calc-decrement}) [@code{decr}] and @kbd{f ]}
16568 (@code{calc-increment}) [@code{incr}] functions decrease or increase
16569 a number by one unit.  For integers, the effect is obvious.  For
16570 floating-point numbers, the change is by one unit in the last place.
16571 For example, incrementing @samp{12.3456} when the current precision
16572 is 6 digits yields @samp{12.3457}.  If the current precision had been
16573 8 digits, the result would have been @samp{12.345601}.  Incrementing
16574 @samp{0.0} produces 
16575 @texline @math{10^{-p}},
16576 @infoline @expr{10^-p}, 
16577 where @expr{p} is the current
16578 precision.  These operations are defined only on integers and floats.
16579 With numeric prefix arguments, they change the number by @expr{n} units.
16581 Note that incrementing followed by decrementing, or vice-versa, will
16582 almost but not quite always cancel out.  Suppose the precision is
16583 6 digits and the number @samp{9.99999} is on the stack.  Incrementing
16584 will produce @samp{10.0000}; decrementing will produce @samp{9.9999}.
16585 One digit has been dropped.  This is an unavoidable consequence of the
16586 way floating-point numbers work.
16588 Incrementing a date/time form adjusts it by a certain number of seconds.
16589 Incrementing a pure date form adjusts it by a certain number of days.
16591 @node Integer Truncation, Complex Number Functions, Basic Arithmetic, Arithmetic
16592 @section Integer Truncation
16594 @noindent
16595 There are four commands for truncating a real number to an integer,
16596 differing mainly in their treatment of negative numbers.  All of these
16597 commands have the property that if the argument is an integer, the result
16598 is the same integer.  An integer-valued floating-point argument is converted
16599 to integer form.
16601 If you press @kbd{H} (@code{calc-hyperbolic}) first, the result will be
16602 expressed as an integer-valued floating-point number.
16604 @cindex Integer part of a number
16605 @kindex F
16606 @pindex calc-floor
16607 @tindex floor
16608 @tindex ffloor
16609 @ignore
16610 @mindex @null
16611 @end ignore
16612 @kindex H F
16613 The @kbd{F} (@code{calc-floor}) [@code{floor} or @code{ffloor}] command
16614 truncates a real number to the next lower integer, i.e., toward minus
16615 infinity.  Thus @kbd{3.6 F} produces 3, but @kbd{_3.6 F} produces
16616 @mathit{-4}.
16618 @kindex I F
16619 @pindex calc-ceiling
16620 @tindex ceil
16621 @tindex fceil
16622 @ignore
16623 @mindex @null
16624 @end ignore
16625 @kindex H I F
16626 The @kbd{I F} (@code{calc-ceiling}) [@code{ceil} or @code{fceil}]
16627 command truncates toward positive infinity.  Thus @kbd{3.6 I F} produces
16628 4, and @kbd{_3.6 I F} produces @mathit{-3}.
16630 @kindex R
16631 @pindex calc-round
16632 @tindex round
16633 @tindex fround
16634 @ignore
16635 @mindex @null
16636 @end ignore
16637 @kindex H R
16638 The @kbd{R} (@code{calc-round}) [@code{round} or @code{fround}] command
16639 rounds to the nearest integer.  When the fractional part is .5 exactly,
16640 this command rounds away from zero.  (All other rounding in the
16641 Calculator uses this convention as well.)  Thus @kbd{3.5 R} produces 4
16642 but @kbd{3.4 R} produces 3; @kbd{_3.5 R} produces @mathit{-4}.
16644 @kindex I R
16645 @pindex calc-trunc
16646 @tindex trunc
16647 @tindex ftrunc
16648 @ignore
16649 @mindex @null
16650 @end ignore
16651 @kindex H I R
16652 The @kbd{I R} (@code{calc-trunc}) [@code{trunc} or @code{ftrunc}]
16653 command truncates toward zero.  In other words, it ``chops off''
16654 everything after the decimal point.  Thus @kbd{3.6 I R} produces 3 and
16655 @kbd{_3.6 I R} produces @mathit{-3}.
16657 These functions may not be applied meaningfully to error forms, but they
16658 do work for intervals.  As a convenience, applying @code{floor} to a
16659 modulo form floors the value part of the form.  Applied to a vector,
16660 these functions operate on all elements of the vector one by one.
16661 Applied to a date form, they operate on the internal numerical
16662 representation of dates, converting a date/time form into a pure date.
16664 @ignore
16665 @starindex
16666 @end ignore
16667 @tindex rounde
16668 @ignore
16669 @starindex
16670 @end ignore
16671 @tindex roundu
16672 @ignore
16673 @starindex
16674 @end ignore
16675 @tindex frounde
16676 @ignore
16677 @starindex
16678 @end ignore
16679 @tindex froundu
16680 There are two more rounding functions which can only be entered in
16681 algebraic notation.  The @code{roundu} function is like @code{round}
16682 except that it rounds up, toward plus infinity, when the fractional
16683 part is .5.  This distinction matters only for negative arguments.
16684 Also, @code{rounde} rounds to an even number in the case of a tie,
16685 rounding 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.
16687 The advantage of round-to-even is that the net error due to rounding
16688 after a long calculation tends to cancel out to zero.  An important
16689 subtle point here is that the number being fed to @code{rounde} will
16690 already have been rounded to the current precision before @code{rounde}
16691 begins.  For example, @samp{rounde(2.500001)} with a current precision
16692 of 6 will incorrectly, or at least surprisingly, yield 2 because the
16693 argument will first have been rounded down to @expr{2.5} (which
16694 @code{rounde} sees as an exact tie between 2 and 3).
16696 Each of these functions, when written in algebraic formulas, allows
16697 a second argument which specifies the number of digits after the
16698 decimal point to keep.  For example, @samp{round(123.4567, 2)} will
16699 produce the answer 123.46, and @samp{round(123.4567, -1)} will
16700 produce 120 (i.e., the cutoff is one digit to the @emph{left} of
16701 the decimal point).  A second argument of zero is equivalent to
16702 no second argument at all.
16704 @cindex Fractional part of a number
16705 To compute the fractional part of a number (i.e., the amount which, when
16706 added to `@tfn{floor(}@var{n}@tfn{)}', will produce @var{n}) just take @var{n}
16707 modulo 1 using the @code{%} command.
16709 Note also the @kbd{\} (integer quotient), @kbd{f I} (integer logarithm),
16710 and @kbd{f Q} (integer square root) commands, which are analogous to
16711 @kbd{/}, @kbd{B}, and @kbd{Q}, respectively, except that they take integer
16712 arguments and return the result rounded down to an integer.
16714 @node Complex Number Functions, Conversions, Integer Truncation, Arithmetic
16715 @section Complex Number Functions
16717 @noindent
16718 @kindex J
16719 @pindex calc-conj
16720 @tindex conj
16721 The @kbd{J} (@code{calc-conj}) [@code{conj}] command computes the
16722 complex conjugate of a number.  For complex number @expr{a+bi}, the
16723 complex conjugate is @expr{a-bi}.  If the argument is a real number,
16724 this command leaves it the same.  If the argument is a vector or matrix,
16725 this command replaces each element by its complex conjugate.
16727 @kindex G
16728 @pindex calc-argument
16729 @tindex arg
16730 The @kbd{G} (@code{calc-argument}) [@code{arg}] command computes the
16731 ``argument'' or polar angle of a complex number.  For a number in polar
16732 notation, this is simply the second component of the pair
16733 @texline `@tfn{(}@var{r}@tfn{;}@math{\theta}@tfn{)}'.
16734 @infoline `@tfn{(}@var{r}@tfn{;}@var{theta}@tfn{)}'.
16735 The result is expressed according to the current angular mode and will
16736 be in the range @mathit{-180} degrees (exclusive) to @mathit{+180} degrees
16737 (inclusive), or the equivalent range in radians.
16739 @pindex calc-imaginary
16740 The @code{calc-imaginary} command multiplies the number on the
16741 top of the stack by the imaginary number @expr{i = (0,1)}.  This
16742 command is not normally bound to a key in Calc, but it is available
16743 on the @key{IMAG} button in Keypad mode.
16745 @kindex f r
16746 @pindex calc-re
16747 @tindex re
16748 The @kbd{f r} (@code{calc-re}) [@code{re}] command replaces a complex number
16749 by its real part.  This command has no effect on real numbers.  (As an
16750 added convenience, @code{re} applied to a modulo form extracts
16751 the value part.)
16753 @kindex f i
16754 @pindex calc-im
16755 @tindex im
16756 The @kbd{f i} (@code{calc-im}) [@code{im}] command replaces a complex number
16757 by its imaginary part; real numbers are converted to zero.  With a vector
16758 or matrix argument, these functions operate element-wise.
16760 @ignore
16761 @mindex v p
16762 @end ignore
16763 @kindex v p (complex)
16764 @pindex calc-pack
16765 The @kbd{v p} (@code{calc-pack}) command can pack the top two numbers on
16766 the stack into a composite object such as a complex number.  With
16767 a prefix argument of @mathit{-1}, it produces a rectangular complex number;
16768 with an argument of @mathit{-2}, it produces a polar complex number.
16769 (Also, @pxref{Building Vectors}.)
16771 @ignore
16772 @mindex v u
16773 @end ignore
16774 @kindex v u (complex)
16775 @pindex calc-unpack
16776 The @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
16778 into its separate components.
16780 @node Conversions, Date Arithmetic, Complex Number Functions, Arithmetic
16781 @section Conversions
16783 @noindent
16784 The commands described in this section convert numbers from one form
16785 to another; they are two-key sequences beginning with the letter @kbd{c}.
16787 @kindex c f
16788 @pindex calc-float
16789 @tindex pfloat
16790 The @kbd{c f} (@code{calc-float}) [@code{pfloat}] command converts the
16791 number on the top of the stack to floating-point form.  For example,
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
16794 object such as a complex number or vector, each of the components is
16795 converted to floating-point.  If the value is a formula, all numbers
16796 in the formula are converted to floating-point.  Note that depending
16797 on the current floating-point precision, conversion to floating-point
16798 format may lose information.
16800 As a special exception, integers which appear as powers or subscripts
16801 are not floated by @kbd{c f}.  If you really want to float a power,
16802 you can use a @kbd{j s} command to select the power followed by @kbd{c f}.
16803 Because @kbd{c f} cannot examine the formula outside of the selection,
16804 it does not notice that the thing being floated is a power.
16805 @xref{Selecting Subformulas}.
16807 The normal @kbd{c f} command is ``pervasive'' in the sense that it
16808 applies to all numbers throughout the formula.  The @code{pfloat}
16809 algebraic function never stays around in a formula; @samp{pfloat(a + 1)}
16810 changes to @samp{a + 1.0} as soon as it is evaluated.
16812 @kindex H c f
16813 @tindex float
16814 With the Hyperbolic flag, @kbd{H c f} [@code{float}] operates
16815 only on the number or vector of numbers at the top level of its
16816 argument.  Thus, @samp{float(1)} is 1.0, but @samp{float(a + 1)}
16817 is left unevaluated because its argument is not a number.
16819 You should use @kbd{H c f} if you wish to guarantee that the final
16820 value, once all the variables have been assigned, is a float; you
16821 would use @kbd{c f} if you wish to do the conversion on the numbers
16822 that appear right now.
16824 @kindex c F
16825 @pindex calc-fraction
16826 @tindex pfrac
16827 The @kbd{c F} (@code{calc-fraction}) [@code{pfrac}] command converts a
16828 floating-point number into a fractional approximation.  By default, it
16829 produces a fraction whose decimal representation is the same as the
16830 input number, to within the current precision.  You can also give a
16831 numeric prefix argument to specify a tolerance, either directly, or,
16832 if the prefix argument is zero, by using the number on top of the stack
16833 as the tolerance.  If the tolerance is a positive integer, the fraction
16834 is correct to within that many significant figures.  If the tolerance is
16835 a non-positive integer, it specifies how many digits fewer than the current
16836 precision to use.  If the tolerance is a floating-point number, the
16837 fraction is correct to within that absolute amount.
16839 @kindex H c F
16840 @tindex frac
16841 The @code{pfrac} function is pervasive, like @code{pfloat}.
16842 There is also a non-pervasive version, @kbd{H c F} [@code{frac}],
16843 which is analogous to @kbd{H c f} discussed above.
16845 @kindex c d
16846 @pindex calc-to-degrees
16847 @tindex deg
16848 The @kbd{c d} (@code{calc-to-degrees}) [@code{deg}] command converts a
16849 number into degrees form.  The value on the top of the stack may be an
16850 HMS form (interpreted as degrees-minutes-seconds), or a real number which
16851 will be interpreted in radians regardless of the current angular mode.
16853 @kindex c r
16854 @pindex calc-to-radians
16855 @tindex rad
16856 The @kbd{c r} (@code{calc-to-radians}) [@code{rad}] command converts an
16857 HMS form or angle in degrees into an angle in radians.
16859 @kindex c h
16860 @pindex calc-to-hms
16861 @tindex hms
16862 The @kbd{c h} (@code{calc-to-hms}) [@code{hms}] command converts a real
16863 number, interpreted according to the current angular mode, to an HMS
16864 form describing the same angle.  In algebraic notation, the @code{hms}
16865 function also accepts three arguments: @samp{hms(@var{h}, @var{m}, @var{s})}.
16866 (The three-argument version is independent of the current angular mode.)
16868 @pindex calc-from-hms
16869 The @code{calc-from-hms} command converts the HMS form on the top of the
16870 stack into a real number according to the current angular mode.
16872 @kindex c p
16873 @kindex I c p
16874 @pindex calc-polar
16875 @tindex polar
16876 @tindex rect
16877 The @kbd{c p} (@code{calc-polar}) command converts the complex number on
16878 the top of the stack from polar to rectangular form, or from rectangular
16879 to polar form, whichever is appropriate.  Real numbers are left the same.
16880 This command is equivalent to the @code{rect} or @code{polar}
16881 functions in algebraic formulas, depending on the direction of
16882 conversion.  (It uses @code{polar}, except that if the argument is
16883 already a polar complex number, it uses @code{rect} instead.  The
16884 @kbd{I c p} command always uses @code{rect}.)
16886 @kindex c c
16887 @pindex calc-clean
16888 @tindex pclean
16889 The @kbd{c c} (@code{calc-clean}) [@code{pclean}] command ``cleans'' the
16890 number on the top of the stack.  Floating point numbers are re-rounded
16891 according to the current precision.  Polar numbers whose angular
16892 components have strayed from the @mathit{-180} to @mathit{+180} degree range
16893 are normalized.  (Note that results will be undesirable if the current
16894 angular mode is different from the one under which the number was
16895 produced!)  Integers and fractions are generally unaffected by this
16896 operation.  Vectors and formulas are cleaned by cleaning each component
16897 number (i.e., pervasively).
16899 If the simplification mode is set below the default level, it is raised
16900 to the default level for the purposes of this command.  Thus, @kbd{c c}
16901 applies the default simplifications even if their automatic application
16902 is disabled.  @xref{Simplification Modes}.
16904 @cindex Roundoff errors, correcting
16905 A numeric prefix argument to @kbd{c c} sets the floating-point precision
16906 to that value for the duration of the command.  A positive prefix (of at
16907 least 3) sets the precision to the specified value; a negative or zero
16908 prefix decreases the precision by the specified amount.
16910 @kindex c 0-9
16911 @pindex calc-clean-num
16912 The keystroke sequences @kbd{c 0} through @kbd{c 9} are equivalent
16913 to @kbd{c c} with the corresponding negative prefix argument.  If roundoff
16914 errors have changed 2.0 into 1.999999, typing @kbd{c 1} to clip off one
16915 decimal place often conveniently does the trick.
16917 The @kbd{c c} command with a numeric prefix argument, and the @kbd{c 0}
16918 through @kbd{c 9} commands, also ``clip'' very small floating-point
16919 numbers to zero.  If the exponent is less than or equal to the negative
16920 of the specified precision, the number is changed to 0.0.  For example,
16921 if 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]}.
16923 Numbers this small generally arise from roundoff noise.
16925 If the numbers you are using really are legitimately this small,
16926 you 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
16928 does not clip small numbers.)
16930 One more property of @kbd{c 0} through @kbd{c 9}, and of @kbd{c c} with
16931 a prefix argument, is that integer-valued floats are converted to
16932 plain integers, so that @kbd{c 1} on @samp{[1., 1.5, 2., 2.5, 3.]}
16933 produces @samp{[1, 1.5, 2, 2.5, 3]}.  This is not done for huge
16934 numbers (@samp{1e100} is technically an integer-valued float, but
16935 you wouldn't want it automatically converted to a 100-digit integer).
16937 @kindex H c 0-9
16938 @kindex H c c
16939 @tindex clean
16940 With the Hyperbolic flag, @kbd{H c c} and @kbd{H c 0} through @kbd{H c 9}
16941 operate non-pervasively [@code{clean}].
16943 @node Date Arithmetic, Financial Functions, Conversions, Arithmetic
16944 @section Date Arithmetic
16946 @noindent
16947 @cindex Date arithmetic, additional functions
16948 The commands described in this section perform various conversions
16949 and calculations involving date forms (@pxref{Date Forms}).  They
16950 use the @kbd{t} (for time/date) prefix key followed by shifted
16951 letters.
16953 The simplest date arithmetic is done using the regular @kbd{+} and @kbd{-}
16954 commands.  In particular, adding a number to a date form advances the
16955 date form by a certain number of days; adding an HMS form to a date
16956 form advances the date by a certain amount of time; and subtracting two
16957 date forms produces a difference measured in days.  The commands
16958 described here provide additional, more specialized operations on dates.
16960 Many of these commands accept a numeric prefix argument; if you give
16961 plain @kbd{C-u} as the prefix, these commands will instead take the
16962 additional argument from the top of the stack.
16964 @menu
16965 * Date Conversions::
16966 * Date Functions::
16967 * Time Zones::
16968 * Business Days::
16969 @end menu
16971 @node Date Conversions, Date Functions, Date Arithmetic, Date Arithmetic
16972 @subsection Date Conversions
16974 @noindent
16975 @kindex t D
16976 @pindex calc-date
16977 @tindex date
16978 The @kbd{t D} (@code{calc-date}) [@code{date}] command converts a
16979 date form into a number, measured in days since Jan 1, 1 AD.  The
16980 result will be an integer if @var{date} is a pure date form, or a
16981 fraction or float if @var{date} is a date/time form.  Or, if its
16982 argument is a number, it converts this number into a date form.
16984 With 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
16986 of the following ways:
16988 The @samp{date(@var{year}, @var{month}, @var{day})} function
16989 builds a pure date form out of the specified year, month, and
16990 day, which must all be integers.  @var{Year} is a year number,
16991 such as 1991 (@emph{not} the same as 91!).  @var{Month} must be
16992 an integer in the range 1 to 12; @var{day} must be in the range
16993 1 to 31.  If the specified month has fewer than 31 days and
16994 @var{day} is too large, the equivalent day in the following
16995 month will be used.
16997 The @samp{date(@var{month}, @var{day})} function builds a
16998 pure date form using the current year, as determined by the
16999 real-time clock.
17001 The @samp{date(@var{year}, @var{month}, @var{day}, @var{hms})}
17002 function builds a date/time form using an @var{hms} form.
17004 The @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)}.
17009 The last two arguments default to zero if omitted.
17011 @kindex t J
17012 @pindex calc-julian
17013 @tindex julian
17014 @cindex Julian day counts, conversions
17015 The @kbd{t J} (@code{calc-julian}) [@code{julian}] command converts
17016 a date form into a Julian day count, which is the number of days
17017 since noon on Jan 1, 4713 BC.  A pure date is converted to an integer
17018 Julian count representing noon of that day.  A date/time form is
17019 converted to an exact floating-point Julian count, adjusted to
17020 interpret the date form in the current time zone but the Julian
17021 day count in Greenwich Mean Time.  A numeric prefix argument allows
17022 you to specify the time zone; @pxref{Time Zones}.  Use a prefix of
17023 zero to suppress the time zone adjustment.  Note that pure date forms
17024 are never time-zone adjusted.
17026 This command can also do the opposite conversion, from a Julian day
17027 count (either an integer day, or a floating-point day and time in
17028 the GMT zone), into a pure date form or a date/time form in the
17029 current or specified time zone.
17031 @kindex t U
17032 @pindex calc-unix-time
17033 @tindex unixtime
17034 @cindex Unix time format, conversions
17035 The @kbd{t U} (@code{calc-unix-time}) [@code{unixtime}] command
17036 converts a date form into a Unix time value, which is the number of
17037 seconds since midnight on Jan 1, 1970, or vice-versa.  The numeric result
17038 will be an integer if the current precision is 12 or less; for higher
17039 precisions, the result may be a float with (@var{precision}@minus{}12)
17040 digits after the decimal.  Just as for @kbd{t J}, the numeric time
17041 is interpreted in the GMT time zone and the date form is interpreted
17042 in the current or specified zone.  Some systems use Unix-like
17043 numbering but with the local time zone; give a prefix of zero to
17044 suppress the adjustment if so.
17046 @kindex t C
17047 @pindex calc-convert-time-zones
17048 @tindex tzconv
17049 @cindex Time Zones, converting between
17050 The @kbd{t C} (@code{calc-convert-time-zones}) [@code{tzconv}]
17051 command converts a date form from one time zone to another.  You
17052 are prompted for each time zone name in turn; you can answer with
17053 any suitable Calc time zone expression (@pxref{Time Zones}).
17054 If you answer either prompt with a blank line, the local time
17055 zone is used for that prompt.  You can also answer the first
17056 prompt with @kbd{$} to take the two time zone names from the
17057 stack (and the date to be converted from the third stack level).
17059 @node Date Functions, Business Days, Date Conversions, Date Arithmetic
17060 @subsection Date Functions
17062 @noindent
17063 @kindex t N
17064 @pindex calc-now
17065 @tindex now
17066 The @kbd{t N} (@code{calc-now}) [@code{now}] command pushes the
17067 current date and time on the stack as a date form.  The time is
17068 reported in terms of the specified time zone; with no numeric prefix
17069 argument, @kbd{t N} reports for the current time zone.
17071 @kindex t P
17072 @pindex calc-date-part
17073 The @kbd{t P} (@code{calc-date-part}) command extracts one part
17074 of a date form.  The prefix argument specifies the part; with no
17075 argument, this command prompts for a part code from 1 to 9.
17076 The various part codes are described in the following paragraphs.
17078 @tindex year
17079 The @kbd{M-1 t P} [@code{year}] function extracts the year number
17080 from a date form as an integer, e.g., 1991.  This and the
17081 following functions will also accept a real number for an
17082 argument, which is interpreted as a standard Calc day number.
17083 Note that this function will never return zero, since the year
17084 1 BC immediately precedes the year 1 AD.
17086 @tindex month
17087 The @kbd{M-2 t P} [@code{month}] function extracts the month number
17088 from a date form as an integer in the range 1 to 12.
17090 @tindex day
17091 The @kbd{M-3 t P} [@code{day}] function extracts the day number
17092 from a date form as an integer in the range 1 to 31.
17094 @tindex hour
17095 The @kbd{M-4 t P} [@code{hour}] function extracts the hour from
17096 a date form as an integer in the range 0 (midnight) to 23.  Note
17097 that 24-hour time is always used.  This returns zero for a pure
17098 date form.  This function (and the following two) also accept
17099 HMS forms as input.
17101 @tindex minute
17102 The @kbd{M-5 t P} [@code{minute}] function extracts the minute
17103 from a date form as an integer in the range 0 to 59.
17105 @tindex second
17106 The @kbd{M-6 t P} [@code{second}] function extracts the second
17107 from a date form.  If the current precision is 12 or less,
17108 the result is an integer in the range 0 to 59.  For higher
17109 precisions, the result may instead be a floating-point number.
17111 @tindex weekday
17112 The @kbd{M-7 t P} [@code{weekday}] function extracts the weekday
17113 number from a date form as an integer in the range 0 (Sunday)
17114 to 6 (Saturday).
17116 @tindex yearday
17117 The @kbd{M-8 t P} [@code{yearday}] function extracts the day-of-year
17118 number from a date form as an integer in the range 1 (January 1)
17119 to 366 (December 31 of a leap year).
17121 @tindex time
17122 The @kbd{M-9 t P} [@code{time}] function extracts the time portion
17123 of a date form as an HMS form.  This returns @samp{0@@ 0' 0"}
17124 for a pure date form.
17126 @kindex t M
17127 @pindex calc-new-month
17128 @tindex newmonth
17129 The @kbd{t M} (@code{calc-new-month}) [@code{newmonth}] command
17130 computes a new date form that represents the first day of the month
17131 specified by the input date.  The result is always a pure date
17132 form; only the year and month numbers of the input are retained.
17133 With 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}
17135 is 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.)
17138 @kindex t Y
17139 @pindex calc-new-year
17140 @tindex newyear
17141 The @kbd{t Y} (@code{calc-new-year}) [@code{newyear}] command
17142 computes a new pure date form that represents the first day of
17143 the year specified by the input.  The month, day, and time
17144 of 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
17147 years).  A prefix argument of 0 computes the last day of the
17148 year (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.
17151 @kindex t W
17152 @pindex calc-new-week
17153 @tindex newweek
17154 The @kbd{t W} (@code{calc-new-week}) [@code{newweek}] command
17155 computes a new pure date form that represents the Sunday on or before
17156 the input date.  With a numeric prefix argument, it can be made to
17157 use any day of the week as the starting day; the argument must be in
17158 the range from 0 (Sunday) to 6 (Saturday).  This function always
17159 subtracts between 0 and 6 days from the input date.
17161 Here's an example use of @code{newweek}:  Find the date of the next
17162 Wednesday after a given date.  Using @kbd{M-3 t W} or @samp{newweek(d, 3)}
17163 will give you the @emph{preceding} Wednesday, so @samp{newweek(d+7, 3)}
17164 will give you the following Wednesday.  A further look at the definition
17165 of @code{newweek} shows that if the input date is itself a Wednesday,
17166 this formula will return the Wednesday one week in the future.  An
17167 exercise for the reader is to modify this formula to yield the same day
17168 if the input is already a Wednesday.  Another interesting exercise is
17169 to preserve the time-of-day portion of the input (@code{newweek} resets
17170 the time to midnight; hint:@: how can @code{newweek} be defined in terms
17171 of the @code{weekday} function?).
17173 @ignore
17174 @starindex
17175 @end ignore
17176 @tindex pwday
17177 The @samp{pwday(@var{date})} function (not on any key) computes the
17178 day-of-month number of the Sunday on or before @var{date}.  With
17179 two arguments, @samp{pwday(@var{date}, @var{day})} computes the day
17180 number of the Sunday on or before day number @var{day} of the month
17181 specified by @var{date}.  The @var{day} must be in the range from
17182 7 to 31; if the day number is greater than the actual number of days
17183 in 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.
17186 With a third @var{weekday} argument, @code{pwday} can be made to look
17187 for any day of the week instead of Sunday.
17189 @kindex t I
17190 @pindex calc-inc-month
17191 @tindex incmonth
17192 The @kbd{t I} (@code{calc-inc-month}) [@code{incmonth}] command
17193 increases a date form by one month, or by an arbitrary number of
17194 months specified by a numeric prefix argument.  The time portion,
17195 if any, of the date form stays the same.  The day also stays the
17196 same, except that if the new month has fewer days the day
17197 number may be reduced to lie in the valid range.  For example,
17198 @samp{incmonth(<Jan 31, 1991>)} produces @samp{<Feb 28, 1991>}.
17199 Because of this, @kbd{t I t I} and @kbd{M-2 t I} do not always give
17200 the same results (@samp{<Mar 28, 1991>} versus @samp{<Mar 31, 1991>}
17201 in this case).
17203 @ignore
17204 @starindex
17205 @end ignore
17206 @tindex incyear
17207 The @samp{incyear(@var{date}, @var{step})} function increases
17208 a date form by the specified number of years, which may be
17209 any positive or negative integer.  Note that @samp{incyear(d, n)}
17210 is equivalent to @w{@samp{incmonth(d, 12*n)}}, but these do not have
17211 simple equivalents in terms of day arithmetic because
17212 months and years have varying lengths.  If the @var{step}
17213 argument is omitted, 1 year is assumed.  There is no keyboard
17214 command for this function; use @kbd{C-u 12 t I} instead.
17216 There is no @code{newday} function at all because @kbd{F} [@code{floor}]
17217 serves this purpose.  Similarly, instead of @code{incday} and
17218 @code{incweek} simply use @expr{d + n} or @expr{d + 7 n}.
17220 @xref{Basic Arithmetic}, for the @kbd{f ]} [@code{incr}] command
17221 which can adjust a date/time form by a certain number of seconds.
17223 @node Business Days, Time Zones, Date Functions, Date Arithmetic
17224 @subsection Business Days
17226 @noindent
17227 Often time is measured in ``business days'' or ``working days,''
17228 where weekends and holidays are skipped.  Calc's normal date
17229 arithmetic functions use calendar days, so that subtracting two
17230 consecutive Mondays will yield a difference of 7 days.  By contrast,
17231 subtracting two consecutive Mondays would yield 5 business days
17232 (assuming two-day weekends and the absence of holidays).
17234 @kindex t +
17235 @kindex t -
17236 @tindex badd
17237 @tindex bsub
17238 @pindex calc-business-days-plus
17239 @pindex calc-business-days-minus
17240 The @kbd{t +} (@code{calc-business-days-plus}) [@code{badd}]
17241 and @kbd{t -} (@code{calc-business-days-minus}) [@code{bsub}]
17242 commands perform arithmetic using business days.  For @kbd{t +},
17243 one argument must be a date form and the other must be a real
17244 number (positive or negative).  If the number is not an integer,
17245 then a certain amount of time is added as well as a number of
17246 days; for example, adding 0.5 business days to a time in Friday
17247 evening will produce a time in Monday morning.  It is also
17248 possible to add an HMS form; adding @samp{12@@ 0' 0"} also adds
17249 half a business day.  For @kbd{t -}, the arguments are either a
17250 date form and a number or HMS form, or two date forms, in which
17251 case the result is the number of business days between the two
17252 dates.
17254 @cindex @code{Holidays} variable
17255 @vindex Holidays
17256 By default, Calc considers any day that is not a Saturday or
17257 Sunday to be a business day.  You can define any number of
17258 additional holidays by editing the variable @code{Holidays}.
17259 (There is an @w{@kbd{s H}} convenience command for editing this
17260 variable.)  Initially, @code{Holidays} contains the vector
17261 @samp{[sat, sun]}.  Entries in the @code{Holidays} vector may
17262 be any of the following kinds of objects:
17264 @itemize @bullet
17265 @item
17266 Date forms (pure dates, not date/time forms).  These specify
17267 particular days which are to be treated as holidays.
17269 @item
17270 Intervals of date forms.  These specify a range of days, all of
17271 which are holidays (e.g., Christmas week).  @xref{Interval Forms}.
17273 @item
17274 Nested vectors of date forms.  Each date form in the vector is
17275 considered to be a holiday.
17277 @item
17278 Any Calc formula which evaluates to one of the above three things.
17279 If the formula involves the variable @expr{y}, it stands for a
17280 yearly repeating holiday; @expr{y} will take on various year
17281 numbers like 1992.  For example, @samp{date(y, 12, 25)} specifies
17282 Christmas day, and @samp{newweek(date(y, 11, 7), 4) + 21} specifies
17283 Thanksgiving (which is held on the fourth Thursday of November).
17284 If the formula involves the variable @expr{m}, that variable
17285 takes on month numbers from 1 to 12:  @samp{date(y, m, 15)} is
17286 a holiday that takes place on the 15th of every month.
17288 @item
17289 A weekday name, such as @code{sat} or @code{sun}.  This is really
17290 a variable whose name is a three-letter, lower-case day name.
17292 @item
17293 An interval of year numbers (integers).  This specifies the span of
17294 years over which this holiday list is to be considered valid.  Any
17295 business-day arithmetic that goes outside this range will result
17296 in an error message.  Use this if you are including an explicit
17297 list of holidays, rather than a formula to generate them, and you
17298 want to make sure you don't accidentally go beyond the last point
17299 where the holidays you entered are complete.  If there is no
17300 limiting interval in the @code{Holidays} vector, the default
17301 @samp{[1 .. 2737]} is used.  (This is the absolute range of years
17302 for which Calc's business-day algorithms will operate.)
17304 @item
17305 An interval of HMS forms.  This specifies the span of hours that
17306 are to be considered one business day.  For example, if this
17307 range is @samp{[9@@ 0' 0" .. 17@@ 0' 0"]} (i.e., 9am to 5pm), then
17308 the business day is only eight hours long, so that @kbd{1.5 t +}
17309 on @samp{<4:00pm Fri Dec 13, 1991>} will add one business day and
17310 four business hours to produce @samp{<12:00pm Tue Dec 17, 1991>}.
17311 Likewise, @kbd{t -} will now express differences in time as
17312 fractions of an eight-hour day.  Times before 9am will be treated
17313 as 9am by business date arithmetic, and times at or after 5pm will
17314 be treated as 4:59:59pm.  If there is no HMS interval in @code{Holidays},
17315 the 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
17317 treated as inclusive on the low end and exclusive on the high end,
17318 so that the work day goes from 9am up to, but not including, 5pm.)
17319 @end itemize
17321 If the @code{Holidays} vector is empty, then @kbd{t +} and
17322 @kbd{t -} will act just like @kbd{+} and @kbd{-} because there will
17323 then be no difference between business days and calendar days.
17325 Calc expands the intervals and formulas you give into a complete
17326 list of holidays for internal use.  This is done mainly to make
17327 sure it can detect multiple holidays.  (For example,
17328 @samp{<Jan 1, 1989>} is both New Year's Day and a Sunday, but
17329 Calc's algorithms take care to count it only once when figuring
17330 the number of holidays between two dates.)
17332 Since the complete list of holidays for all the years from 1 to
17333 2737 would be huge, Calc actually computes only the part of the
17334 list between the smallest and largest years that have been involved
17335 in business-day calculations so far.  Normally, you won't have to
17336 worry about this.  Keep in mind, however, that if you do one
17337 calculation for 1992, and another for 1792, even if both involve
17338 only a small range of years, Calc will still work out all the
17339 holidays that fall in that 200-year span.
17341 If you add a (positive) number of days to a date form that falls on a
17342 weekend or holiday, the date form is treated as if it were the most
17343 recent business day.  (Thus adding one business day to a Friday,
17344 Saturday, or Sunday will all yield the following Monday.)  If you
17345 subtract a number of days from a weekend or holiday, the date is
17346 effectively on the following business day.  (So subtracting one business
17347 day from Saturday, Sunday, or Monday yields the preceding Friday.)  The
17348 difference between two dates one or both of which fall on holidays
17349 equals the number of actual business days between them.  These
17350 conventions are consistent in the sense that, if you add @var{n}
17351 business days to any date, the difference between the result and the
17352 original date will come out to @var{n} business days.  (It can't be
17353 completely consistent though; a subtraction followed by an addition
17354 might come out a bit differently, since @kbd{t +} is incapable of
17355 producing a date that falls on a weekend or holiday.)
17357 @ignore
17358 @starindex
17359 @end ignore
17360 @tindex holiday
17361 There is a @code{holiday} function, not on any keys, that takes
17362 any date form and returns 1 if that date falls on a weekend or
17363 holiday, as defined in @code{Holidays}, or 0 if the date is a
17364 business day.
17366 @node Time Zones, , Business Days, Date Arithmetic
17367 @subsection Time Zones
17369 @noindent
17370 @cindex Time zones
17371 @cindex Daylight savings time
17372 Time zones and daylight savings time are a complicated business.
17373 The conversions to and from Julian and Unix-style dates automatically
17374 compute the correct time zone and daylight savings adjustment to use,
17375 provided they can figure out this information.  This section describes
17376 Calc's time zone adjustment algorithm in detail, in case you want to
17377 do conversions in different time zones or in case Calc's algorithms
17378 can't determine the right correction to use.
17380 Adjustments 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
17382 commands.  In particular, @samp{<may 1 1991> - <apr 1 1991>} evaluates
17383 to exactly 30 days even though there is a daylight-savings
17384 transition in between.  This is also true for Julian pure dates:
17385 @samp{julian(<may 1 1991>) - julian(<apr 1 1991>)}.  But Julian
17386 and Unix date/times will adjust for daylight savings time:
17387 @samp{julian(<12am may 1 1991>) - julian(<12am apr 1 1991>)}
17388 evaluates to @samp{29.95834} (that's 29 days and 23 hours)
17389 because one hour was lost when daylight savings commenced on
17390 April 7, 1991.
17392 In brief, the idiom @samp{julian(@var{date1}) - julian(@var{date2})}
17393 computes the actual number of 24-hour periods between two dates, whereas
17394 @samp{@var{date1} - @var{date2}} computes the number of calendar
17395 days between two dates without taking daylight savings into account.
17397 @pindex calc-time-zone
17398 @ignore
17399 @starindex
17400 @end ignore
17401 @tindex tzone
17402 The @code{calc-time-zone} [@code{tzone}] command converts the time
17403 zone specified by its numeric prefix argument into a number of
17404 seconds difference from Greenwich mean time (GMT).  If the argument
17405 is a number, the result is simply that value multiplied by 3600.
17406 Typical arguments for North America are 5 (Eastern) or 8 (Pacific).  If
17407 Daylight Savings time is in effect, one hour should be subtracted from
17408 the normal difference.
17410 If you give a prefix of plain @kbd{C-u}, @code{calc-time-zone} (like other
17411 date arithmetic commands that include a time zone argument) takes the
17412 zone argument from the top of the stack.  (In the case of @kbd{t J}
17413 and @kbd{t U}, the normal argument is then taken from the second-to-top
17414 stack position.)  This allows you to give a non-integer time zone
17415 adjustment.  The time-zone argument can also be an HMS form, or
17416 it can be a variable which is a time zone name in upper- or lower-case.
17417 For example @samp{tzone(PST) = tzone(8)} and @samp{tzone(pdt) = tzone(7)}
17418 (for Pacific standard and daylight savings times, respectively).
17420 North American and European time zone names are defined as follows;
17421 note that for each time zone there is one name for standard time,
17422 another for daylight savings time, and a third for ``generalized'' time
17423 in which the daylight savings adjustment is computed from context.
17425 @smallexample
17426 @group
17427 YST  PST  MST  CST  EST  AST    NST    GMT   WET     MET    MEZ
17428  9    8    7    6    5    4     3.5     0     -1      -2     -2
17430 YDT  PDT  MDT  CDT  EDT  ADT    NDT    BST  WETDST  METDST  MESZ
17431  8    7    6    5    4    3     2.5     -1    -2      -3     -3
17433 YGT  PGT  MGT  CGT  EGT  AGT    NGT    BGT   WEGT    MEGT   MEGZ
17434 9/8  8/7  7/6  6/5  5/4  4/3  3.5/2.5  0/-1 -1/-2   -2/-3  -2/-3
17435 @end group
17436 @end smallexample
17438 @vindex math-tzone-names
17439 To define time zone names that do not appear in the above table,
17440 you must modify the Lisp variable @code{math-tzone-names}.  This
17441 is a list of lists describing the different time zone names; its
17442 structure is best explained by an example.  The three entries for
17443 Pacific Time look like this:
17445 @smallexample
17446 @group
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.
17450 @end group
17451 @end smallexample
17453 @cindex @code{TimeZone} variable
17454 @vindex TimeZone
17455 With no arguments, @code{calc-time-zone} or @samp{tzone()} obtains an
17456 argument from the Calc variable @code{TimeZone} if a value has been
17457 stored for that variable.  If not, Calc runs the Unix @samp{date}
17458 command and looks for one of the above time zone names in the output;
17459 if this does not succeed, @samp{tzone()} leaves itself unevaluated.
17460 The time zone name in the @samp{date} output may be followed by a signed
17461 adjustment, e.g., @samp{GMT+5} or @samp{GMT+0500} which specifies a
17462 number of hours and minutes to be added to the base time zone.
17463 Calc stores the time zone it finds into @code{TimeZone} to speed
17464 later calls to @samp{tzone()}.
17466 The special time zone name @code{local} is equivalent to no argument,
17467 i.e., it uses the local time zone as obtained from the @code{date}
17468 command.
17470 If the time zone name found is one of the standard or daylight
17471 savings zone names from the above table, and Calc's internal
17472 daylight savings algorithm says that time and zone are consistent
17473 (e.g., @code{PDT} accompanies a date that Calc's algorithm would also
17474 consider to be daylight savings, or @code{PST} accompanies a date
17475 that Calc would consider to be standard time), then Calc substitutes
17476 the corresponding generalized time zone (like @code{PGT}).
17478 If your system does not have a suitable @samp{date} command, you
17479 may wish to put a @samp{(setq var-TimeZone ...)} in your Emacs
17480 initialization file to set the time zone.  (Since you are interacting
17481 with the variable @code{TimeZone} directly from Emacs Lisp, the
17482 @code{var-} prefix needs to be present.)  The easiest way to do
17483 this is to edit the @code{TimeZone} variable using Calc's @kbd{s T}
17484 command, then use the @kbd{s p} (@code{calc-permanent-variable})
17485 command to save the value of @code{TimeZone} permanently.
17487 The @kbd{t J} and @code{t U} commands with no numeric prefix
17488 arguments do the same thing as @samp{tzone()}.  If the current
17489 time zone is a generalized time zone, e.g., @code{EGT}, Calc
17490 examines the date being converted to tell whether to use standard
17491 or daylight savings time.  But if the current time zone is explicit,
17492 e.g., @code{EST} or @code{EDT}, then that adjustment is used exactly
17493 and Calc's daylight savings algorithm is not consulted.
17495 Some places don't follow the usual rules for daylight savings time.
17496 The state of Arizona, for example, does not observe daylight savings
17497 time.  If you run Calc during the winter season in Arizona, the
17498 Unix @code{date} command will report @code{MST} time zone, which
17499 Calc will change to @code{MGT}.  If you then convert a time that
17500 lies in the summer months, Calc will apply an incorrect daylight
17501 savings time adjustment.  To avoid this, set your @code{TimeZone}
17502 variable explicitly to @code{MST} to force the use of standard,
17503 non-daylight-savings time.
17505 @vindex math-daylight-savings-hook
17506 @findex math-std-daylight-savings
17507 By default Calc always considers daylight savings time to begin at
17508 2 a.m.@: on the first Sunday of April, and to end at 2 a.m.@: on the
17509 last Sunday of October.  This is the rule that has been in effect
17510 in North America since 1987.  If you are in a country that uses
17511 different rules for computing daylight savings time, you have two
17512 choices:  Write your own daylight savings hook, or control time
17513 zones explicitly by setting the @code{TimeZone} variable and/or
17514 always giving a time-zone argument for the conversion functions.
17516 The Lisp variable @code{math-daylight-savings-hook} holds the
17517 name of a function that is used to compute the daylight savings
17518 adjustment for a given date.  The default is
17519 @code{math-std-daylight-savings}, which computes an adjustment
17520 (either 0 or @mathit{-1}) using the North American rules given above.
17522 The daylight savings hook function is called with four arguments:
17523 The date, as a floating-point number in standard Calc format;
17524 a six-element list of the date decomposed into year, month, day,
17525 hour, minute, and second, respectively; a string which contains
17526 the generalized time zone name in upper-case, e.g., @code{"WEGT"};
17527 and a special adjustment to be applied to the hour value when
17528 converting into a generalized time zone (see below).
17530 @findex math-prev-weekday-in-month
17531 The Lisp function @code{math-prev-weekday-in-month} is useful for
17532 daylight savings computations.  This is an internal version of
17533 the user-level @code{pwday} function described in the previous
17534 section. It takes four arguments:  The floating-point date value,
17535 the corresponding six-element date list, the day-of-month number,
17536 and the weekday number (0-6).
17538 The default daylight savings hook ignores the time zone name, but a
17539 more sophisticated hook could use different algorithms for different
17540 time zones.  It would also be possible to use different algorithms
17541 depending on the year number, but the default hook always uses the
17542 algorithm for 1987 and later.  Here is a listing of the default
17543 daylight savings hook:
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))
17563 @end smallexample
17565 @noindent
17566 The @code{bump} parameter is equal to zero when Calc is converting
17567 from a date form in a generalized time zone into a GMT date value.
17568 It is @mathit{-1} when Calc is converting in the other direction.  The
17569 adjustments shown above ensure that the conversion behaves correctly
17570 and reasonably around the 2 a.m.@: transition in each direction.
17572 There is a ``missing'' hour between 2 a.m.@: and 3 a.m.@: at the
17573 beginning of daylight savings time; converting a date/time form that
17574 falls in this hour results in a time value for the following hour,
17575 from 3 a.m.@: to 4 a.m.  At the end of daylight savings time, the
17576 hour from 1 a.m.@: to 2 a.m.@: repeats itself; converting a date/time
17577 form that falls in this hour results in a time value for the first
17578 manifestation of that time (@emph{not} the one that occurs one hour later).
17580 If @code{math-daylight-savings-hook} is @code{nil}, then the
17581 daylight savings adjustment is always taken to be zero.
17583 In algebraic formulas, @samp{tzone(@var{zone}, @var{date})}
17584 computes the time zone adjustment for a given zone name at a
17585 given date.  The @var{date} is ignored unless @var{zone} is a
17586 generalized time zone.  If @var{date} is a date form, the
17587 daylight savings computation is applied to it as it appears.
17588 If @var{date} is a numeric date value, it is adjusted for the
17589 daylight-savings version of @var{zone} before being given to
17590 the daylight savings hook.  This odd-sounding rule ensures
17591 that the daylight-savings computation is always done in
17592 local time, not in the GMT time that a numeric @var{date}
17593 is typically represented in.
17595 @ignore
17596 @starindex
17597 @end ignore
17598 @tindex dsadj
17599 The @samp{dsadj(@var{date}, @var{zone})} function computes the
17600 daylight savings adjustment that is appropriate for @var{date} in
17601 time zone @var{zone}.  If @var{zone} is explicitly in or not in
17602 daylight savings time (e.g., @code{PDT} or @code{PST}) the
17603 @var{date} is ignored.  If @var{zone} is a generalized time zone,
17604 the algorithms described above are used.  If @var{zone} is omitted,
17605 the computation is done for the current time zone.
17607 @xref{Reporting Bugs}, for the address of Calc's author, if you
17608 should wish to contribute your improved versions of
17609 @code{math-tzone-names} and @code{math-daylight-savings-hook}
17610 to the Calc distribution.
17612 @node Financial Functions, Binary Functions, Date Arithmetic, Arithmetic
17613 @section Financial Functions
17615 @noindent
17616 Calc's financial or business functions use the @kbd{b} prefix
17617 key followed by a shifted letter.  (The @kbd{b} prefix followed by
17618 a lower-case letter is used for operations on binary numbers.)
17620 Note that the rate and the number of intervals given to these
17621 functions must be on the same time scale, e.g., both months or
17622 both years.  Mixing an annual interest rate with a time expressed
17623 in months will give you very wrong answers!
17625 It is wise to compute these functions to a higher precision than
17626 you really need, just to make sure your answer is correct to the
17627 last penny; also, you may wish to check the definitions at the end
17628 of this section to make sure the functions have the meaning you expect.
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
17639 @node Percentages, Future Value, Financial Functions, Financial Functions
17640 @subsection Percentages
17642 @kindex M-%
17643 @pindex calc-percent
17644 @tindex %
17645 @tindex percent
17646 The @kbd{M-%} (@code{calc-percent}) command takes a percentage value,
17647 say 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{%}.)
17651 Actually, @kbd{M-%} creates a formula of the form @samp{5.4%}.
17652 You can enter @samp{5.4%} yourself during algebraic entry.  The
17653 @samp{%} operator simply means, ``the preceding value divided by
17654 100.''  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.)
17660 The formula @samp{5.4%} would normally evaluate immediately to
17661 0.054, but the @kbd{M-%} command suppresses evaluation as it puts
17662 the formula onto the stack.  However, the next Calc command that
17663 uses the formula @samp{5.4%} will evaluate it as its first step.
17664 The net effect is that you get to look at @samp{5.4%} on the stack,
17665 but Calc commands see it as @samp{0.054}, which is what they expect.
17667 In particular, @samp{5.4%} and @samp{0.054} are suitable values
17668 for the @var{rate} arguments of the various financial functions,
17669 but the number @samp{5.4} is probably @emph{not} suitable---it
17670 represents a rate of 540 percent!
17672 The key sequence @kbd{M-% *} effectively means ``percent-of.''
17673 For example, @kbd{68 @key{RET} 25 M-% *} computes 17, which is 25% of
17674 68 (and also 68% of 25, which comes out to the same thing).
17676 @kindex c %
17677 @pindex calc-convert-percent
17678 The @kbd{c %} (@code{calc-convert-percent}) command converts the
17679 value on the top of the stack from numeric to percentage form.
17680 For 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
17682 differently.  (Contrast this with @kbd{M-%}, which would convert
17683 this number to @samp{0.08%}.)  The @kbd{=} key is a convenient way
17684 to convert a formula like @samp{8%} back to numeric form, 0.08.
17686 To compute what percentage one quantity is of another quantity,
17687 use @kbd{/ c %}.  For example, @w{@kbd{17 @key{RET} 68 / c %}} displays
17688 @samp{25%}.
17690 @kindex b %
17691 @pindex calc-percent-change
17692 @tindex relch
17693 The @kbd{b %} (@code{calc-percent-change}) [@code{relch}] command
17694 calculates the percentage change from one number to another.
17695 For example, @kbd{40 @key{RET} 50 b %} produces the answer @samp{25%},
17696 since 50 is 25% larger than 40.  A negative result represents a
17697 decrease:  @kbd{50 @key{RET} 40 b %} produces @samp{-20%}, since 40 is
17698 20% smaller than 50.  (The answers are different in magnitude
17699 because, in the first case, we're increasing by 25% of 40, but
17700 in the second case, we're decreasing by 20% of 50.)  The effect
17701 of @kbd{40 @key{RET} 50 b %} is to compute @expr{(50-40)/40}, converting
17702 the answer to percentage form as if by @kbd{c %}.
17704 @node Future Value, Present Value, Percentages, Financial Functions
17705 @subsection Future Value
17707 @noindent
17708 @kindex b F
17709 @pindex calc-fin-fv
17710 @tindex fv
17711 The @kbd{b F} (@code{calc-fin-fv}) [@code{fv}] command computes
17712 the future value of an investment.  It takes three arguments
17713 from the stack:  @samp{fv(@var{rate}, @var{n}, @var{payment})}.
17714 If you give payments of @var{payment} every year for @var{n}
17715 years, and the money you have paid earns interest at @var{rate} per
17716 year, then this function tells you what your investment would be
17717 worth at the end of the period.  (The actual interval doesn't
17718 have to be years, as long as @var{n} and @var{rate} are expressed
17719 in terms of the same intervals.)  This function assumes payments
17720 occur at the @emph{end} of each interval.
17722 @kindex I b F
17723 @tindex fvb
17724 The @kbd{I b F} [@code{fvb}] command does the same computation,
17725 but assuming your payments are at the beginning of each interval.
17726 Suppose you plan to deposit $1000 per year in a savings account
17727 earning 5.4% interest, starting right now.  How much will be
17728 in the account after five years?  @code{fvb(5.4%, 5, 1000) = 5870.73}.
17729 Thus you will have earned $870 worth of interest over the years.
17730 Using the stack, this calculation would have been
17731 @kbd{5.4 M-% 5 @key{RET} 1000 I b F}.  Note that the rate is expressed
17732 as a number between 0 and 1, @emph{not} as a percentage.
17734 @kindex H b F
17735 @tindex fvl
17736 The @kbd{H b F} [@code{fvl}] command computes the future value
17737 of an initial lump sum investment.  Suppose you could deposit
17738 those five thousand dollars in the bank right now; how much would
17739 they be worth in five years?  @code{fvl(5.4%, 5, 5000) = 6503.89}.
17741 The algebraic functions @code{fv} and @code{fvb} accept an optional
17742 fourth argument, which is used as an initial lump sum in the sense
17743 of @code{fvl}.  In other words, @code{fv(@var{rate}, @var{n},
17744 @var{payment}, @var{initial}) = fv(@var{rate}, @var{n}, @var{payment})
17745 + fvl(@var{rate}, @var{n}, @var{initial})}.
17747 To illustrate the relationships between these functions, we could
17748 do the @code{fvb} calculation ``by hand'' using @code{fvl}.  The
17749 final balance will be the sum of the contributions of our five
17750 deposits at various times.  The first deposit earns interest for
17751 five years:  @code{fvl(5.4%, 5, 1000) = 1300.78}.  The second
17752 deposit only earns interest for four years:  @code{fvl(5.4%, 4, 1000) =
17753 1234.13}.  And so on down to the last deposit, which earns one
17754 year's interest:  @code{fvl(5.4%, 1, 1000) = 1054.00}.  The sum of
17755 these five values is, sure enough, $5870.73, just as was computed
17756 by @code{fvb} directly.
17758 What does @code{fv(5.4%, 5, 1000) = 5569.96} mean?  The payments
17759 are now at the ends of the periods.  The end of one year is the same
17760 as the beginning of the next, so what this really means is that we've
17761 lost the payment at year zero (which contributed $1300.78), but we're
17762 now counting the payment at year five (which, since it didn't have
17763 a chance to earn interest, counts as $1000).  Indeed, @expr{5569.96 =
17764 5870.73 - 1300.78 + 1000} (give or take a bit of roundoff error).
17766 @node Present Value, Related Financial Functions, Future Value, Financial Functions
17767 @subsection Present Value
17769 @noindent
17770 @kindex b P
17771 @pindex calc-fin-pv
17772 @tindex pv
17773 The @kbd{b P} (@code{calc-fin-pv}) [@code{pv}] command computes
17774 the present value of an investment.  Like @code{fv}, it takes
17775 three arguments:  @code{pv(@var{rate}, @var{n}, @var{payment})}.
17776 It computes the present value of a series of regular payments.
17777 Suppose you have the chance to make an investment that will
17778 pay $2000 per year over the next four years; as you receive
17779 these payments you can put them in the bank at 9% interest.
17780 You want to know whether it is better to make the investment, or
17781 to keep the money in the bank where it earns 9% interest right
17782 from the start.  The calculation @code{pv(9%, 4, 2000)} gives the
17783 result 6479.44.  If your initial investment must be less than this,
17784 say, $6000, then the investment is worthwhile.  But if you had to
17785 put up $7000, then it would be better just to leave it in the bank.
17787 Here is the interpretation of the result of @code{pv}:  You are
17788 trying to compare the return from the investment you are
17789 considering, which is @code{fv(9%, 4, 2000) = 9146.26}, with
17790 the 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
17792 you would have to put up in advance.  The @code{pv} function
17793 finds the break-even point, @expr{x = 6479.44}, at which
17794 @code{fvl(9%, 4, 6479.44)} is also equal to 9146.26.  This is
17795 the largest amount you should be willing to invest.
17797 @kindex I b P
17798 @tindex pvb
17799 The @kbd{I b P} [@code{pvb}] command solves the same problem,
17800 but with payments occurring at the beginning of each interval.
17801 It has the same relationship to @code{fvb} as @code{pv} has
17802 to @code{fv}.  For example @code{pvb(9%, 4, 2000) = 7062.59},
17803 a larger number than @code{pv} produced because we get to start
17804 earning interest on the return from our investment sooner.
17806 @kindex H b P
17807 @tindex pvl
17808 The @kbd{H b P} [@code{pvl}] command computes the present value of
17809 an investment that will pay off in one lump sum at the end of the
17810 period.  For example, if we get our $8000 all at the end of the
17811 four years, @code{pvl(9%, 4, 8000) = 5667.40}.  This is much
17812 less than @code{pv} reported, because we don't earn any interest
17813 on the return from this investment.  Note that @code{pvl} and
17814 @code{fvl} are simple inverses:  @code{fvl(9%, 4, 5667.40) = 8000}.
17816 You can give an optional fourth lump-sum argument to @code{pv}
17817 and @code{pvb}; this is handled in exactly the same way as the
17818 fourth argument for @code{fv} and @code{fvb}.
17820 @kindex b N
17821 @pindex calc-fin-npv
17822 @tindex npv
17823 The @kbd{b N} (@code{calc-fin-npv}) [@code{npv}] command computes
17824 the net present value of a series of irregular investments.
17825 The first argument is the interest rate.  The second argument is
17826 a vector which represents the expected return from the investment
17827 at the end of each interval.  For example, if the rate represents
17828 a yearly interest rate, then the vector elements are the return
17829 from the first year, second year, and so on.
17831 Thus, @code{npv(9%, [2000,2000,2000,2000]) = pv(9%, 4, 2000) = 6479.44}.
17832 Obviously this function is more interesting when the payments are
17833 not all the same!
17835 The @code{npv} function can actually have two or more arguments.
17836 Multiple arguments are interpreted in the same way as for the
17837 vector statistical functions like @code{vsum}.
17838 @xref{Single-Variable Statistics}.  Basically, if there are several
17839 payment arguments, each either a vector or a plain number, all these
17840 values are collected left-to-right into the complete list of payments.
17841 A numeric prefix argument on the @kbd{b N} command says how many
17842 payment values or vectors to take from the stack.
17844 @kindex I b N
17845 @tindex npvb
17846 The @kbd{I b N} [@code{npvb}] command computes the net present
17847 value where payments occur at the beginning of each interval
17848 rather than at the end.
17850 @node Related Financial Functions, Depreciation Functions, Present Value, Financial Functions
17851 @subsection Related Financial Functions
17853 @noindent
17854 The functions in this section are basically inverses of the
17855 present value functions with respect to the various arguments.
17857 @kindex b M
17858 @pindex calc-fin-pmt
17859 @tindex pmt
17860 The @kbd{b M} (@code{calc-fin-pmt}) [@code{pmt}] command computes
17861 the amount of periodic payment necessary to amortize a loan.
17862 Thus @code{pmt(@var{rate}, @var{n}, @var{amount})} equals the
17863 value of @var{payment} such that @code{pv(@var{rate}, @var{n},
17864 @var{payment}) = @var{amount}}.
17866 @kindex I b M
17867 @tindex pmtb
17868 The @kbd{I b M} [@code{pmtb}] command does the same computation
17869 but using @code{pvb} instead of @code{pv}.  Like @code{pv} and
17870 @code{pvb}, these functions can also take a fourth argument which
17871 represents an initial lump-sum investment.
17873 @kindex H b M
17874 The @kbd{H b M} key just invokes the @code{fvl} function, which is
17875 the inverse of @code{pvl}.  There is no explicit @code{pmtl} function.
17877 @kindex b #
17878 @pindex calc-fin-nper
17879 @tindex nper
17880 The @kbd{b #} (@code{calc-fin-nper}) [@code{nper}] command computes
17881 the number of regular payments necessary to amortize a loan.
17882 Thus @code{nper(@var{rate}, @var{payment}, @var{amount})} equals
17883 the value of @var{n} such that @code{pv(@var{rate}, @var{n},
17884 @var{payment}) = @var{amount}}.  If @var{payment} is too small
17885 ever to amortize a loan for @var{amount} at interest rate @var{rate},
17886 the @code{nper} function is left in symbolic form.
17888 @kindex I b #
17889 @tindex nperb
17890 The @kbd{I b #} [@code{nperb}] command does the same computation
17891 but using @code{pvb} instead of @code{pv}.  You can give a fourth
17892 lump-sum argument to these functions, but the computation will be
17893 rather slow in the four-argument case.
17895 @kindex H b #
17896 @tindex nperl
17897 The @kbd{H b #} [@code{nperl}] command does the same computation
17898 using @code{pvl}.  By exchanging @var{payment} and @var{amount} you
17899 can also get the solution for @code{fvl}.  For example,
17900 @code{nperl(8%, 2000, 1000) = 9.006}, so if you place $1000 in a
17901 bank account earning 8%, it will take nine years to grow to $2000.
17903 @kindex b T
17904 @pindex calc-fin-rate
17905 @tindex rate
17906 The @kbd{b T} (@code{calc-fin-rate}) [@code{rate}] command computes
17907 the 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}) =
17910 @var{amount}}.  The result is expressed as a formula like @samp{6.3%}.
17912 @kindex I b T
17913 @kindex H b T
17914 @tindex rateb
17915 @tindex ratel
17916 The @kbd{I b T} [@code{rateb}] and @kbd{H b T} [@code{ratel}]
17917 commands solve the analogous equations with @code{pvb} or @code{pvl}
17918 in place of @code{pv}.  Also, @code{rate} and @code{rateb} can
17919 accept an optional fourth argument just like @code{pv} and @code{pvb}.
17920 To redo the above example from a different perspective,
17921 @code{ratel(9, 2000, 1000) = 8.00597%}, which says you will need an
17922 interest rate of 8% in order to double your account in nine years.
17924 @kindex b I
17925 @pindex calc-fin-irr
17926 @tindex irr
17927 The @kbd{b I} (@code{calc-fin-irr}) [@code{irr}] command is the
17928 analogous function to @code{rate} but for net present value.
17929 Its argument is a vector of payments.  Thus @code{irr(@var{payments})}
17930 computes the @var{rate} such that @code{npv(@var{rate}, @var{payments}) = 0};
17931 this rate is known as the @dfn{internal rate of return}.
17933 @kindex I b I
17934 @tindex irrb
17935 The @kbd{I b I} [@code{irrb}] command computes the internal rate of
17936 return assuming payments occur at the beginning of each period.
17938 @node Depreciation Functions, Definitions of Financial Functions, Related Financial Functions, Financial Functions
17939 @subsection Depreciation Functions
17941 @noindent
17942 The functions in this section calculate @dfn{depreciation}, which is
17943 the amount of value that a possession loses over time.  These functions
17944 are characterized by three parameters:  @var{cost}, the original cost
17945 of the asset; @var{salvage}, the value the asset will have at the end
17946 of its expected ``useful life''; and @var{life}, the number of years
17947 (or other periods) of the expected useful life.
17949 There are several methods for calculating depreciation that differ in
17950 the way they spread the depreciation over the lifetime of the asset.
17952 @kindex b S
17953 @pindex calc-fin-sln
17954 @tindex sln
17955 The @kbd{b S} (@code{calc-fin-sln}) [@code{sln}] command computes the
17956 ``straight-line'' depreciation.  In this method, the asset depreciates
17957 by the same amount every year (or period).  For example,
17958 @samp{sln(12000, 2000, 5)} returns 2000.  The asset costs $12000
17959 initially and will be worth $2000 after five years; it loses $2000
17960 per year.
17962 @kindex b Y
17963 @pindex calc-fin-syd
17964 @tindex syd
17965 The @kbd{b Y} (@code{calc-fin-syd}) [@code{syd}] command computes the
17966 accelerated ``sum-of-years'-digits'' depreciation.  Here the depreciation
17967 is higher during the early years of the asset's life.  Since the
17968 depreciation is different each year, @kbd{b Y} takes a fourth @var{period}
17969 parameter which specifies which year is requested, from 1 to @var{life}.
17970 If @var{period} is outside this range, the @code{syd} function will
17971 return zero.
17973 @kindex b D
17974 @pindex calc-fin-ddb
17975 @tindex ddb
17976 The @kbd{b D} (@code{calc-fin-ddb}) [@code{ddb}] command computes an
17977 accelerated depreciation using the double-declining balance method.
17978 It also takes a fourth @var{period} parameter.
17980 For symmetry, the @code{sln} function will accept a @var{period}
17981 parameter as well, although it will ignore its value except that the
17982 return value will as usual be zero if @var{period} is out of range.
17984 For example, pushing the vector @expr{[1,2,3,4,5]} (perhaps with @kbd{v x 5})
17985 and then mapping @kbd{V M ' [sln(12000,2000,5,$), syd(12000,2000,5,$),
17986 ddb(12000,2000,5,$)] @key{RET}} produces a matrix that allows us to compare
17987 the three depreciation methods:
17989 @example
17990 @group
17991 [ [ 2000, 3333, 4800 ]
17992   [ 2000, 2667, 2880 ]
17993   [ 2000, 2000, 1728 ]
17994   [ 2000, 1333,  592 ]
17995   [ 2000,  667,   0  ] ]
17996 @end group
17997 @end example
17999 @noindent
18000 (Values have been rounded to nearest integers in this figure.)
18001 We see that @code{sln} depreciates by the same amount each year,
18002 @kbd{syd} depreciates more at the beginning and less at the end,
18003 and @kbd{ddb} weights the depreciation even more toward the beginning.
18005 Summing columns with @kbd{V R : +} yields @expr{[10000, 10000, 10000]};
18006 the total depreciation in any method is (by definition) the
18007 difference between the cost and the salvage value.
18009 @node Definitions of Financial Functions, , Depreciation Functions, Financial Functions
18010 @subsection Definitions
18012 @noindent
18013 For your reference, here are the actual formulas used to compute
18014 Calc's financial functions.
18016 Calc will not evaluate a financial function unless the @var{rate} or
18017 @var{n} argument is known.  However, @var{payment} or @var{amount} can
18018 be a variable.  Calc expands these functions according to the
18019 formulas below for symbolic arguments only when you use the @kbd{a "}
18020 (@code{calc-expand-formula}) command, or when taking derivatives or
18021 integrals or solving equations involving the functions.
18023 @ifinfo
18024 These formulas are shown using the conventions of Big display
18025 mode (@kbd{d B}); for example, the formula for @code{fv} written
18026 linearly is @samp{pmt * ((1 + rate)^n) - 1) / rate}.
18028 @example
18029                                         n
18030                               (1 + rate)  - 1
18031 fv(rate, n, pmt) =      pmt * ---------------
18032                                    rate
18034                                          n
18035                               ((1 + rate)  - 1) (1 + rate)
18036 fvb(rate, n, pmt) =     pmt * ----------------------------
18037                                          rate
18039                                         n
18040 fvl(rate, n, pmt) =     pmt * (1 + rate)
18042                                             -n
18043                               1 - (1 + rate)
18044 pv(rate, n, pmt) =      pmt * ----------------
18045                                     rate
18047                                              -n
18048                               (1 - (1 + rate)  ) (1 + rate)
18049 pvb(rate, n, pmt) =     pmt * -----------------------------
18050                                          rate
18052                                         -n
18053 pvl(rate, n, pmt) =     pmt * (1 + rate)
18055                                     -1               -2               -3
18056 npv(rate, [a, b, c]) =  a*(1 + rate)   + b*(1 + rate)   + c*(1 + rate)
18058                                         -1               -2
18059 npvb(rate, [a, b, c]) = a + b*(1 + rate)   + c*(1 + rate)
18061                                              -n
18062                         (amt - x * (1 + rate)  ) * rate
18063 pmt(rate, n, amt, x) =  -------------------------------
18064                                              -n
18065                                1 - (1 + rate)
18067                                              -n
18068                         (amt - x * (1 + rate)  ) * rate
18069 pmtb(rate, n, amt, x) = -------------------------------
18070                                         -n
18071                          (1 - (1 + rate)  ) (1 + rate)
18073                                    amt * rate
18074 nper(rate, pmt, amt) =  - log(1 - ------------, 1 + rate)
18075                                       pmt
18077                                     amt * rate
18078 nperb(rate, pmt, amt) = - log(1 - ---------------, 1 + rate)
18079                                   pmt * (1 + rate)
18081                               amt
18082 nperl(rate, pmt, amt) = - log(---, 1 + rate)
18083                               pmt
18085                            1/n
18086                         pmt
18087 ratel(n, pmt, amt) =    ------ - 1
18088                            1/n
18089                         amt
18091                         cost - salv
18092 sln(cost, salv, life) = -----------
18093                            life
18095                              (cost - salv) * (life - per + 1)
18096 syd(cost, salv, life, per) = --------------------------------
18097                                   life * (life + 1) / 2
18099                              book * 2
18100 ddb(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
18126 @noindent
18127 In @code{pmt} and @code{pmtb}, @expr{x=0} if omitted.
18129 These functions accept any numeric objects, including error forms,
18130 intervals, and even (though not very usefully) complex numbers.  The
18131 above formulas specify exactly the behavior of these functions with
18132 all sorts of inputs.
18134 Note that if the first argument to the @code{log} in @code{nper} is
18135 negative, @code{nper} leaves itself in symbolic form rather than
18136 returning a (financially meaningless) complex number.
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%]}
18141 for an initial guess.  The @code{rateb} function is the same except
18142 that it uses @code{pvb}.  Note that @code{ratel} can be solved
18143 directly; its formula is shown in the above list.
18145 Similarly, @samp{irr(pmts)} solves the equation @samp{npv(rate, pmts) = 0}
18146 for @samp{rate}.
18148 If you give a fourth argument to @code{nper} or @code{nperb}, Calc
18149 will also use @kbd{H a R} to solve the equation using an initial
18150 guess interval of @samp{[0 .. 100]}.
18152 A fourth argument to @code{fv} simply sums the two components
18153 calculated from the above formulas for @code{fv} and @code{fvl}.
18154 The same is true of @code{fvb}, @code{pv}, and @code{pvb}.
18156 The @kbd{ddb} function is computed iteratively; the ``book'' value
18157 starts out equal to @var{cost}, and decreases according to the above
18158 formula for the specified number of periods.  If the book value
18159 would decrease below @var{salvage}, it only decreases to @var{salvage}
18160 and the depreciation is zero for all subsequent periods.  The @code{ddb}
18161 function returns the amount the book value decreased in the specified
18162 period.
18164 @node Binary Functions, , Financial Functions, Arithmetic
18165 @section Binary Number Functions
18167 @noindent
18168 The commands in this chapter all use two-letter sequences beginning with
18169 the @kbd{b} prefix.
18171 @cindex Binary numbers
18172 The ``binary'' operations actually work regardless of the currently
18173 displayed radix, although their results make the most sense in a radix
18174 like 2, 8, or 16 (as obtained by the @kbd{d 2}, @kbd{d 8}, or @w{@kbd{d 6}}
18175 commands, respectively).  You may also wish to enable display of leading
18176 zeros with @kbd{d z}.  @xref{Radix Modes}.
18178 @cindex Word size for binary operations
18179 The Calculator maintains a current @dfn{word size} @expr{w}, an
18180 arbitrary positive or negative integer.  For a positive word size, all
18181 of the binary operations described here operate modulo @expr{2^w}.  In
18182 particular, negative arguments are converted to positive integers modulo
18183 @expr{2^w} by all binary functions.
18185 If the word size is negative, binary operations produce 2's complement
18186 integers from 
18187 @texline @math{-2^{-w-1}}
18188 @infoline @expr{-(2^(-w-1))} 
18189 to 
18190 @texline @math{2^{-w-1}-1}
18191 @infoline @expr{2^(-w-1)-1} 
18192 inclusive.  Either mode accepts inputs in any range; the sign of
18193 @expr{w} affects only the results produced.
18195 @kindex b c
18196 @pindex calc-clip
18197 @tindex clip
18198 The @kbd{b c} (@code{calc-clip})
18199 [@code{clip}] command can be used to clip a number by reducing it modulo
18200 @expr{2^w}.  The commands described in this chapter automatically clip
18201 their results to the current word size.  Note that other operations like
18202 addition do not use the current word size, since integer addition
18203 generally is not ``binary.''  (However, @pxref{Simplification Modes},
18204 @code{calc-bin-simplify-mode}.)  For example, with a word size of 8
18205 bits @kbd{b c} converts a number to the range 0 to 255; with a word
18206 size of @mathit{-8} @kbd{b c} converts to the range @mathit{-128} to 127.
18208 @kindex b w
18209 @pindex calc-word-size
18210 The default word size is 32 bits.  All operations except the shifts and
18211 rotates allow you to specify a different word size for that one
18212 operation by giving a numeric prefix argument:  @kbd{C-u 8 b c} clips the
18213 top of stack to the range 0 to 255 regardless of the current word size.
18214 To set the word size permanently, use @kbd{b w} (@code{calc-word-size}).
18215 This command displays a prompt with the current word size; press @key{RET}
18216 immediately to keep this word size, or type a new word size at the prompt.
18218 When the binary operations are written in symbolic form, they take an
18219 optional 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
18221 will be used, but when @samp{and(a,b,-8)} is evaluated, a word size of
18222 @mathit{-8} will always be used.  A symbolic binary function will be left
18223 in symbolic form unless the all of its argument(s) are integers or
18224 integer-valued floats.
18226 If either or both arguments are modulo forms for which @expr{M} is a
18227 power of two, that power of two is taken as the word size unless a
18228 numeric prefix argument overrides it.  The current word size is never
18229 consulted when modulo-power-of-two forms are involved.
18231 @kindex b a
18232 @pindex calc-and
18233 @tindex and
18234 The @kbd{b a} (@code{calc-and}) [@code{and}] command computes the bitwise
18235 AND of the two numbers on the top of the stack.  In other words, for each
18236 of the @expr{w} binary digits of the two numbers (pairwise), the corresponding
18237 bit of the result is 1 if and only if both input bits are 1:
18238 @samp{and(2#1100, 2#1010) = 2#1000}.
18240 @kindex b o
18241 @pindex calc-or
18242 @tindex or
18243 The @kbd{b o} (@code{calc-or}) [@code{or}] command computes the bitwise
18244 inclusive OR of two numbers.  A bit is 1 if either of the input bits, or
18245 both, are 1:  @samp{or(2#1100, 2#1010) = 2#1110}.
18247 @kindex b x
18248 @pindex calc-xor
18249 @tindex xor
18250 The @kbd{b x} (@code{calc-xor}) [@code{xor}] command computes the bitwise
18251 exclusive OR of two numbers.  A bit is 1 if exactly one of the input bits
18252 is 1:  @samp{xor(2#1100, 2#1010) = 2#0110}.
18254 @kindex b d
18255 @pindex calc-diff
18256 @tindex diff
18257 The @kbd{b d} (@code{calc-diff}) [@code{diff}] command computes the bitwise
18258 difference of two numbers; this is defined by @samp{diff(a,b) = and(a,not(b))},
18259 so that @samp{diff(2#1100, 2#1010) = 2#0100}.
18261 @kindex b n
18262 @pindex calc-not
18263 @tindex not
18264 The @kbd{b n} (@code{calc-not}) [@code{not}] command computes the bitwise
18265 NOT of a number.  A bit is 1 if the input bit is 0 and vice-versa.
18267 @kindex b l
18268 @pindex calc-lshift-binary
18269 @tindex lsh
18270 The @kbd{b l} (@code{calc-lshift-binary}) [@code{lsh}] command shifts a
18271 number left by one bit, or by the number of bits specified in the numeric
18272 prefix argument.  A negative prefix argument performs a logical right shift,
18273 in which zeros are shifted in on the left.  In symbolic form, @samp{lsh(a)}
18274 is short for @samp{lsh(a,1)}, which in turn is short for @samp{lsh(a,n,w)}.
18275 Bits shifted ``off the end,'' according to the current word size, are lost.
18277 @kindex H b l
18278 @kindex H b r
18279 @ignore
18280 @mindex @idots
18281 @end ignore
18282 @kindex H b L
18283 @ignore
18284 @mindex @null
18285 @end ignore
18286 @kindex H b R
18287 @ignore
18288 @mindex @null
18289 @end ignore
18290 @kindex H b t
18291 The @kbd{H b l} command also does a left shift, but it takes two arguments
18292 from the stack (the value to shift, and, at top-of-stack, the number of
18293 bits to shift).  This version interprets the prefix argument just like
18294 the regular binary operations, i.e., as a word size.  The Hyperbolic flag
18295 has a similar effect on the rest of the binary shift and rotate commands.
18297 @kindex b r
18298 @pindex calc-rshift-binary
18299 @tindex rsh
18300 The @kbd{b r} (@code{calc-rshift-binary}) [@code{rsh}] command shifts a
18301 number right by one bit, or by the number of bits specified in the numeric
18302 prefix argument:  @samp{rsh(a,n) = lsh(a,-n)}.
18304 @kindex b L
18305 @pindex calc-lshift-arith
18306 @tindex ash
18307 The @kbd{b L} (@code{calc-lshift-arith}) [@code{ash}] command shifts a
18308 number left.  It is analogous to @code{lsh}, except that if the shift
18309 is rightward (the prefix argument is negative), an arithmetic shift
18310 is performed as described below.
18312 @kindex b R
18313 @pindex calc-rshift-arith
18314 @tindex rash
18315 The @kbd{b R} (@code{calc-rshift-arith}) [@code{rash}] command performs
18316 an ``arithmetic'' shift to the right, in which the leftmost bit (according
18317 to the current word size) is duplicated rather than shifting in zeros.
18318 This corresponds to dividing by a power of two where the input is interpreted
18319 as a signed, twos-complement number.  (The distinction between the @samp{rsh}
18320 and @samp{rash} operations is totally independent from whether the word
18321 size is positive or negative.)  With a negative prefix argument, this
18322 performs a standard left shift.
18324 @kindex b t
18325 @pindex calc-rotate-binary
18326 @tindex rot
18327 The @kbd{b t} (@code{calc-rotate-binary}) [@code{rot}] command rotates a
18328 number one bit to the left.  The leftmost bit (according to the current
18329 word size) is dropped off the left and shifted in on the right.  With a
18330 numeric prefix argument, the number is rotated that many bits to the left
18331 or right.
18333 @xref{Set Operations}, for the @kbd{b p} and @kbd{b u} commands that
18334 pack and unpack binary integers into sets.  (For example, @kbd{b u}
18335 unpacks 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''
18337 bits in a binary integer.
18339 Another interesting use of the set representation of binary integers
18340 is to reverse the bits in, say, a 32-bit integer.  Type @kbd{b u} to
18341 unpack; type @kbd{31 @key{TAB} -} to replace each bit-number in the set
18342 with 31 minus that bit-number; type @kbd{b p} to pack the set back
18343 into a binary integer.
18345 @node Scientific Functions, Matrix Functions, Arithmetic, Top
18346 @chapter Scientific Functions
18348 @noindent
18349 The functions described here perform trigonometric and other transcendental
18350 calculations.  They generally produce floating-point answers correct to the
18351 full current precision.  The @kbd{H} (Hyperbolic) and @kbd{I} (Inverse)
18352 flag keys must be used to get some of these functions from the keyboard.
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
18370 One miscellaneous command is shift-@kbd{P} (@code{calc-pi}), which pushes
18371 the value of @cpi{} (at the current precision) onto the stack.  With the
18372 Hyperbolic flag, it pushes the value @expr{e}, the base of natural logarithms.
18373 With the Inverse flag, it pushes Euler's constant 
18374 @texline @math{\gamma}
18375 @infoline @expr{gamma} 
18376 (about 0.5772).  With both Inverse and Hyperbolic, it
18377 pushes the ``golden ratio'' 
18378 @texline @math{\phi}
18379 @infoline @expr{phi} 
18380 (about 1.618).  (At present, Euler's constant is not available
18381 to unlimited precision; Calc knows only the first 100 digits.)
18382 In Symbolic mode, these commands push the
18383 actual variables @samp{pi}, @samp{e}, @samp{gamma}, and @samp{phi},
18384 respectively, instead of their values; @pxref{Symbolic Mode}.
18386 @ignore
18387 @mindex Q
18388 @end ignore
18389 @ignore
18390 @mindex I Q
18391 @end ignore
18392 @kindex I Q
18393 @tindex sqr
18394 The @kbd{Q} (@code{calc-sqrt}) [@code{sqrt}] function is described elsewhere;
18395 @pxref{Basic Arithmetic}.  With the Inverse flag [@code{sqr}], this command
18396 computes the square of the argument.
18398 @xref{Prefix Arguments}, for a discussion of the effect of numeric
18399 prefix arguments on commands in this chapter which do not otherwise
18400 interpret a prefix argument.
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
18412 @node Logarithmic Functions, Trigonometric and Hyperbolic Functions, Scientific Functions, Scientific Functions
18413 @section Logarithmic Functions
18415 @noindent
18416 @kindex L
18417 @pindex calc-ln
18418 @tindex ln
18419 @ignore
18420 @mindex @null
18421 @end ignore
18422 @kindex I E
18423 The shift-@kbd{L} (@code{calc-ln}) [@code{ln}] command computes the natural
18424 logarithm of the real or complex number on the top of the stack.  With
18425 the Inverse flag it computes the exponential function instead, although
18426 this is redundant with the @kbd{E} command.
18428 @kindex E
18429 @pindex calc-exp
18430 @tindex exp
18431 @ignore
18432 @mindex @null
18433 @end ignore
18434 @kindex I L
18435 The shift-@kbd{E} (@code{calc-exp}) [@code{exp}] command computes the
18436 exponential, i.e., @expr{e} raised to the power of the number on the stack.
18437 The meanings of the Inverse and Hyperbolic flags follow from those for
18438 the @code{calc-ln} command.
18440 @kindex H L
18441 @kindex H E
18442 @pindex calc-log10
18443 @tindex log10
18444 @tindex exp10
18445 @ignore
18446 @mindex @null
18447 @end ignore
18448 @kindex H I L
18449 @ignore
18450 @mindex @null
18451 @end ignore
18452 @kindex H I E
18453 The @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}],
18455 it raises ten to a given power.)  Note that the common logarithm of a
18456 complex number is computed by taking the natural logarithm and dividing
18457 by 
18458 @texline @math{\ln10}.
18459 @infoline @expr{ln(10)}.
18461 @kindex B
18462 @kindex I B
18463 @pindex calc-log
18464 @tindex log
18465 @tindex alog
18466 The @kbd{B} (@code{calc-log}) [@code{log}] command computes a logarithm
18467 to any base.  For example, @kbd{1024 @key{RET} 2 B} produces 10, since
18468 @texline @math{2^{10} = 1024}.
18469 @infoline @expr{2^10 = 1024}.  
18470 In certain cases like @samp{log(3,9)}, the result
18471 will be either @expr{1:2} or @expr{0.5} depending on the current Fraction
18472 mode setting.  With the Inverse flag [@code{alog}], this command is
18473 similar to @kbd{^} except that the order of the arguments is reversed.
18475 @kindex f I
18476 @pindex calc-ilog
18477 @tindex ilog
18478 The @kbd{f I} (@code{calc-ilog}) [@code{ilog}] command computes the
18479 integer logarithm of a number to any base.  The number and the base must
18480 themselves be positive integers.  This is the true logarithm, rounded
18481 down to an integer.  Thus @kbd{ilog(x,10)} is 3 for all @expr{x} in the
18482 range from 1000 to 9999.  If both arguments are positive integers, exact
18483 integer arithmetic is used; otherwise, this is equivalent to
18484 @samp{floor(log(x,b))}.
18486 @kindex f E
18487 @pindex calc-expm1
18488 @tindex expm1
18489 The @kbd{f E} (@code{calc-expm1}) [@code{expm1}] command computes
18490 @texline @math{e^x - 1},
18491 @infoline @expr{exp(x)-1}, 
18492 but using an algorithm that produces a more accurate
18493 answer when the result is close to zero, i.e., when 
18494 @texline @math{e^x}
18495 @infoline @expr{exp(x)} 
18496 is close to one.
18498 @kindex f L
18499 @pindex calc-lnp1
18500 @tindex lnp1
18501 The @kbd{f L} (@code{calc-lnp1}) [@code{lnp1}] command computes
18502 @texline @math{\ln(x+1)},
18503 @infoline @expr{ln(x+1)}, 
18504 producing a more accurate answer when @expr{x} is close to zero.
18506 @node Trigonometric and Hyperbolic Functions, Advanced Math Functions, Logarithmic Functions, Scientific Functions
18507 @section Trigonometric/Hyperbolic Functions
18509 @noindent
18510 @kindex S
18511 @pindex calc-sin
18512 @tindex sin
18513 The shift-@kbd{S} (@code{calc-sin}) [@code{sin}] command computes the sine
18514 of an angle or complex number.  If the input is an HMS form, it is interpreted
18515 as degrees-minutes-seconds; otherwise, the input is interpreted according
18516 to the current angular mode.  It is best to use Radians mode when operating
18517 on complex numbers.
18519 Calc's ``units'' mechanism includes angular units like @code{deg},
18520 @code{rad}, and @code{grad}.  While @samp{sin(45 deg)} is not evaluated
18521 all the time, the @kbd{u s} (@code{calc-simplify-units}) command will
18522 simplify @samp{sin(45 deg)} by taking the sine of 45 degrees, regardless
18523 of the current angular mode.  @xref{Basic Operations on Units}.
18525 Also, the symbolic variable @code{pi} is not ordinarily recognized in
18526 arguments to trigonometric functions, as in @samp{sin(3 pi / 4)}, but
18527 the @kbd{a s} (@code{calc-simplify}) command recognizes many such
18528 formulas when the current angular mode is Radians @emph{and} Symbolic
18529 mode is enabled; this example would be replaced by @samp{sqrt(2) / 2}.
18530 @xref{Symbolic Mode}.  Beware, this simplification occurs even if you
18531 have stored a different value in the variable @samp{pi}; this is one
18532 reason why changing built-in variables is a bad idea.  Arguments of
18533 the form @expr{x} plus a multiple of @cpiover{2} are also simplified.
18534 Calc includes similar formulas for @code{cos} and @code{tan}.
18536 The @kbd{a s} command knows all angles which are integer multiples of
18537 @cpiover{12}, @cpiover{10}, or @cpiover{8} radians.  In Degrees mode,
18538 analogous simplifications occur for integer multiples of 15 or 18
18539 degrees, and for arguments plus multiples of 90 degrees.
18541 @kindex I S
18542 @pindex calc-arcsin
18543 @tindex arcsin
18544 With the Inverse flag, @code{calc-sin} computes an arcsine.  This is also
18545 available as the @code{calc-arcsin} command or @code{arcsin} algebraic
18546 function.  The returned argument is converted to degrees, radians, or HMS
18547 notation depending on the current angular mode.
18549 @kindex H S
18550 @pindex calc-sinh
18551 @tindex sinh
18552 @kindex H I S
18553 @pindex calc-arcsinh
18554 @tindex arcsinh
18555 With the Hyperbolic flag, @code{calc-sin} computes the hyperbolic
18556 sine, also available as @code{calc-sinh} [@code{sinh}].  With the
18557 Hyperbolic and Inverse flags, it computes the hyperbolic arcsine
18558 (@code{calc-arcsinh}) [@code{arcsinh}].
18560 @kindex C
18561 @pindex calc-cos
18562 @tindex cos
18563 @ignore
18564 @mindex @idots
18565 @end ignore
18566 @kindex I C
18567 @pindex calc-arccos
18568 @ignore
18569 @mindex @null
18570 @end ignore
18571 @tindex arccos
18572 @ignore
18573 @mindex @null
18574 @end ignore
18575 @kindex H C
18576 @pindex calc-cosh
18577 @ignore
18578 @mindex @null
18579 @end ignore
18580 @tindex cosh
18581 @ignore
18582 @mindex @null
18583 @end ignore
18584 @kindex H I C
18585 @pindex calc-arccosh
18586 @ignore
18587 @mindex @null
18588 @end ignore
18589 @tindex arccosh
18590 @ignore
18591 @mindex @null
18592 @end ignore
18593 @kindex T
18594 @pindex calc-tan
18595 @ignore
18596 @mindex @null
18597 @end ignore
18598 @tindex tan
18599 @ignore
18600 @mindex @null
18601 @end ignore
18602 @kindex I T
18603 @pindex calc-arctan
18604 @ignore
18605 @mindex @null
18606 @end ignore
18607 @tindex arctan
18608 @ignore
18609 @mindex @null
18610 @end ignore
18611 @kindex H T
18612 @pindex calc-tanh
18613 @ignore
18614 @mindex @null
18615 @end ignore
18616 @tindex tanh
18617 @ignore
18618 @mindex @null
18619 @end ignore
18620 @kindex H I T
18621 @pindex calc-arctanh
18622 @ignore
18623 @mindex @null
18624 @end ignore
18625 @tindex arctanh
18626 The shift-@kbd{C} (@code{calc-cos}) [@code{cos}] command computes the cosine
18627 of an angle or complex number, and shift-@kbd{T} (@code{calc-tan}) [@code{tan}]
18628 computes the tangent, along with all the various inverse and hyperbolic
18629 variants of these functions.
18631 @kindex f T
18632 @pindex calc-arctan2
18633 @tindex arctan2
18634 The @kbd{f T} (@code{calc-arctan2}) [@code{arctan2}] command takes two
18635 numbers from the stack and computes the arc tangent of their ratio.  The
18636 result is in the full range from @mathit{-180} (exclusive) to @mathit{+180}
18637 (inclusive) degrees, or the analogous range in radians.  A similar
18638 result would be obtained with @kbd{/} followed by @kbd{I T}, but the
18639 value would only be in the range from @mathit{-90} to @mathit{+90} degrees
18640 since the division loses information about the signs of the two
18641 components, and an error might result from an explicit division by zero
18642 which @code{arctan2} would avoid.  By (arbitrary) definition,
18643 @samp{arctan2(0,0)=0}.
18645 @pindex calc-sincos
18646 @ignore
18647 @starindex
18648 @end ignore
18649 @tindex sincos
18650 @ignore
18651 @starindex
18652 @end ignore
18653 @ignore
18654 @mindex arc@idots
18655 @end ignore
18656 @tindex arcsincos
18657 The @code{calc-sincos} [@code{sincos}] command computes the sine and
18658 cosine of a number, returning them as a vector of the form
18659 @samp{[@var{cos}, @var{sin}]}.
18660 With the Inverse flag [@code{arcsincos}], this command takes a two-element
18661 vector as an argument and computes @code{arctan2} of the elements.
18662 (This command does not accept the Hyperbolic flag.)
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
18676 The remaining trigonometric functions, @code{calc-sec} [@code{sec}],
18677 @code{calc-csc} [@code{csc}] and @code{calc-sec} [@code{sec}], are also
18678 available.  With the Hyperbolic flag, these compute their hyperbolic
18679 counterparts, 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.)
18683 @node Advanced Math Functions, Branch Cuts, Trigonometric and Hyperbolic Functions, Scientific Functions
18684 @section Advanced Mathematical Functions
18686 @noindent
18687 Calc can compute a variety of less common functions that arise in
18688 various branches of mathematics.  All of the functions described in
18689 this section allow arbitrary complex arguments and, except as noted,
18690 will work to arbitrarily large precisions.  They can not at present
18691 handle error forms or intervals as arguments.
18693 NOTE:  These functions are still experimental.  In particular, their
18694 accuracy is not guaranteed in all domains.  It is advisable to set the
18695 current precision comfortably higher than you actually need when
18696 using these functions.  Also, these functions may be impractically
18697 slow for some values of the arguments.
18699 @kindex f g
18700 @pindex calc-gamma
18701 @tindex gamma
18702 The @kbd{f g} (@code{calc-gamma}) [@code{gamma}] command computes the Euler
18703 gamma function.  For positive integer arguments, this is related to the
18704 factorial function:  @samp{gamma(n+1) = fact(n)}.  For general complex
18705 arguments the gamma function can be defined by the following definite
18706 integral:  
18707 @texline @math{\Gamma(a) = \int_0^\infty t^{a-1} e^t dt}.
18708 @infoline @expr{gamma(a) = integ(t^(a-1) exp(t), t, 0, inf)}.  
18709 (The actual implementation uses far more efficient computational methods.)
18711 @kindex f G
18712 @tindex gammaP
18713 @ignore
18714 @mindex @idots
18715 @end ignore
18716 @kindex I f G
18717 @ignore
18718 @mindex @null
18719 @end ignore
18720 @kindex H f G
18721 @ignore
18722 @mindex @null
18723 @end ignore
18724 @kindex H I f G
18725 @pindex calc-inc-gamma
18726 @ignore
18727 @mindex @null
18728 @end ignore
18729 @tindex gammaQ
18730 @ignore
18731 @mindex @null
18732 @end ignore
18733 @tindex gammag
18734 @ignore
18735 @mindex @null
18736 @end ignore
18737 @tindex gammaG
18738 The @kbd{f G} (@code{calc-inc-gamma}) [@code{gammaP}] command computes
18739 the incomplete gamma function, denoted @samp{P(a,x)}.  This is defined by
18740 the integral, 
18741 @texline @math{P(a,x) = \left( \int_0^x t^{a-1} e^t dt \right) / \Gamma(a)}.
18742 @infoline @expr{gammaP(a,x) = integ(t^(a-1) exp(t), t, 0, x) / gamma(a)}.
18743 This implies that @samp{gammaP(a,inf) = 1} for any @expr{a} (see the
18744 definition of the normal gamma function).
18746 Several other varieties of incomplete gamma function are defined.
18747 The complement of @expr{P(a,x)}, called @expr{Q(a,x) = 1-P(a,x)} by
18748 some authors, is computed by the @kbd{I f G} [@code{gammaQ}] command.
18749 You can think of this as taking the other half of the integral, from
18750 @expr{x} to infinity.
18752 @ifinfo
18753 The functions corresponding to the integrals that define @expr{P(a,x)}
18754 and @expr{Q(a,x)} but without the normalizing @expr{1/gamma(a)}
18755 factor 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
18757 letter gamma).  You can obtain these using the @kbd{H f G} [@code{gammag}]
18758 and @kbd{H I f G} [@code{gammaG}] commands.
18759 @end ifinfo
18760 @tex
18761 \turnoffactive
18762 The functions corresponding to the integrals that define $P(a,x)$
18763 and $Q(a,x)$ but without the normalizing $1/\Gamma(a)$
18764 factor are called $\gamma(a,x)$ and $\Gamma(a,x)$, respectively.
18765 You can obtain these using the \kbd{H f G} [\code{gammag}] and
18766 \kbd{I H f G} [\code{gammaG}] commands.
18767 @end tex
18769 @kindex f b
18770 @pindex calc-beta
18771 @tindex beta
18772 The @kbd{f b} (@code{calc-beta}) [@code{beta}] command computes the
18773 Euler beta function, which is defined in terms of the gamma function as
18774 @texline @math{B(a,b) = \Gamma(a) \Gamma(b) / \Gamma(a+b)},
18775 @infoline @expr{beta(a,b) = gamma(a) gamma(b) / gamma(a+b)}, 
18776 or by
18777 @texline @math{B(a,b) = \int_0^1 t^{a-1} (1-t)^{b-1} dt}.
18778 @infoline @expr{beta(a,b) = integ(t^(a-1) (1-t)^(b-1), t, 0, 1)}.
18780 @kindex f B
18781 @kindex H f B
18782 @pindex calc-inc-beta
18783 @tindex betaI
18784 @tindex betaB
18785 The @kbd{f B} (@code{calc-inc-beta}) [@code{betaI}] command computes
18786 the incomplete beta function @expr{I(x,a,b)}.  It is defined by
18787 @texline @math{I(x,a,b) = \left( \int_0^x t^{a-1} (1-t)^{b-1} dt \right) / B(a,b)}.
18788 @infoline @expr{betaI(x,a,b) = integ(t^(a-1) (1-t)^(b-1), t, 0, x) / beta(a,b)}.
18789 Once again, the @kbd{H} (hyperbolic) prefix gives the corresponding
18790 un-normalized version [@code{betaB}].
18792 @kindex f e
18793 @kindex I f e
18794 @pindex calc-erf
18795 @tindex erf
18796 @tindex erfc
18797 The @kbd{f e} (@code{calc-erf}) [@code{erf}] command computes the
18798 error function 
18799 @texline @math{\hbox{erf}(x) = {2 \over \sqrt{\pi}} \int_0^x e^{-t^2} dt}.
18800 @infoline @expr{erf(x) = 2 integ(exp(-(t^2)), t, 0, x) / sqrt(pi)}.
18801 The complementary error function @kbd{I f e} (@code{calc-erfc}) [@code{erfc}]
18802 is the corresponding integral from @samp{x} to infinity; the sum
18803 @texline @math{\hbox{erf}(x) + \hbox{erfc}(x) = 1}.
18804 @infoline @expr{erf(x) + erfc(x) = 1}.
18806 @kindex f j
18807 @kindex f y
18808 @pindex calc-bessel-J
18809 @pindex calc-bessel-Y
18810 @tindex besJ
18811 @tindex besY
18812 The @kbd{f j} (@code{calc-bessel-J}) [@code{besJ}] and @kbd{f y}
18813 (@code{calc-bessel-Y}) [@code{besY}] commands compute the Bessel
18814 functions of the first and second kinds, respectively.
18815 In @samp{besJ(n,x)} and @samp{besY(n,x)} the ``order'' parameter
18816 @expr{n} is often an integer, but is not required to be one.
18817 Calc's implementation of the Bessel functions currently limits the
18818 precision to 8 digits, and may not be exact even to that precision.
18819 Use with care!
18821 @node Branch Cuts, Random Numbers, Advanced Math Functions, Scientific Functions
18822 @section Branch Cuts and Principal Values
18824 @noindent
18825 @cindex Branch cuts
18826 @cindex Principal values
18827 All of the logarithmic, trigonometric, and other scientific functions are
18828 defined for complex numbers as well as for reals.
18829 This section describes the values
18830 returned in cases where the general result is a family of possible values.
18831 Calc follows section 12.5.3 of Steele's @dfn{Common Lisp, the Language},
18832 second edition, in these matters.  This section will describe each
18833 function briefly; for a more detailed discussion (including some nifty
18834 diagrams), consult Steele's book.
18836 Note that the branch cuts for @code{arctan} and @code{arctanh} were
18837 changed between the first and second editions of Steele.  Versions of
18838 Calc starting with 2.00 follow the second edition.
18840 The new branch cuts exactly match those of the HP-28/48 calculators.
18841 They 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,
18843 and its @code{arctanh} cut is always in the top half of the plane.
18844 Calc's cuts are continuous with quadrants I and III for @code{arctan},
18845 or II and IV for @code{arctanh}.
18847 Note:  The current implementations of these functions with complex arguments
18848 are designed with proper behavior around the branch cuts in mind, @emph{not}
18849 efficiency or accuracy.  You may need to increase the floating precision
18850 and wait a while to get suitable answers from them.
18852 For @samp{sqrt(a+bi)}:  When @expr{a<0} and @expr{b} is small but positive
18853 or zero, the result is close to the @expr{+i} axis.  For @expr{b} small and
18854 negative, the result is close to the @expr{-i} axis.  The result always lies
18855 in the right half of the complex plane.
18857 For @samp{ln(a+bi)}:  The real part is defined as @samp{ln(abs(a+bi))}.
18858 The imaginary part is defined as @samp{arg(a+bi) = arctan2(b,a)}.
18859 Thus the branch cuts for @code{sqrt} and @code{ln} both lie on the
18860 negative real axis.
18862 The following table describes these branch cuts in another way.
18863 If the real and imaginary parts of @expr{z} are as shown, then
18864 the real and imaginary parts of @expr{f(z)} will be as shown.
18865 Here @code{eps} stands for a small positive value; each
18866 occurrence of @code{eps} may stand for a different small value.
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
18877 For @samp{z1^z2}:  This is defined by @samp{exp(ln(z1)*z2)}.
18878 One interesting consequence of this is that @samp{(-8)^1:3} does
18879 not evaluate to @mathit{-2} as you might expect, but to the complex
18880 number @expr{(1., 1.732)}.  Both of these are valid cube roots
18881 of @mathit{-8} (as is @expr{(1., -1.732)}); Calc chooses a perhaps
18882 less-obvious root for the sake of mathematical consistency.
18884 For @samp{arcsin(z)}:  This is defined by @samp{-i*ln(i*z + sqrt(1-z^2))}.
18885 The branch cuts are on the real axis, less than @mathit{-1} and greater than 1.
18887 For @samp{arccos(z)}:  This is defined by @samp{-i*ln(z + i*sqrt(1-z^2))},
18888 or equivalently by @samp{pi/2 - arcsin(z)}.  The branch cuts are on
18889 the real axis, less than @mathit{-1} and greater than 1.
18891 For @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
18893 imaginary axis, below @expr{-i} and above @expr{i}.
18895 For @samp{arcsinh(z)}:  This is defined by @samp{ln(z + sqrt(1+z^2))}.
18896 The branch cuts are on the imaginary axis, below @expr{-i} and
18897 above @expr{i}.
18899 For @samp{arccosh(z)}:  This is defined by
18900 @samp{ln(z + (z+1)*sqrt((z-1)/(z+1)))}.  The branch cut is on the
18901 real axis less than 1.
18903 For @samp{arctanh(z)}:  This is defined by @samp{(ln(1+z) - ln(1-z)) / 2}.
18904 The branch cuts are on the real axis, less than @mathit{-1} and greater than 1.
18906 The following tables for @code{arcsin}, @code{arccos}, and
18907 @code{arctan} assume the current angular mode is Radians.  The
18908 hyperbolic functions operate independently of the angular mode.
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
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
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
18950 Finally, the following identities help to illustrate the relationship
18951 between the complex trigonometric and hyperbolic functions.  They
18952 are valid everywhere, including on the branch cuts.
18954 @smallexample
18955 sin(i*z)  = i*sinh(z)       arcsin(i*z)  = i*arcsinh(z)
18956 cos(i*z)  =   cosh(z)       arcsinh(i*z) = i*arcsin(z)
18957 tan(i*z)  = i*tanh(z)       arctan(i*z)  = i*arctanh(z)
18958 sinh(i*z) = i*sin(z)        cosh(i*z)    =   cos(z)
18959 @end smallexample
18961 The ``advanced math'' functions (gamma, Bessel, etc.@:) are also defined
18962 for general complex arguments, but their branch cuts and principal values
18963 are not rigorously specified at present.
18965 @node Random Numbers, Combinatorial Functions, Branch Cuts, Scientific Functions
18966 @section Random Numbers
18968 @noindent
18969 @kindex k r
18970 @pindex calc-random
18971 @tindex random
18972 The @kbd{k r} (@code{calc-random}) [@code{random}] command produces
18973 random numbers of various sorts.
18975 Given a positive numeric prefix argument @expr{M}, it produces a random
18976 integer @expr{N} in the range 
18977 @texline @math{0 \le N < M}.
18978 @infoline @expr{0 <= N < M}.  
18979 Each of the @expr{M} values appears with equal probability.
18981 With no numeric prefix argument, the @kbd{k r} command takes its argument
18982 from the stack instead.  Once again, if this is a positive integer @expr{M}
18983 the result is a random integer less than @expr{M}.  However, note that
18984 while numeric prefix arguments are limited to six digits or so, an @expr{M}
18985 taken from the stack can be arbitrarily large.  If @expr{M} is negative,
18986 the result is a random integer in the range 
18987 @texline @math{M < N \le 0}.
18988 @infoline @expr{M < N <= 0}.
18990 If the value on the stack is a floating-point number @expr{M}, the result
18991 is a random floating-point number @expr{N} in the range 
18992 @texline @math{0 \le N < M}
18993 @infoline @expr{0 <= N < M}
18994 or 
18995 @texline @math{M < N \le 0},
18996 @infoline @expr{M < N <= 0}, 
18997 according to the sign of @expr{M}.
18999 If @expr{M} is zero, the result is a Gaussian-distributed random real
19000 number; the distribution has a mean of zero and a standard deviation
19001 of one.  The algorithm used generates random numbers in pairs; thus,
19002 every other call to this function will be especially fast.
19004 If @expr{M} is an error form 
19005 @texline @math{m} @code{+/-} @math{\sigma}
19006 @infoline @samp{m +/- s} 
19007 where @var{m} and 
19008 @texline @math{\sigma}
19009 @infoline @var{s} 
19010 are both real numbers, the result uses a Gaussian distribution with mean
19011 @var{m} and standard deviation 
19012 @texline @math{\sigma}.
19013 @infoline @var{s}.
19015 If @expr{M} is an interval form, the lower and upper bounds specify the
19016 acceptable limits of the random numbers.  If both bounds are integers,
19017 the result is a random integer in the specified range.  If either bound
19018 is floating-point, the result is a random real number in the specified
19019 range.  If the interval is open at either end, the result will be sure
19020 not to equal that end value.  (This makes a big difference for integer
19021 intervals, but for floating-point intervals it's relatively minor:
19022 with a precision of 6, @samp{random([1.0..2.0))} will return any of one
19023 million numbers from 1.00000 to 1.99999; @samp{random([1.0..2.0])} may
19024 additionally return 2.00000, but the probability of this happening is
19025 extremely small.)
19027 If @expr{M} is a vector, the result is one element taken at random from
19028 the vector.  All elements of the vector are given equal probabilities.
19030 @vindex RandSeed
19031 The sequence of numbers produced by @kbd{k r} is completely random by
19032 default, i.e., the sequence is seeded each time you start Calc using
19033 the current time and other information.  You can get a reproducible
19034 sequence by storing a particular ``seed value'' in the Calc variable
19035 @code{RandSeed}.  Any integer will do for a seed; integers of from 1
19036 to 12 digits are good.  If you later store a different integer into
19037 @code{RandSeed}, Calc will switch to a different pseudo-random
19038 sequence.  If you ``unstore'' @code{RandSeed}, Calc will re-seed itself
19039 from the current time.  If you store the same integer that you used
19040 before back into @code{RandSeed}, you will get the exact same sequence
19041 of random numbers as before.
19043 @pindex calc-rrandom
19044 The @code{calc-rrandom} command (not on any key) produces a random real
19045 number between zero and one.  It is equivalent to @samp{random(1.0)}.
19047 @kindex k a
19048 @pindex calc-random-again
19049 The @kbd{k a} (@code{calc-random-again}) command produces another random
19050 number, re-using the most recent value of @expr{M}.  With a numeric
19051 prefix argument @var{n}, it produces @var{n} more random numbers using
19052 that value of @expr{M}.
19054 @kindex k h
19055 @pindex calc-shuffle
19056 @tindex shuffle
19057 The @kbd{k h} (@code{calc-shuffle}) command produces a vector of several
19058 random values with no duplicates.  The value on the top of the stack
19059 specifies the set from which the random values are drawn, and may be any
19060 of the @expr{M} formats described above.  The numeric prefix argument
19061 gives the length of the desired list.  (If you do not provide a numeric
19062 prefix argument, the length of the list is taken from the top of the
19063 stack, and @expr{M} from second-to-top.)
19065 If @expr{M} is a floating-point number, zero, or an error form (so
19066 that the random values are being drawn from the set of real numbers)
19067 there 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
19069 of just a few integers, or the elements of a vector, then there is
19070 a very real chance that multiple @kbd{k r}'s will produce the same
19071 number more than once.  The @kbd{k h} command produces a vector whose
19072 elements are always distinct.  (Actually, there is a slight exception:
19073 If @expr{M} is a vector, no given vector element will be drawn more
19074 than once, but if several elements of @expr{M} are equal, they may
19075 each make it into the result vector.)
19077 One use of @kbd{k h} is to rearrange a list at random.  This happens
19078 if 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
19082 by @expr{M}.  Naturally, this is allowed only when @expr{M} specifies
19083 a small discrete set of possibilities.
19085 To do the equivalent of @kbd{k h} but with duplications allowed,
19086 given @expr{M} on the stack and with @var{n} just entered as a numeric
19087 prefix, use @kbd{v b} to build a vector of copies of @expr{M}, then use
19088 @kbd{V M k r} to ``map'' the normal @kbd{k r} function over the
19089 elements of this vector.  @xref{Matrix Functions}.
19091 @menu
19092 * Random Number Generator::     (Complete description of Calc's algorithm)
19093 @end menu
19095 @node Random Number Generator, , Random Numbers, Random Numbers
19096 @subsection Random Number Generator
19098 Calc's random number generator uses several methods to ensure that
19099 the numbers it produces are highly random.  Knuth's @emph{Art of
19100 Computer Programming}, Volume II, contains a thorough description
19101 of the theory of random number generators and their measurement and
19102 characterization.
19104 If @code{RandSeed} has no stored value, Calc calls Emacs' built-in
19105 @code{random} function to get a stream of random numbers, which it
19106 then treats in various ways to avoid problems inherent in the simple
19107 random number generators that many systems use to implement @code{random}.
19109 When Calc's random number generator is first invoked, it ``seeds''
19110 the low-level random sequence using the time of day, so that the
19111 random number sequence will be different every time you use Calc.
19113 Since Emacs Lisp doesn't specify the range of values that will be
19114 returned by its @code{random} function, Calc exercises the function
19115 several times to estimate the range.  When Calc subsequently uses
19116 the @code{random} function, it takes only 10 bits of the result
19117 near the most-significant end.  (It avoids at least the bottom
19118 four bits, preferably more, and also tries to avoid the top two
19119 bits.)  This strategy works well with the linear congruential
19120 generators that are typically used to implement @code{random}.
19122 If @code{RandSeed} contains an integer, Calc uses this integer to
19123 seed an ``additive congruential'' method (Knuth's algorithm 3.2.2A,
19124 computing 
19125 @texline @math{X_{n-55} - X_{n-24}}.
19126 @infoline @expr{X_n-55 - X_n-24}).  
19127 This method expands the seed
19128 value into a large table which is maintained internally; the variable
19129 @code{RandSeed} is changed from, e.g., 42 to the vector @expr{[42]}
19130 to indicate that the seed has been absorbed into this table.  When
19131 @code{RandSeed} contains a vector, @kbd{k r} and related commands
19132 continue to use the same internal table as last time.  There is no
19133 way to extract the complete state of the random number generator
19134 so that you can restart it from any point; you can only restart it
19135 from the same initial seed value.  A simple way to restart from the
19136 same 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}
19138 to reseed the generator with that number.
19140 Calc uses a ``shuffling'' method as described in algorithm 3.2.2B
19141 of Knuth.  It fills a table with 13 random 10-bit numbers.  Then,
19142 to generate a new random number, it uses the previous number to
19143 index into the table, picks the value it finds there as the new
19144 random number, then replaces that table entry with a new value
19145 obtained from a call to the base random number generator (either
19146 the additive congruential generator or the @code{random} function
19147 supplied by the system).  If there are any flaws in the base
19148 generator, shuffling will tend to even them out.  But if the system
19149 provides an excellent @code{random} function, shuffling will not
19150 damage its randomness.
19152 To create a random integer of a certain number of digits, Calc
19153 builds the integer three decimal digits at a time.  For each group
19154 of 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
19156 or more, Calc throws it out and tries again until it gets a suitable
19157 value.
19159 To create a random floating-point number with precision @var{p}, Calc
19160 simply creates a random @var{p}-digit integer and multiplies by
19161 @texline @math{10^{-p}}.
19162 @infoline @expr{10^-p}.  
19163 The resulting random numbers should be very clean, but note
19164 that relatively small numbers will have few significant random digits.
19165 In other words, with a precision of 12, you will occasionally get
19166 numbers on the order of 
19167 @texline @math{10^{-9}}
19168 @infoline @expr{10^-9} 
19169 or 
19170 @texline @math{10^{-10}},
19171 @infoline @expr{10^-10}, 
19172 but those numbers will only have two or three random digits since they
19173 correspond to small integers times 
19174 @texline @math{10^{-12}}.
19175 @infoline @expr{10^-12}.
19177 To create a random integer in the interval @samp{[0 .. @var{m})}, Calc
19178 counts the digits in @var{m}, creates a random integer with three
19179 additional digits, then reduces modulo @var{m}.  Unless @var{m} is a
19180 power of ten the resulting values will be very slightly biased toward
19181 the lower numbers, but this bias will be less than 0.1%.  (For example,
19182 if @var{m} is 42, Calc will reduce a random integer less than 100000
19183 modulo 42 to get a result less than 42.  It is easy to show that the
19184 numbers 40 and 41 will be only 2380/2381 as likely to result from this
19185 modulo operation as numbers 39 and below.)  If @var{m} is a power of
19186 ten, however, the numbers should be completely unbiased.
19188 The Gaussian random numbers generated by @samp{random(0.0)} use the
19189 ``polar'' method described in Knuth section 3.4.1C.  This method
19190 generates a pair of Gaussian random numbers at a time, so only every
19191 other call to @samp{random(0.0)} will require significant calculations.
19193 @node Combinatorial Functions, Probability Distribution Functions, Random Numbers, Scientific Functions
19194 @section Combinatorial Functions
19196 @noindent
19197 Commands relating to combinatorics and number theory begin with the
19198 @kbd{k} key prefix.
19200 @kindex k g
19201 @pindex calc-gcd
19202 @tindex gcd
19203 The @kbd{k g} (@code{calc-gcd}) [@code{gcd}] command computes the
19204 Greatest Common Divisor of two integers.  It also accepts fractions;
19205 the GCD of two fractions is defined by taking the GCD of the
19206 numerators, and the LCM of the denominators.  This definition is
19207 consistent with the idea that @samp{a / gcd(a,x)} should yield an
19208 integer for any @samp{a} and @samp{x}.  For other types of arguments,
19209 the operation is left in symbolic form.
19211 @kindex k l
19212 @pindex calc-lcm
19213 @tindex lcm
19214 The @kbd{k l} (@code{calc-lcm}) [@code{lcm}] command computes the
19215 Least Common Multiple of two integers or fractions.  The product of
19216 the LCM and GCD of two numbers is equal to the product of the
19217 numbers.
19219 @kindex k E
19220 @pindex calc-extended-gcd
19221 @tindex egcd
19222 The @kbd{k E} (@code{calc-extended-gcd}) [@code{egcd}] command computes
19223 the GCD of two integers @expr{x} and @expr{y} and returns a vector
19224 @expr{[g, a, b]} where 
19225 @texline @math{g = \gcd(x,y) = a x + b y}.
19226 @infoline @expr{g = gcd(x,y) = a x + b y}.
19228 @kindex !
19229 @pindex calc-factorial
19230 @tindex fact
19231 @ignore
19232 @mindex @null
19233 @end ignore
19234 @tindex !
19235 The @kbd{!} (@code{calc-factorial}) [@code{fact}] command computes the
19236 factorial of the number at the top of the stack.  If the number is an
19237 integer, the result is an exact integer.  If the number is an
19238 integer-valued float, the result is a floating-point approximation.  If
19239 the number is a non-integral real number, the generalized factorial is used,
19240 as defined by the Euler Gamma function.  Please note that computation of
19241 large factorials can be slow; using floating-point format will help
19242 since fewer digits must be maintained.  The same is true of many of
19243 the commands in this section.
19245 @kindex k d
19246 @pindex calc-double-factorial
19247 @tindex dfact
19248 @ignore
19249 @mindex @null
19250 @end ignore
19251 @tindex !!
19252 The @kbd{k d} (@code{calc-double-factorial}) [@code{dfact}] command
19253 computes the ``double factorial'' of an integer.  For an even integer,
19254 this is the product of even integers from 2 to @expr{N}.  For an odd
19255 integer, this is the product of odd integers from 3 to @expr{N}.  If
19256 the argument is an integer-valued float, the result is a floating-point
19257 approximation.  This function is undefined for negative even integers.
19258 The notation @expr{N!!} is also recognized for double factorials.
19260 @kindex k c
19261 @pindex calc-choose
19262 @tindex choose
19263 The @kbd{k c} (@code{calc-choose}) [@code{choose}] command computes the
19264 binomial coefficient @expr{N}-choose-@expr{M}, where @expr{M} is the number
19265 on the top of the stack and @expr{N} is second-to-top.  If both arguments
19266 are integers, the result is an exact integer.  Otherwise, the result is a
19267 floating-point approximation.  The binomial coefficient is defined for all
19268 real numbers by
19269 @texline @math{N! \over M! (N-M)!\,}.
19270 @infoline @expr{N! / M! (N-M)!}.
19272 @kindex H k c
19273 @pindex calc-perm
19274 @tindex perm
19275 @ifinfo
19276 The @kbd{H k c} (@code{calc-perm}) [@code{perm}] command computes the
19277 number-of-permutations function @expr{N! / (N-M)!}.
19278 @end ifinfo
19279 @tex
19280 The \kbd{H k c} (\code{calc-perm}) [\code{perm}] command computes the
19281 number-of-perm\-utations function $N! \over (N-M)!\,$.
19282 @end tex
19284 @kindex k b
19285 @kindex H k b
19286 @pindex calc-bernoulli-number
19287 @tindex bern
19288 The @kbd{k b} (@code{calc-bernoulli-number}) [@code{bern}] command
19289 computes a given Bernoulli number.  The value at the top of the stack
19290 is a nonnegative integer @expr{n} that specifies which Bernoulli number
19291 is desired.  The @kbd{H k b} command computes a Bernoulli polynomial,
19292 taking @expr{n} from the second-to-top position and @expr{x} from the
19293 top of the stack.  If @expr{x} is a variable or formula the result is
19294 a polynomial in @expr{x}; if @expr{x} is a number the result is a number.
19296 @kindex k e
19297 @kindex H k e
19298 @pindex calc-euler-number
19299 @tindex euler
19300 The @kbd{k e} (@code{calc-euler-number}) [@code{euler}] command similarly
19301 computes an Euler number, and @w{@kbd{H k e}} computes an Euler polynomial.
19302 Bernoulli and Euler numbers occur in the Taylor expansions of several
19303 functions.
19305 @kindex k s
19306 @kindex H k s
19307 @pindex calc-stirling-number
19308 @tindex stir1
19309 @tindex stir2
19310 The @kbd{k s} (@code{calc-stirling-number}) [@code{stir1}] command
19311 computes a Stirling number of the first 
19312 @texline kind@tie{}@math{n \brack m},
19313 @infoline kind,
19314 given 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 
19316 @texline kind@tie{}@math{n \brace m}.
19317 @infoline kind.
19318 These are the number of @expr{m}-cycle permutations of @expr{n} objects,
19319 and the number of ways to partition @expr{n} objects into @expr{m}
19320 non-empty sets, respectively.
19322 @kindex k p
19323 @pindex calc-prime-test
19324 @cindex Primes
19325 The @kbd{k p} (@code{calc-prime-test}) command checks if the integer on
19326 the top of the stack is prime.  For integers less than eight million, the
19327 answer is always exact and reasonably fast.  For larger integers, a
19328 probabilistic method is used (see Knuth vol. II, section 4.5.4, algorithm P).
19329 The number is first checked against small prime factors (up to 13).  Then,
19330 any number of iterations of the algorithm are performed.  Each step either
19331 discovers that the number is non-prime, or substantially increases the
19332 certainty that the number is prime.  After a few steps, the chance that
19333 a 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
19335 even a single iteration is quite reliable.)  After the @kbd{k p} command,
19336 the number will be reported as definitely prime or non-prime if possible,
19337 or otherwise ``probably'' prime with a certain probability of error.
19339 @ignore
19340 @starindex
19341 @end ignore
19342 @tindex prime
19343 The normal @kbd{k p} command performs one iteration of the primality
19344 test.  Pressing @kbd{k p} repeatedly for the same integer will perform
19345 additional iterations.  Also, @kbd{k p} with a numeric prefix performs
19346 the specified number of iterations.  There is also an algebraic function
19347 @samp{prime(n)} or @samp{prime(n,iters)} which returns 1 if @expr{n}
19348 is (probably) prime and 0 if not.
19350 @kindex k f
19351 @pindex calc-prime-factors
19352 @tindex prfac
19353 The @kbd{k f} (@code{calc-prime-factors}) [@code{prfac}] command
19354 attempts to decompose an integer into its prime factors.  For numbers up
19355 to 25 million, the answer is exact although it may take some time.  The
19356 result is a vector of the prime factors in increasing order.  For larger
19357 inputs, prime factors above 5000 may not be found, in which case the
19358 last number in the vector will be an unfactored integer greater than 25
19359 million (with a warning message).  For negative integers, the first
19360 element 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.
19363 @kindex k n
19364 @pindex calc-next-prime
19365 @ignore
19366 @mindex nextpr@idots
19367 @end ignore
19368 @tindex nextprime
19369 The @kbd{k n} (@code{calc-next-prime}) [@code{nextprime}] command finds
19370 the next prime above a given number.  Essentially, it searches by calling
19371 @code{calc-prime-test} on successive integers until it finds one that
19372 passes the test.  This is quite fast for integers less than eight million,
19373 but once the probabilistic test comes into play the search may be rather
19374 slow.  Ordinarily this command stops for any prime that passes one iteration
19375 of the primality test.  With a numeric prefix argument, a number must pass
19376 the specified number of iterations before the search stops.  (This only
19377 matters when searching above eight million.)  You can always use additional
19378 @kbd{k p} commands to increase your certainty that the number is indeed
19379 prime.
19381 @kindex I k n
19382 @pindex calc-prev-prime
19383 @ignore
19384 @mindex prevpr@idots
19385 @end ignore
19386 @tindex prevprime
19387 The @kbd{I k n} (@code{calc-prev-prime}) [@code{prevprime}] command
19388 analogously finds the next prime less than a given number.
19390 @kindex k t
19391 @pindex calc-totient
19392 @tindex totient
19393 The @kbd{k t} (@code{calc-totient}) [@code{totient}] command computes the
19394 Euler ``totient'' 
19395 @texline function@tie{}@math{\phi(n)},
19396 @infoline function,
19397 the number of integers less than @expr{n} which
19398 are relatively prime to @expr{n}.
19400 @kindex k m
19401 @pindex calc-moebius
19402 @tindex moebius
19403 The @kbd{k m} (@code{calc-moebius}) [@code{moebius}] command computes the
19404 @texline M@"obius @math{\mu}
19405 @infoline Moebius ``mu''
19406 function.  If the input number is a product of @expr{k}
19407 distinct factors, this is @expr{(-1)^k}.  If the input number has any
19408 duplicate factors (i.e., can be divided by the same prime more than once),
19409 the result is zero.
19411 @node Probability Distribution Functions, , Combinatorial Functions, Scientific Functions
19412 @section Probability Distribution Functions
19414 @noindent
19415 The functions in this section compute various probability distributions.
19416 For continuous distributions, this is the integral of the probability
19417 density function from @expr{x} to infinity.  (These are the ``upper
19418 tail'' distribution functions; there are also corresponding ``lower
19419 tail'' functions which integrate from minus infinity to @expr{x}.)
19420 For discrete distributions, the upper tail function gives the sum
19421 from @expr{x} to infinity; the lower tail function gives the sum
19422 from minus infinity up to, but not including,@w{ }@expr{x}.
19424 To integrate from @expr{x} to @expr{y}, just use the distribution
19425 function twice and subtract.  For example, the probability that a
19426 Gaussian random variable with mean 2 and standard deviation 1 will
19427 lie 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''),
19429 or equivalently @samp{ltpn(2.8,2,1) - ltpn(2.5,2,1)}.
19431 @kindex k B
19432 @kindex I k B
19433 @pindex calc-utpb
19434 @tindex utpb
19435 @tindex ltpb
19436 The @kbd{k B} (@code{calc-utpb}) [@code{utpb}] function uses the
19437 binomial distribution.  Push the parameters @var{n}, @var{p}, and
19438 then @var{x} onto the stack; the result (@samp{utpb(x,n,p)}) is the
19439 probability that an event will occur @var{x} or more times out
19440 of @var{n} trials, if its probability of occurring in any given
19441 trial is @var{p}.  The @kbd{I k B} [@code{ltpb}] function is
19442 the probability that the event will occur fewer than @var{x} times.
19444 The other probability distribution functions similarly take the
19445 form @kbd{k @var{X}} (@code{calc-utp@var{x}}) [@code{utp@var{x}}]
19446 and @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
19448 the random variable first, then whatever other parameters define the
19449 distribution.  Note these are among the few Calc functions where the
19450 order of the arguments in algebraic form differs from the order of
19451 arguments as found on the stack.  (The random variable comes last on
19452 the stack, so that you can type, e.g., @kbd{2 @key{RET} 1 @key{RET} 2.5
19453 k N M-@key{RET} @key{DEL} 2.8 k N -}, using @kbd{M-@key{RET} @key{DEL}} to
19454 recover the original arguments but substitute a new value for @expr{x}.)
19456 @kindex k C
19457 @pindex calc-utpc
19458 @tindex utpc
19459 @ignore
19460 @mindex @idots
19461 @end ignore
19462 @kindex I k C
19463 @ignore
19464 @mindex @null
19465 @end ignore
19466 @tindex ltpc
19467 The @samp{utpc(x,v)} function uses the chi-square distribution with
19468 @texline @math{\nu}
19469 @infoline @expr{v} 
19470 degrees of freedom.  It is the probability that a model is
19471 correct if its chi-square statistic is @expr{x}.
19473 @kindex k F
19474 @pindex calc-utpf
19475 @tindex utpf
19476 @ignore
19477 @mindex @idots
19478 @end ignore
19479 @kindex I k F
19480 @ignore
19481 @mindex @null
19482 @end ignore
19483 @tindex ltpf
19484 The @samp{utpf(F,v1,v2)} function uses the F distribution, used in
19485 various statistical tests.  The parameters 
19486 @texline @math{\nu_1}
19487 @infoline @expr{v1} 
19488 and 
19489 @texline @math{\nu_2}
19490 @infoline @expr{v2}
19491 are the degrees of freedom in the numerator and denominator,
19492 respectively, used in computing the statistic @expr{F}.
19494 @kindex k N
19495 @pindex calc-utpn
19496 @tindex utpn
19497 @ignore
19498 @mindex @idots
19499 @end ignore
19500 @kindex I k N
19501 @ignore
19502 @mindex @null
19503 @end ignore
19504 @tindex ltpn
19505 The @samp{utpn(x,m,s)} function uses a normal (Gaussian) distribution
19506 with mean @expr{m} and standard deviation 
19507 @texline @math{\sigma}.
19508 @infoline @expr{s}.  
19509 It is the probability that such a normal-distributed random variable
19510 would exceed @expr{x}.
19512 @kindex k P
19513 @pindex calc-utpp
19514 @tindex utpp
19515 @ignore
19516 @mindex @idots
19517 @end ignore
19518 @kindex I k P
19519 @ignore
19520 @mindex @null
19521 @end ignore
19522 @tindex ltpp
19523 The @samp{utpp(n,x)} function uses a Poisson distribution with
19524 mean @expr{x}.  It is the probability that @expr{n} or more such
19525 Poisson random events will occur.
19527 @kindex k T
19528 @pindex calc-ltpt
19529 @tindex utpt
19530 @ignore
19531 @mindex @idots
19532 @end ignore
19533 @kindex I k T
19534 @ignore
19535 @mindex @null
19536 @end ignore
19537 @tindex ltpt
19538 The @samp{utpt(t,v)} function uses the Student's ``t'' distribution
19539 with 
19540 @texline @math{\nu}
19541 @infoline @expr{v} 
19542 degrees of freedom.  It is the probability that a
19543 t-distributed random variable will be greater than @expr{t}.
19544 (Note:  This computes the distribution function 
19545 @texline @math{A(t|\nu)}
19546 @infoline @expr{A(t|v)}
19547 where 
19548 @texline @math{A(0|\nu) = 1}
19549 @infoline @expr{A(0|v) = 1} 
19550 and 
19551 @texline @math{A(\infty|\nu) \to 0}.
19552 @infoline @expr{A(inf|v) -> 0}.  
19553 The @code{UTPT} operation on the HP-48 uses a different definition which
19554 returns half of Calc's value:  @samp{UTPT(t,v) = .5*utpt(t,v)}.)
19556 While Calc does not provide inverses of the probability distribution
19557 functions, the @kbd{a R} command can be used to solve for the inverse.
19558 Since the distribution functions are monotonic, @kbd{a R} is guaranteed
19559 to be able to find a solution given any initial guess.
19560 @xref{Numerical Solutions}.
19562 @node Matrix Functions, Algebra, Scientific Functions, Top
19563 @chapter Vector/Matrix Functions
19565 @noindent
19566 Many of the commands described here begin with the @kbd{v} prefix.
19567 (For convenience, the shift-@kbd{V} prefix is equivalent to @kbd{v}.)
19568 The commands usually apply to both plain vectors and matrices; some
19569 apply only to matrices or only to square matrices.  If the argument
19570 has the wrong dimensions the operation is left in symbolic form.
19572 Vectors are entered and displayed using @samp{[a,b,c]} notation.
19573 Matrices are vectors of which all elements are vectors of equal length.
19574 (Though none of the standard Calc commands use this concept, a
19575 three-dimensional matrix or rank-3 tensor could be defined as a
19576 vector of matrices, and so on.)
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
19590 @node Packing and Unpacking, Building Vectors, Matrix Functions, Matrix Functions
19591 @section Packing and Unpacking
19593 @noindent
19594 Calc's ``pack'' and ``unpack'' commands collect stack entries to build
19595 composite objects such as vectors and complex numbers.  They are
19596 described in this chapter because they are most often used to build
19597 vectors.
19599 @kindex v p
19600 @pindex calc-pack
19601 The @kbd{v p} (@code{calc-pack}) [@code{pack}] command collects several
19602 elements from the stack into a matrix, complex number, HMS form, error
19603 form, etc.  It uses a numeric prefix argument to specify the kind of
19604 object to be built; this argument is referred to as the ``packing mode.''
19605 If the packing mode is a nonnegative integer, a vector of that
19606 length is created.  For example, @kbd{C-u 5 v p} will pop the top
19607 five stack elements and push back a single vector of those five
19608 elements.  (@kbd{C-u 0 v p} simply creates an empty vector.)
19610 The same effect can be had by pressing @kbd{[} to push an incomplete
19611 vector on the stack, using @key{TAB} (@code{calc-roll-down}) to sneak
19612 the incomplete object up past a certain number of elements, and
19613 then pressing @kbd{]} to complete the vector.
19615 Negative packing modes create other kinds of composite objects:
19617 @table @cite
19618 @item -1
19619 Two 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
19621 @expr{(5, 7)}.  The result is always a rectangular complex
19622 number.  The two input values must both be real numbers,
19623 i.e., integers, fractions, or floats.  If they are not, Calc
19624 will instead build a formula like @samp{a + (0, 1) b}.  (The
19625 other packing modes also create a symbolic answer if the
19626 components are not suitable.)
19628 @item -2
19629 Two values are collected to build a polar complex number.
19630 The first is the magnitude; the second is the phase expressed
19631 in either degrees or radians according to the current angular
19632 mode.
19634 @item -3
19635 Three values are collected into an HMS form.  The first
19636 two values (hours and minutes) must be integers or
19637 integer-valued floats.  The third value may be any real
19638 number.
19640 @item -4
19641 Two values are collected into an error form.  The inputs
19642 may be real numbers or formulas.
19644 @item -5
19645 Two values are collected into a modulo form.  The inputs
19646 must be real numbers.
19648 @item -6
19649 Two values are collected into the interval @samp{[a .. b]}.
19650 The inputs may be real numbers, HMS or date forms, or formulas.
19652 @item -7
19653 Two values are collected into the interval @samp{[a .. b)}.
19655 @item -8
19656 Two values are collected into the interval @samp{(a .. b]}.
19658 @item -9
19659 Two values are collected into the interval @samp{(a .. b)}.
19661 @item -10
19662 Two integer values are collected into a fraction.
19664 @item -11
19665 Two values are collected into a floating-point number.
19666 The first is the mantissa; the second, which must be an
19667 integer, is the exponent.  The result is the mantissa
19668 times ten to the power of the exponent.
19670 @item -12
19671 This is treated the same as @mathit{-11} by the @kbd{v p} command.
19672 When unpacking, @mathit{-12} specifies that a floating-point mantissa
19673 is desired.
19675 @item -13
19676 A real number is converted into a date form.
19678 @item -14
19679 Three numbers (year, month, day) are packed into a pure date form.
19681 @item -15
19682 Six numbers are packed into a date/time form.
19683 @end table
19685 With any of the two-input negative packing modes, either or both
19686 of the inputs may be vectors.  If both are vectors of the same
19687 length, the result is another vector made by packing corresponding
19688 elements of the input vectors.  If one input is a vector and the
19689 other is a plain number, the number is packed along with each vector
19690 element to produce a new vector.  For example, @kbd{C-u -4 v p}
19691 could be used to convert a vector of numbers and a vector of errors
19692 into a single vector of error forms; @kbd{C-u -5 v p} could convert
19693 a vector of numbers and a single number @var{M} into a vector of
19694 numbers modulo @var{M}.
19696 If you don't give a prefix argument to @kbd{v p}, it takes
19697 the packing mode from the top of the stack.  The elements to
19698 be packed then begin at stack level 2.  Thus
19699 @kbd{1 @key{RET} 2 @key{RET} 4 n v p} is another way to
19700 enter the error form @samp{1 +/- 2}.
19702 If the packing mode taken from the stack is a vector, the result is a
19703 matrix with the dimensions specified by the elements of the vector,
19704 which 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
19706 returned in the form @samp{[@w{[a, b, c]}, [d, e, f]]}.
19708 If any elements of the vector are negative, other kinds of
19709 packing are done at that level as described above.  For
19710 example, @samp{[2, 3, -4]} takes 12 objects and creates a
19711 @texline @math{2\times3}
19712 @infoline 2x3
19713 matrix of error forms: @samp{[[a +/- b, c +/- d ... ]]}.
19714 Also, @samp{[-4, -10]} will convert four integers into an
19715 error form consisting of two fractions:  @samp{a:b +/- c:d}.
19717 @ignore
19718 @starindex
19719 @end ignore
19720 @tindex pack
19721 There is an equivalent algebraic function,
19722 @samp{pack(@var{mode}, @var{items})} where @var{mode} is a
19723 packing mode (an integer or a vector of integers) and @var{items}
19724 is a vector of objects to be packed (re-packed, really) according
19725 to that mode.  For example, @samp{pack([3, -4], [a,b,c,d,e,f])}
19726 yields @samp{[a +/- b, @w{c +/- d}, e +/- f]}.  The function is
19727 left in symbolic form if the packing mode is invalid, or if the
19728 number of data items does not match the number of items required
19729 by the mode.
19731 @kindex v u
19732 @pindex calc-unpack
19733 The @kbd{v u} (@code{calc-unpack}) command takes the vector, complex
19734 number, 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
19736 objects.  Thus, it is the ``inverse'' of @kbd{v p}.  If the value
19737 at the top of the stack is a formula, @kbd{v u} unpacks it by pushing
19738 each of the arguments of the top-level operator onto the stack.
19740 You can optionally give a numeric prefix argument to @kbd{v u}
19741 to specify an explicit (un)packing mode.  If the packing mode is
19742 negative and the input is actually a vector or matrix, the result
19743 will be two or more similar vectors or matrices of the elements.
19744 For example, given the vector @samp{[@w{a +/- b}, c^2, d +/- 7]},
19745 the 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]}}.
19748 Note that the prefix argument can have an effect even when the input is
19749 not 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}
19751 when viewed as a rectangular complex number); @kbd{C-u -2 v u} yields 5
19752 and 180 (assuming Degrees mode); and @kbd{C-u -10 v u} yields @mathit{-5}
19753 and 1 (the numerator and denominator of @mathit{-5}, viewed as a rational
19754 number).  Plain @kbd{v u} with this input would complain that the input
19755 is not a composite object.
19757 Unpacking mode @mathit{-11} converts a float into an integer mantissa and
19758 an integer exponent, where the mantissa is not divisible by 10
19759 (except that 0.0 is represented by a mantissa and exponent of 0).
19760 Unpacking mode @mathit{-12} converts a float into a floating-point mantissa
19761 and integer exponent, where the mantissa (for non-zero numbers)
19762 is guaranteed to lie in the range [1 .. 10).  In both cases,
19763 the mantissa is shifted left or right (and the exponent adjusted
19764 to compensate) in order to satisfy these constraints.
19766 Positive unpacking modes are treated differently than for @kbd{v p}.
19767 A mode of 1 is much like plain @kbd{v u} with no prefix argument,
19768 except that in addition to the components of the input object,
19769 a suitable packing mode to re-pack the object is also pushed.
19770 Thus, @kbd{C-u 1 v u} followed by @kbd{v p} will re-build the
19771 original object.
19773 A mode of 2 unpacks two levels of the object; the resulting
19774 re-packing mode will be a vector of length 2.  This might be used
19775 to unpack a matrix, say, or a vector of error forms.  Higher
19776 unpacking modes unpack the input even more deeply.
19778 @ignore
19779 @starindex
19780 @end ignore
19781 @tindex unpack
19782 There are two algebraic functions analogous to @kbd{v u}.
19783 The @samp{unpack(@var{mode}, @var{item})} function unpacks the
19784 @var{item} using the given @var{mode}, returning the result as
19785 a vector of components.  Here the @var{mode} must be an
19786 integer, not a vector.  For example, @samp{unpack(-4, a +/- b)}
19787 returns @samp{[a, b]}, as does @samp{unpack(1, a +/- b)}.
19789 @ignore
19790 @starindex
19791 @end ignore
19792 @tindex unpackt
19793 The @code{unpackt} function is like @code{unpack} but instead
19794 of returning a simple vector of items, it returns a vector of
19795 two 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]]},
19797 and @samp{unpackt(2, 2:3 +/- 1:4)} returns @samp{[[-4, -10], [2, 3, 1, 4]]}.
19798 The 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
19801 name and a vector of arguments.)
19803 @cindex Numerator of a fraction, extracting
19804 Subscript notation is a useful way to extract a particular part
19805 of an object.  For example, to get the numerator of a rational
19806 number, you can use @samp{unpack(-10, @var{x})_1}.
19808 @node Building Vectors, Extracting Elements, Packing and Unpacking, Matrix Functions
19809 @section Building Vectors
19811 @noindent
19812 Vectors and matrices can be added,
19813 subtracted, multiplied, and divided; @pxref{Basic Arithmetic}.
19815 @kindex |
19816 @pindex calc-concat
19817 @ignore
19818 @mindex @null
19819 @end ignore
19820 @tindex |
19821 The @kbd{|} (@code{calc-concat}) [@code{vconcat}] command ``concatenates'' two vectors
19822 into one.  For example, after @kbd{@w{[ 1 , 2 ]} [ 3 , 4 ] |}, the stack
19823 will contain the single vector @samp{[1, 2, 3, 4]}.  If the arguments
19824 are matrices, the rows of the first matrix are concatenated with the
19825 rows of the second.  (In other words, two matrices are just two vectors
19826 of row-vectors as far as @kbd{|} is concerned.)
19828 If either argument to @kbd{|} is a scalar (a non-vector), it is treated
19829 like a one-element vector for purposes of concatenation:  @kbd{1 [ 2 , 3 ] |}
19830 produces the vector @samp{[1, 2, 3]}.  Likewise, if one argument is a
19831 matrix and the other is a plain vector, the vector is treated as a
19832 one-row matrix.
19834 @kindex H |
19835 @tindex append
19836 The @kbd{H |} (@code{calc-append}) [@code{append}] command concatenates
19837 two vectors without any special cases.  Both inputs must be vectors.
19838 Whether or not they are matrices is not taken into account.  If either
19839 argument is a scalar, the @code{append} function is left in symbolic form.
19840 See also @code{cons} and @code{rcons} below.
19842 @kindex I |
19843 @kindex H I |
19844 The @kbd{I |} and @kbd{H I |} commands are similar, but they use their
19845 two stack arguments in the opposite order.  Thus @kbd{I |} is equivalent
19846 to @kbd{@key{TAB} |}, but possibly more convenient and also a bit faster.
19848 @kindex v d
19849 @pindex calc-diag
19850 @tindex diag
19851 The @kbd{v d} (@code{calc-diag}) [@code{diag}] function builds a diagonal
19852 square matrix.  The optional numeric prefix gives the number of rows
19853 and columns in the matrix.  If the value at the top of the stack is a
19854 vector, the elements of the vector are used as the diagonal elements; the
19855 prefix, if specified, must match the size of the vector.  If the value on
19856 the stack is a scalar, it is used for each element on the diagonal, and
19857 the prefix argument is required.
19859 To build a constant square matrix, e.g., a 
19860 @texline @math{3\times3}
19861 @infoline 3x3
19862 matrix filled with ones, use @kbd{0 M-3 v d 1 +}, i.e., build a zero
19863 matrix first and then add a constant value to that matrix.  (Another
19864 alternative would be to use @kbd{v b} and @kbd{v a}; see below.)
19866 @kindex v i
19867 @pindex calc-ident
19868 @tindex idn
19869 The @kbd{v i} (@code{calc-ident}) [@code{idn}] function builds an identity
19870 matrix of the specified size.  It is a convenient form of @kbd{v d}
19871 where the diagonal element is always one.  If no prefix argument is given,
19872 this command prompts for one.
19874 In algebraic notation, @samp{idn(a,n)} acts much like @samp{diag(a,n)},
19875 except that @expr{a} is required to be a scalar (non-vector) quantity.
19876 If @expr{n} is omitted, @samp{idn(a)} represents @expr{a} times an
19877 identity matrix of unknown size.  Calc can operate algebraically on
19878 such generic identity matrices, and if one is combined with a matrix
19879 whose size is known, it is converted automatically to an identity
19880 matrix of a suitable matching size.  The @kbd{v i} command with an
19881 argument of zero creates a generic identity matrix, @samp{idn(1)}.
19882 Note that in dimensioned Matrix mode (@pxref{Matrix Mode}), generic
19883 identity matrices are immediately expanded to the current default
19884 dimensions.
19886 @kindex v x
19887 @pindex calc-index
19888 @tindex index
19889 The @kbd{v x} (@code{calc-index}) [@code{index}] function builds a vector
19890 of consecutive integers from 1 to @var{n}, where @var{n} is the numeric
19891 prefix argument.  If you do not provide a prefix argument, you will be
19892 prompted to enter a suitable number.  If @var{n} is negative, the result
19893 is a vector of negative integers from @var{n} to @mathit{-1}.
19895 With a prefix argument of just @kbd{C-u}, the @kbd{v x} command takes
19896 three 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
19898 by @var{incr} for successive vector elements.  If @var{start} or @var{n}
19899 is in floating-point format, the resulting vector elements will also be
19900 floats.  Note that @var{start} and @var{incr} may in fact be any kind
19901 of numbers or formulas.
19903 When @var{start} and @var{incr} are specified, a negative @var{n} has a
19904 different interpretation:  It causes a geometric instead of arithmetic
19905 sequence 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}
19908 is one for positive @var{n} or two for negative @var{n}.
19910 @kindex v b
19911 @pindex calc-build-vector
19912 @tindex cvec
19913 The @kbd{v b} (@code{calc-build-vector}) [@code{cvec}] function builds a
19914 vector of @var{n} copies of the value on the top of the stack, where @var{n}
19915 is the numeric prefix argument.  In algebraic formulas, @samp{cvec(x,n,m)}
19916 can 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
19918 to build a matrix of copies of that row.)
19920 @kindex v h
19921 @kindex I v h
19922 @pindex calc-head
19923 @pindex calc-tail
19924 @tindex head
19925 @tindex tail
19926 The @kbd{v h} (@code{calc-head}) [@code{head}] function returns the first
19927 element of a vector.  The @kbd{I v h} (@code{calc-tail}) [@code{tail}]
19928 function returns the vector with its first element removed.  In both
19929 cases, the argument must be a non-empty vector.
19931 @kindex v k
19932 @pindex calc-cons
19933 @tindex cons
19934 The @kbd{v k} (@code{calc-cons}) [@code{cons}] function takes a value @var{h}
19935 and 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
19937 if @var{h} is itself a vector, @kbd{|} will concatenate the two vectors
19938 whereas @code{cons} will insert @var{h} at the front of the vector @var{t}.
19940 @kindex H v h
19941 @tindex rhead
19942 @ignore
19943 @mindex @idots
19944 @end ignore
19945 @kindex H I v h
19946 @ignore
19947 @mindex @null
19948 @end ignore
19949 @kindex H v k
19950 @ignore
19951 @mindex @null
19952 @end ignore
19953 @tindex rtail
19954 @ignore
19955 @mindex @null
19956 @end ignore
19957 @tindex rcons
19958 Each of these three functions also accepts the Hyperbolic flag [@code{rhead},
19959 @code{rtail}, @code{rcons}] in which case @var{t} instead represents
19960 the @emph{last} single element of the vector, with @var{h}
19961 representing the remainder of the vector.  Thus the vector
19962 @samp{[a, b, c, d] = cons(a, [b, c, d]) = rcons([a, b, c], d)}.
19963 Also, @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}.
19966 @node Extracting Elements, Manipulating Vectors, Building Vectors, Matrix Functions
19967 @section Extracting Vector Elements
19969 @noindent
19970 @kindex v r
19971 @pindex calc-mrow
19972 @tindex mrow
19973 The @kbd{v r} (@code{calc-mrow}) [@code{mrow}] command extracts one row of
19974 the matrix on the top of the stack, or one element of the plain vector on
19975 the top of the stack.  The row or element is specified by the numeric
19976 prefix argument; the default is to prompt for the row or element number.
19977 The matrix or vector is replaced by the specified row or element in the
19978 form of a vector or scalar, respectively.
19980 @cindex Permutations, applying
19981 With a prefix argument of @kbd{C-u} only, @kbd{v r} takes the index of
19982 the element or row from the top of the stack, and the vector or matrix
19983 from the second-to-top position.  If the index is itself a vector of
19984 integers, the result is a vector of the corresponding elements of the
19985 input vector, or a matrix of the corresponding rows of the input matrix.
19986 This command can be used to obtain any permutation of a vector.
19988 With @kbd{C-u}, if the index is an interval form with integer components,
19989 it is interpreted as a range of indices and the corresponding subvector or
19990 submatrix is returned.
19992 @cindex Subscript notation
19993 @kindex a _
19994 @pindex calc-subscript
19995 @tindex subscr
19996 @tindex _
19997 Subscript notation in algebraic formulas (@samp{a_b}) stands for the
19998 Calc function @code{subscr}, which is synonymous with @code{mrow}.
19999 Thus, @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
20001 (@samp{M_i_j}, equivalent to @samp{subscr(subscr(M, i), j)}) will
20002 access the element at row @expr{i}, column @expr{j} of a matrix.
20003 The @kbd{a _} (@code{calc-subscript}) command creates a subscript
20004 formula @samp{a_b} out of two stack entries.  (It is on the @kbd{a}
20005 ``algebra'' prefix because subscripted variables are often used
20006 purely as an algebraic notation.)
20008 @tindex mrrow
20009 Given a negative prefix argument, @kbd{v r} instead deletes one row or
20010 element 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}
20012 replaces the matrix with the same matrix with its second row removed.
20013 In algebraic form this function is called @code{mrrow}.
20015 @tindex getdiag
20016 Given a prefix argument of zero, @kbd{v r} extracts the diagonal elements
20017 of a square matrix in the form of a vector.  In algebraic form this
20018 function is called @code{getdiag}.
20020 @kindex v c
20021 @pindex calc-mcol
20022 @tindex mcol
20023 @tindex mrcol
20024 The @kbd{v c} (@code{calc-mcol}) [@code{mcol} or @code{mrcol}] command is
20025 the analogous operation on columns of a matrix.  Given a plain vector
20026 it extracts (or removes) one element, just like @kbd{v r}.  If the
20027 index in @kbd{C-u v c} is an interval or vector and the argument is a
20028 matrix, the result is a submatrix with only the specified columns
20029 retained (and possibly permuted in the case of a vector index).
20031 To extract a matrix element at a given row and column, use @kbd{v r} to
20032 extract the row as a vector, then @kbd{v c} to extract the column element
20033 from that vector.  In algebraic formulas, it is often more convenient to
20034 use subscript notation:  @samp{m_i_j} gives row @expr{i}, column @expr{j}
20035 of matrix @expr{m}.
20037 @kindex v s
20038 @pindex calc-subvector
20039 @tindex subvec
20040 The @kbd{v s} (@code{calc-subvector}) [@code{subvec}] command extracts
20041 a subvector of a vector.  The arguments are the vector, the starting
20042 index, and the ending index, with the ending index in the top-of-stack
20043 position.  The starting index indicates the first element of the vector
20044 to take.  The ending index indicates the first element @emph{past} the
20045 range to be taken.  Thus, @samp{subvec([a, b, c, d, e], 2, 4)} produces
20046 the subvector @samp{[b, c]}.  You could get the same result using
20047 @samp{mrow([a, b, c, d, e], @w{[2 .. 4)})}.
20049 If either the start or the end index is zero or negative, it is
20050 interpreted 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
20052 the algebraic form, the end index can be omitted in which case it
20053 is taken as zero, i.e., elements from the starting element to the
20054 end of the vector are used.  The infinity symbol, @code{inf}, also
20055 has this effect when used as the ending index.
20057 @kindex I v s
20058 @tindex rsubvec
20059 With the Inverse flag, @kbd{I v s} [@code{rsubvec}] removes a subvector
20060 from a vector.  The arguments are interpreted the same as for the
20061 normal @kbd{v s} command.  Thus, @samp{rsubvec([a, b, c, d, e], 2, 4)}
20062 produces @samp{[a, d, e]}.  It is always true that @code{subvec} and
20063 @code{rsubvec} return complementary parts of the input vector.
20065 @xref{Selecting Subformulas}, for an alternative way to operate on
20066 vectors one element at a time.
20068 @node Manipulating Vectors, Vector and Matrix Arithmetic, Extracting Elements, Matrix Functions
20069 @section Manipulating Vectors
20071 @noindent
20072 @kindex v l
20073 @pindex calc-vlength
20074 @tindex vlen
20075 The @kbd{v l} (@code{calc-vlength}) [@code{vlen}] command computes the
20076 length of a vector.  The length of a non-vector is considered to be zero.
20077 Note that matrices are just vectors of vectors for the purposes of this
20078 command.
20080 @kindex H v l
20081 @tindex mdims
20082 With the Hyperbolic flag, @kbd{H v l} [@code{mdims}] computes a vector
20083 of the dimensions of a vector, matrix, or higher-order object.  For
20084 example, @samp{mdims([[a,b,c],[d,e,f]])} returns @samp{[2, 3]} since
20085 its argument is a 
20086 @texline @math{2\times3}
20087 @infoline 2x3
20088 matrix.
20090 @kindex v f
20091 @pindex calc-vector-find
20092 @tindex find
20093 The @kbd{v f} (@code{calc-vector-find}) [@code{find}] command searches
20094 along a vector for the first element equal to a given target.  The target
20095 is on the top of the stack; the vector is in the second-to-top position.
20096 If a match is found, the result is the index of the matching element.
20097 Otherwise, the result is zero.  The numeric prefix argument, if given,
20098 allows you to select any starting index for the search.
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
20106 The @kbd{v a} (@code{calc-arrange-vector}) [@code{arrange}] command
20107 rearranges a vector to have a certain number of columns and rows.  The
20108 numeric prefix argument specifies the number of columns; if you do not
20109 provide an argument, you will be prompted for the number of columns.
20110 The vector or matrix on the top of the stack is @dfn{flattened} into a
20111 plain vector.  If the number of columns is nonzero, this vector is
20112 then formed into a matrix by taking successive groups of @var{n} elements.
20113 If the number of columns does not evenly divide the number of elements
20114 in the vector, the last row will be short and the result will not be
20115 suitable 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
20117 @samp{[[1, 2, 3, 4]]} (a 
20118 @texline @math{1\times4}
20119 @infoline 1x4
20120 matrix), @kbd{v a 1} produces @samp{[[1], [2], [3], [4]]} (a 
20121 @texline @math{4\times1}
20122 @infoline 4x1
20123 matrix), @kbd{v a 2} produces @samp{[[1, 2], [3, 4]]} (the original 
20124 @texline @math{2\times2}
20125 @infoline 2x2
20126 matrix), @w{@kbd{v a 3}} produces @samp{[[1, 2, 3], [4]]} (not a
20127 matrix), and @kbd{v a 0} produces the flattened list 
20128 @samp{[1, 2, @w{3, 4}]}.
20130 @cindex Sorting data
20131 @kindex V S
20132 @kindex I V S
20133 @pindex calc-sort
20134 @tindex sort
20135 @tindex rsort
20136 The @kbd{V S} (@code{calc-sort}) [@code{sort}] command sorts the elements of
20137 a vector into increasing order.  Real numbers, real infinities, and
20138 constant interval forms come first in this ordering; next come other
20139 kinds of numbers, then variables (in alphabetical order), then finally
20140 come formulas and other kinds of objects; these are sorted according
20141 to a kind of lexicographic ordering with the useful property that
20142 one vector is less or greater than another if the first corresponding
20143 unequal elements are less or greater, respectively.  Since quoted strings
20144 are stored by Calc internally as vectors of ASCII character codes
20145 (@pxref{Strings}), this means vectors of strings are also sorted into
20146 alphabetical order by this command.
20148 The @kbd{I V S} [@code{rsort}] command sorts a vector into decreasing order.
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
20159 The @kbd{V G} (@code{calc-grade}) [@code{grade}, @code{rgrade}] command
20160 produces an index table or permutation vector which, if applied to the
20161 input vector (as the index of @kbd{C-u v r}, say), would sort the vector.
20162 A permutation vector is just a vector of integers from 1 to @var{n}, where
20163 each integer occurs exactly once.  One application of this is to sort a
20164 matrix of data rows using one column as the sort key; extract that column,
20165 grade it with @kbd{V G}, then use the result to reorder the original matrix
20166 with @kbd{C-u v r}.  Another interesting property of the @code{V G} command
20167 is that, if the input is itself a permutation vector, the result will
20168 be the inverse of the permutation.  The inverse of an index table is
20169 a rank table, whose @var{k}th element says where the @var{k}th original
20170 vector element will rest when the vector is sorted.  To get a rank
20171 table, just use @kbd{V G V G}.
20173 With the Inverse flag, @kbd{I V G} produces an index table that would
20174 sort the input into decreasing order.  Note that @kbd{V S} and @kbd{V G}
20175 use a ``stable'' sorting algorithm, i.e., any two elements which are equal
20176 will not be moved out of their original order.  Generally there is no way
20177 to tell with @kbd{V S}, since two elements which are equal look the same,
20178 but with @kbd{V G} this can be an important issue.  In the matrix-of-rows
20179 example, suppose you have names and telephone numbers as two columns and
20180 you wish to sort by phone number primarily, and by name when the numbers
20181 are equal.  You can sort the data matrix by names first, and then again
20182 by phone numbers.  Because the sort is stable, any two rows with equal
20183 phone numbers will remain sorted by name even after the second sort.
20185 @cindex Histograms
20186 @kindex V H
20187 @pindex calc-histogram
20188 @ignore
20189 @mindex histo@idots
20190 @end ignore
20191 @tindex histogram
20192 The @kbd{V H} (@code{calc-histogram}) [@code{histogram}] command builds a
20193 histogram of a vector of numbers.  Vector elements are assumed to be
20194 integers or real numbers in the range [0..@var{n}) for some ``number of
20195 bins'' @var{n}, which is the numeric prefix argument given to the
20196 command.  The result is a vector of @var{n} counts of how many times
20197 each value appeared in the original vector.  Non-integers in the input
20198 are rounded down to integers.  Any vector elements outside the specified
20199 range are ignored.  (You can tell if elements have been ignored by noting
20200 that the counts in the result vector don't add up to the length of the
20201 input vector.)
20203 @kindex H V H
20204 With the Hyperbolic flag, @kbd{H V H} pulls two vectors from the stack.
20205 The second-to-top vector is the list of numbers as before.  The top
20206 vector is an equal-sized list of ``weights'' to attach to the elements
20207 of the data vector.  For example, if the first data element is 4.2 and
20208 the first weight is 10, then 10 will be added to bin 4 of the result
20209 vector.  Without the hyperbolic flag, every element has a weight of one.
20211 @kindex v t
20212 @pindex calc-transpose
20213 @tindex trn
20214 The @kbd{v t} (@code{calc-transpose}) [@code{trn}] command computes
20215 the transpose of the matrix at the top of the stack.  If the argument
20216 is a plain vector, it is treated as a row vector and transposed into
20217 a one-column matrix.
20219 @kindex v v
20220 @pindex calc-reverse-vector
20221 @tindex rev
20222 The @kbd{v v} (@code{calc-reverse-vector}) [@code{rev}] command reverses
20223 a 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
20225 principle can be used to apply other vector commands to the columns of
20226 a matrix.)
20228 @kindex v m
20229 @pindex calc-mask-vector
20230 @tindex vmask
20231 The @kbd{v m} (@code{calc-mask-vector}) [@code{vmask}] command uses
20232 one vector as a mask to extract elements of another vector.  The mask
20233 is in the second-to-top position; the target vector is on the top of
20234 the stack.  These vectors must have the same length.  The result is
20235 the same as the target vector, but with all elements which correspond
20236 to 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}.
20240 @kindex v e
20241 @pindex calc-expand-vector
20242 @tindex vexp
20243 The @kbd{v e} (@code{calc-expand-vector}) [@code{vexp}] command
20244 expands a vector according to another mask vector.  The result is a
20245 vector the same length as the mask, but with nonzero elements replaced
20246 by successive elements from the target vector.  The length of the target
20247 vector is normally the number of nonzero elements in the mask.  If the
20248 target vector is longer, its last few elements are lost.  If the target
20249 vector is shorter, the last few nonzero mask elements are left
20250 unreplaced in the result.  Thus @samp{vexp([2, 0, 3, 0, 7], [a, b])}
20251 produces @samp{[a, 0, b, 0, 7]}.
20253 @kindex H v e
20254 With the Hyperbolic flag, @kbd{H v e} takes a filler value from the
20255 top of the stack; the mask and target vectors come from the third and
20256 second elements of the stack.  This filler is used where the mask is
20257 zero:  @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,
20259 then successive values are taken from it, so that the effect is to
20260 interleave 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]}.
20264 Another variation on the masking idea is to combine @samp{[a, b, c, d, e]}
20265 with the mask @samp{[1, 0, 1, 0, 1]} to produce @samp{[a, 0, c, 0, e]}.
20266 You can accomplish this with @kbd{V M a &}, mapping the logical ``and''
20267 operation across the two vectors.  @xref{Logical Operations}.  Note that
20268 the @code{? :} operation also discussed there allows other types of
20269 masking using vectors.
20271 @node Vector and Matrix Arithmetic, Set Operations, Manipulating Vectors, Matrix Functions
20272 @section Vector and Matrix Arithmetic
20274 @noindent
20275 Basic arithmetic operations like addition and multiplication are defined
20276 for vectors and matrices as well as for numbers.  Division of matrices, in
20277 the sense of multiplying by the inverse, is supported.  (Division by a
20278 matrix actually uses LU-decomposition for greater accuracy and speed.)
20279 @xref{Basic Arithmetic}.
20281 The following functions are applied element-wise if their arguments are
20282 vectors or matrices: @code{change-sign}, @code{conj}, @code{arg},
20283 @code{re}, @code{im}, @code{polar}, @code{rect}, @code{clean},
20284 @code{float}, @code{frac}.  @xref{Function Index}.
20286 @kindex V J
20287 @pindex calc-conj-transpose
20288 @tindex ctrn
20289 The @kbd{V J} (@code{calc-conj-transpose}) [@code{ctrn}] command computes
20290 the conjugate transpose of its argument, i.e., @samp{conj(trn(x))}.
20292 @ignore
20293 @mindex A
20294 @end ignore
20295 @kindex A (vectors)
20296 @pindex calc-abs (vectors)
20297 @ignore
20298 @mindex abs
20299 @end ignore
20300 @tindex abs (vectors)
20301 The @kbd{A} (@code{calc-abs}) [@code{abs}] command computes the
20302 Frobenius norm of a vector or matrix argument.  This is the square
20303 root of the sum of the squares of the absolute values of the
20304 elements of the vector or matrix.  If the vector is interpreted as
20305 a point in two- or three-dimensional space, this is the distance
20306 from that point to the origin.
20308 @kindex v n
20309 @pindex calc-rnorm
20310 @tindex rnorm
20311 The @kbd{v n} (@code{calc-rnorm}) [@code{rnorm}] command computes
20312 the row norm, or infinity-norm, of a vector or matrix.  For a plain
20313 vector, this is the maximum of the absolute values of the elements.
20314 For a matrix, this is the maximum of the row-absolute-value-sums,
20315 i.e., of the sums of the absolute values of the elements along the
20316 various rows.
20318 @kindex V N
20319 @pindex calc-cnorm
20320 @tindex cnorm
20321 The @kbd{V N} (@code{calc-cnorm}) [@code{cnorm}] command computes
20322 the column norm, or one-norm, of a vector or matrix.  For a plain
20323 vector, this is the sum of the absolute values of the elements.
20324 For a matrix, this is the maximum of the column-absolute-value-sums.
20325 General @expr{k}-norms for @expr{k} other than one or infinity are
20326 not provided.
20328 @kindex V C
20329 @pindex calc-cross
20330 @tindex cross
20331 The @kbd{V C} (@code{calc-cross}) [@code{cross}] command computes the
20332 right-handed cross product of two vectors, each of which must have
20333 exactly three elements.
20335 @ignore
20336 @mindex &
20337 @end ignore
20338 @kindex & (matrices)
20339 @pindex calc-inv (matrices)
20340 @ignore
20341 @mindex inv
20342 @end ignore
20343 @tindex inv (matrices)
20344 The @kbd{&} (@code{calc-inv}) [@code{inv}] command computes the
20345 inverse of a square matrix.  If the matrix is singular, the inverse
20346 operation is left in symbolic form.  Matrix inverses are recorded so
20347 that once an inverse (or determinant) of a particular matrix has been
20348 computed, the inverse and determinant of the matrix can be recomputed
20349 quickly in the future.
20351 If the argument to @kbd{&} is a plain number @expr{x}, this
20352 command simply computes @expr{1/x}.  This is okay, because the
20353 @samp{/} operator also does a matrix inversion when dividing one
20354 by a matrix.
20356 @kindex V D
20357 @pindex calc-mdet
20358 @tindex det
20359 The @kbd{V D} (@code{calc-mdet}) [@code{det}] command computes the
20360 determinant of a square matrix.
20362 @kindex V L
20363 @pindex calc-mlud
20364 @tindex lud
20365 The @kbd{V L} (@code{calc-mlud}) [@code{lud}] command computes the
20366 LU decomposition of a matrix.  The result is a list of three matrices
20367 which, when multiplied together left-to-right, form the original matrix.
20368 The first is a permutation matrix that arises from pivoting in the
20369 algorithm, the second is lower-triangular with ones on the diagonal,
20370 and the third is upper-triangular.
20372 @kindex V T
20373 @pindex calc-mtrace
20374 @tindex tr
20375 The @kbd{V T} (@code{calc-mtrace}) [@code{tr}] command computes the
20376 trace of a square matrix.  This is defined as the sum of the diagonal
20377 elements of the matrix.
20379 @node Set Operations, Statistical Operations, Vector and Matrix Arithmetic, Matrix Functions
20380 @section Set Operations using Vectors
20382 @noindent
20383 @cindex Sets, as vectors
20384 Calc includes several commands which interpret vectors as @dfn{sets} of
20385 objects.  A set is a collection of objects; any given object can appear
20386 only once in the set.  Calc stores sets as vectors of objects in
20387 sorted order.  Objects in a Calc set can be any of the usual things,
20388 such as numbers, variables, or formulas.  Two set elements are considered
20389 equal if they are identical, except that numerically equal numbers like
20390 the integer 4 and the float 4.0 are considered equal even though they
20391 are not ``identical.''  Variables are treated like plain symbols without
20392 attached values by the set operations; subtracting the set @samp{[b]}
20393 from @samp{[a, b]} always yields the set @samp{[a]} even though if
20394 the variables @samp{a} and @samp{b} both equaled 17, you might
20395 expect the answer @samp{[]}.
20397 If a set contains interval forms, then it is assumed to be a set of
20398 real numbers.  In this case, all set operations require the elements
20399 of the set to be only things that are allowed in intervals:  Real
20400 numbers, plus and minus infinity, HMS forms, and date forms.  If
20401 there are variables or other non-real objects present in a real set,
20402 all set operations on it will be left in unevaluated form.
20404 If 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}]}.
20406 The result is always a vector, except that if the set consists of a
20407 single interval, the interval itself is returned instead.
20409 @xref{Logical Operations}, for the @code{in} function which tests if
20410 a certain value is a member of a given set.  To test if the set @expr{A}
20411 is a subset of the set @expr{B}, use @samp{vdiff(A, B) = []}.
20413 @kindex V +
20414 @pindex calc-remove-duplicates
20415 @tindex rdup
20416 The @kbd{V +} (@code{calc-remove-duplicates}) [@code{rdup}] command
20417 converts an arbitrary vector into set notation.  It works by sorting
20418 the 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
20420 reduced to @samp{[4, 5, a]}).  Overlapping intervals are merged as
20421 necessary.  You rarely need to use @kbd{V +} explicitly, since all the
20422 other set-based commands apply @kbd{V +} to their inputs before using
20423 them.
20425 @kindex V V
20426 @pindex calc-set-union
20427 @tindex vunion
20428 The @kbd{V V} (@code{calc-set-union}) [@code{vunion}] command computes
20429 the union of two sets.  An object is in the union of two sets if and
20430 only if it is in either (or both) of the input sets.  (You could
20431 accomplish the same thing by concatenating the sets with @kbd{|},
20432 then using @kbd{V +}.)
20434 @kindex V ^
20435 @pindex calc-set-intersect
20436 @tindex vint
20437 The @kbd{V ^} (@code{calc-set-intersect}) [@code{vint}] command computes
20438 the intersection of two sets.  An object is in the intersection if
20439 and only if it is in both of the input sets.  Thus if the input
20440 sets are disjoint, i.e., if they share no common elements, the result
20441 will be the empty vector @samp{[]}.  Note that the characters @kbd{V}
20442 and @kbd{^} were chosen to be close to the conventional mathematical
20443 notation for set 
20444 @texline union@tie{}(@math{A \cup B})
20445 @infoline union
20446 and 
20447 @texline intersection@tie{}(@math{A \cap B}).
20448 @infoline intersection.
20450 @kindex V -
20451 @pindex calc-set-difference
20452 @tindex vdiff
20453 The @kbd{V -} (@code{calc-set-difference}) [@code{vdiff}] command computes
20454 the difference between two sets.  An object is in the difference
20455 @expr{A - B} if and only if it is in @expr{A} but not in @expr{B}.
20456 Thus 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
20458 as a general @dfn{set complement} operator; if @expr{A} is the set of
20459 all possible values, then @expr{A - B} is the ``complement'' of @expr{B}.
20460 Obviously this is only practical if the set of all possible values in
20461 your problem is small enough to list in a Calc vector (or simple
20462 enough to express in a few intervals).
20464 @kindex V X
20465 @pindex calc-set-xor
20466 @tindex vxor
20467 The @kbd{V X} (@code{calc-set-xor}) [@code{vxor}] command computes
20468 the ``exclusive-or,'' or ``symmetric difference'' of two sets.
20469 An object is in the symmetric difference of two sets if and only
20470 if it is in one, but @emph{not} both, of the sets.  Objects that
20471 occur in both sets ``cancel out.''
20473 @kindex V ~
20474 @pindex calc-set-complement
20475 @tindex vcompl
20476 The @kbd{V ~} (@code{calc-set-complement}) [@code{vcompl}] command
20477 computes the complement of a set with respect to the real numbers.
20478 Thus @samp{vcompl(x)} is equivalent to @samp{vdiff([-inf .. inf], x)}.
20479 For example, @samp{vcompl([2, (3 .. 4]])} evaluates to
20480 @samp{[[-inf .. 2), (2 .. 3], (4 .. inf]]}.
20482 @kindex V F
20483 @pindex calc-set-floor
20484 @tindex vfloor
20485 The @kbd{V F} (@code{calc-set-floor}) [@code{vfloor}] command
20486 reinterprets a set as a set of integers.  Any non-integer values,
20487 and intervals that do not enclose any integers, are removed.  Open
20488 intervals are converted to equivalent closed intervals.  Successive
20489 integers are converted into intervals of integers.  For example, the
20490 complement of the set @samp{[2, 6, 7, 8]} is messy, but if you wanted
20491 the 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]]}.
20494 @kindex V E
20495 @pindex calc-set-enumerate
20496 @tindex venum
20497 The @kbd{V E} (@code{calc-set-enumerate}) [@code{venum}] command
20498 converts a set of integers into an explicit vector.  Intervals in
20499 the set are expanded out to lists of all integers encompassed by
20500 the intervals.  This only works for finite sets (i.e., sets which
20501 do not involve @samp{-inf} or @samp{inf}).
20503 @kindex V :
20504 @pindex calc-set-span
20505 @tindex vspan
20506 The @kbd{V :} (@code{calc-set-span}) [@code{vspan}] command converts any
20507 set of reals into an interval form that encompasses all its elements.
20508 The lower limit will be the smallest element in the set; the upper
20509 limit will be the largest element.  For an empty set, @samp{vspan([])}
20510 returns the empty interval @w{@samp{[0 .. 0)}}.
20512 @kindex V #
20513 @pindex calc-set-cardinality
20514 @tindex vcard
20515 The @kbd{V #} (@code{calc-set-cardinality}) [@code{vcard}] command counts
20516 the number of integers in a set.  The result is the length of the vector
20517 that would be produced by @kbd{V E}, although the computation is much
20518 more efficient than actually producing that vector.
20520 @cindex Sets, as binary numbers
20521 Another representation for sets that may be more appropriate in some
20522 cases is binary numbers.  If you are dealing with sets of integers
20523 in the range 0 to 49, you can use a 50-bit binary number where a
20524 particular bit is 1 if the corresponding element is in the set.
20525 @xref{Binary Functions}, for a list of commands that operate on
20526 binary numbers.  Note that many of the above set operations have
20527 direct 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}),
20530 respectively.  You can use whatever representation for sets is most
20531 convenient to you.
20533 @kindex b p
20534 @kindex b u
20535 @pindex calc-pack-bits
20536 @pindex calc-unpack-bits
20537 @tindex vpack
20538 @tindex vunpack
20539 The @kbd{b u} (@code{calc-unpack-bits}) [@code{vunpack}] command
20540 converts an integer that represents a set in binary into a set
20541 in vector/interval notation.  For example, @samp{vunpack(67)}
20542 returns @samp{[[0 .. 1], 6]}.  If the input is negative, the set
20543 it represents is semi-infinite: @samp{vunpack(-4) = [2 .. inf)}.
20544 Use @kbd{V E} afterwards to expand intervals to individual
20545 values if you wish.  Note that this command uses the @kbd{b}
20546 (binary) prefix key.
20548 The @kbd{b p} (@code{calc-pack-bits}) [@code{vpack}] command
20549 converts the other way, from a vector or interval representing
20550 a set of nonnegative integers into a binary integer describing
20551 the same set.  The set may include positive infinity, but must
20552 not include any negative numbers.  The input is interpreted as a
20553 set of integers in the sense of @kbd{V F} (@code{vfloor}).  Beware
20554 that a simple input like @samp{[100]} can result in a huge integer
20555 representation 
20556 @texline (@math{2^{100}}, a 31-digit integer, in this case).
20557 @infoline (@expr{2^100}, a 31-digit integer, in this case).
20559 @node Statistical Operations, Reducing and Mapping, Set Operations, Matrix Functions
20560 @section Statistical Operations on Vectors
20562 @noindent
20563 @cindex Statistical functions
20564 The commands in this section take vectors as arguments and compute
20565 various statistical measures on the data stored in the vectors.  The
20566 references used in the definitions of these functions are Bevington's
20567 @emph{Data Reduction and Error Analysis for the Physical Sciences},
20568 and @emph{Numerical Recipes} by Press, Flannery, Teukolsky and
20569 Vetterling.
20571 The statistical commands use the @kbd{u} prefix key followed by
20572 a shifted letter or other character.
20574 @xref{Manipulating Vectors}, for a description of @kbd{V H}
20575 (@code{calc-histogram}).
20577 @xref{Curve Fitting}, for the @kbd{a F} command for doing
20578 least-squares fits to statistical data.
20580 @xref{Probability Distribution Functions}, for several common
20581 probability distribution functions.
20583 @menu
20584 * Single-Variable Statistics::
20585 * Paired-Sample Statistics::
20586 @end menu
20588 @node Single-Variable Statistics, Paired-Sample Statistics, Statistical Operations, Statistical Operations
20589 @subsection Single-Variable Statistics
20591 @noindent
20592 These functions do various statistical computations on single
20593 vectors.  Given a numeric prefix argument, they actually pop
20594 @var{n} objects from the stack and combine them into a data
20595 vector.  Each object may be either a number or a vector; if a
20596 vector, any sub-vectors inside it are ``flattened'' as if by
20597 @kbd{v a 0}; @pxref{Manipulating Vectors}.  By default one object
20598 is popped, which (in order to be useful) is usually a vector.
20600 If an argument is a variable name, and the value stored in that
20601 variable is a vector, then the stored vector is used.  This method
20602 has the advantage that if your data vector is large, you can avoid
20603 the slow process of manipulating it directly on the stack.
20605 These functions are left in symbolic form if any of their arguments
20606 are not numbers or vectors, e.g., if an argument is a formula, or
20607 a non-vector variable.  However, formulas embedded within vector
20608 arguments are accepted; the result is a symbolic representation
20609 of the computation, based on the assumption that the formula does
20610 not itself represent a vector.  All varieties of numbers such as
20611 error forms and interval forms are acceptable.
20613 Some of the functions in this section also accept a single error form
20614 or interval as an argument.  They then describe a property of the
20615 normal or uniform (respectively) statistical distribution described
20616 by the argument.  The arguments are interpreted in the same way as
20617 the @var{M} argument of the random number function @kbd{k r}.  In
20618 particular, an interval with integer limits is considered an integer
20619 distribution, so that @samp{[2 .. 6)} is the same as @samp{[2 .. 5]}.
20620 An interval with at least one floating-point limit is a continuous
20621 distribution:  @samp{[2.0 .. 6.0)} is @emph{not} the same as
20622 @samp{[2.0 .. 5.0]}!
20624 @kindex u #
20625 @pindex calc-vector-count
20626 @tindex vcount
20627 The @kbd{u #} (@code{calc-vector-count}) [@code{vcount}] command
20628 computes the number of data values represented by the inputs.
20629 For example, @samp{vcount(1, [2, 3], [[4, 5], [], x, y])} returns 7.
20630 If the argument is a single vector with no sub-vectors, this
20631 simply computes the length of the vector.
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)
20640 The @kbd{u +} (@code{calc-vector-sum}) [@code{vsum}] command
20641 computes the sum of the data values.  The @kbd{u *}
20642 (@code{calc-vector-prod}) [@code{vprod}] command computes the
20643 product of the data values.  If the input is a single flat vector,
20644 these are the same as @kbd{V R +} and @kbd{V R *}
20645 (@pxref{Reducing and Mapping}).
20647 @kindex u X
20648 @kindex u N
20649 @pindex calc-vector-max
20650 @pindex calc-vector-min
20651 @tindex vmax
20652 @tindex vmin
20653 The @kbd{u X} (@code{calc-vector-max}) [@code{vmax}] command
20654 computes the maximum of the data values, and the @kbd{u N}
20655 (@code{calc-vector-min}) [@code{vmin}] command computes the minimum.
20656 If the argument is an interval, this finds the minimum or maximum
20657 value in the interval.  (Note that @samp{vmax([2..6)) = 5} as
20658 described above.)  If the argument is an error form, this returns
20659 plus or minus infinity.
20661 @kindex u M
20662 @pindex calc-vector-mean
20663 @tindex vmean
20664 @cindex Mean of data values
20665 The @kbd{u M} (@code{calc-vector-mean}) [@code{vmean}] command
20666 computes the average (arithmetic mean) of the data values.
20667 If the inputs are error forms 
20668 @texline @math{x \pm \sigma},
20669 @infoline @samp{x +/- s}, 
20670 this is the weighted mean of the @expr{x} values with weights 
20671 @texline @math{1 /\sigma^2}.
20672 @infoline @expr{1 / s^2}.
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
20678 If the inputs are not error forms, this is simply the sum of the
20679 values divided by the count of the values.
20681 Note that a plain number can be considered an error form with
20682 error 
20683 @texline @math{\sigma = 0}.
20684 @infoline @expr{s = 0}.  
20685 If the input to @kbd{u M} is a mixture of
20686 plain numbers and error forms, the result is the mean of the
20687 plain numbers, ignoring all values with non-zero errors.  (By the
20688 above definitions it's clear that a plain number effectively
20689 has an infinite weight, next to which an error form with a finite
20690 weight is completely negligible.)
20692 This function also works for distributions (error forms or
20693 intervals).  The mean of an error form `@var{a} @tfn{+/-} @var{b}' is simply
20694 @expr{a}.  The mean of an interval is the mean of the minimum
20695 and maximum values of the interval.
20697 @kindex I u M
20698 @pindex calc-vector-mean-error
20699 @tindex vmeane
20700 The @kbd{I u M} (@code{calc-vector-mean-error}) [@code{vmeane}]
20701 command computes the mean of the data points expressed as an
20702 error form.  This includes the estimated error associated with
20703 the mean.  If the inputs are error forms, the error is the square
20704 root of the reciprocal of the sum of the reciprocals of the squares
20705 of the input errors.  (I.e., the variance is the reciprocal of the
20706 sum 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
20711 If the inputs are plain
20712 numbers, the error is equal to the standard deviation of the values
20713 divided by the square root of the number of values.  (This works
20714 out to be equivalent to calculating the standard deviation and
20715 then assuming each value's error is equal to this standard
20716 deviation.)
20717 @tex
20718 \turnoffactive
20719 $$ \sigma_\mu^2 = {\sigma^2 \over N} $$
20720 @end tex
20722 @kindex H u M
20723 @pindex calc-vector-median
20724 @tindex vmedian
20725 @cindex Median of data values
20726 The @kbd{H u M} (@code{calc-vector-median}) [@code{vmedian}]
20727 command computes the median of the data values.  The values are
20728 first sorted into numerical order; the median is the middle
20729 value after sorting.  (If the number of data values is even,
20730 the median is taken to be the average of the two middle values.)
20731 The median function is different from the other functions in
20732 this section in that the arguments must all be real numbers;
20733 variables are not accepted even when nested inside vectors.
20734 (Otherwise it is not possible to sort the data values.)  If
20735 any of the input values are error forms, their error parts are
20736 ignored.
20738 The median function also accepts distributions.  For both normal
20739 (error form) and uniform (interval) distributions, the median is
20740 the same as the mean.
20742 @kindex H I u M
20743 @pindex calc-vector-harmonic-mean
20744 @tindex vhmean
20745 @cindex Harmonic mean
20746 The @kbd{H I u M} (@code{calc-vector-harmonic-mean}) [@code{vhmean}]
20747 command computes the harmonic mean of the data values.  This is
20748 defined as the reciprocal of the arithmetic mean of the reciprocals
20749 of the values.
20750 @tex
20751 \turnoffactive
20752 $$ { N \over \displaystyle \sum {1 \over x_i} } $$
20753 @end tex
20755 @kindex u G
20756 @pindex calc-vector-geometric-mean
20757 @tindex vgmean
20758 @cindex Geometric mean
20759 The @kbd{u G} (@code{calc-vector-geometric-mean}) [@code{vgmean}]
20760 command computes the geometric mean of the data values.  This
20761 is the @var{n}th root of the product of the values.  This is also
20762 equal to the @code{exp} of the arithmetic mean of the logarithms
20763 of 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
20770 @kindex H u G
20771 @tindex agmean
20772 The @kbd{H u G} [@code{agmean}] command computes the ``arithmetic-geometric
20773 mean'' of two numbers taken from the stack.  This is computed by
20774 replacing the two numbers with their arithmetic mean and geometric
20775 mean, 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
20781 @cindex Root-mean-square
20782 Another commonly used mean, the RMS (root-mean-square), can be computed
20783 for a vector of numbers simply by using the @kbd{A} command.
20785 @kindex u S
20786 @pindex calc-vector-sdev
20787 @tindex vsdev
20788 @cindex Standard deviation
20789 @cindex Sample statistics
20790 The @kbd{u S} (@code{calc-vector-sdev}) [@code{vsdev}] command
20791 computes the standard 
20792 @texline deviation@tie{}@math{\sigma}
20793 @infoline deviation
20794 of the data values.  If the values are error forms, the errors are used
20795 as weights just as for @kbd{u M}.  This is the @emph{sample} standard
20796 deviation, whose value is the square root of the sum of the squares of
20797 the differences between the values and the mean of the @expr{N} values,
20798 divided by @expr{N-1}.
20799 @tex
20800 \turnoffactive
20801 $$ \sigma^2 = {1 \over N - 1} \sum (x_i - \mu)^2 $$
20802 @end tex
20804 This function also applies to distributions.  The standard deviation
20805 of a single error form is simply the error part.  The standard deviation
20806 of a continuous interval happens to equal the difference between the
20807 limits, divided by 
20808 @texline @math{\sqrt{12}}.
20809 @infoline @expr{sqrt(12)}.  
20810 The standard deviation of an integer interval is the same as the
20811 standard deviation of a vector of those integers.
20813 @kindex I u S
20814 @pindex calc-vector-pop-sdev
20815 @tindex vpsdev
20816 @cindex Population statistics
20817 The @kbd{I u S} (@code{calc-vector-pop-sdev}) [@code{vpsdev}]
20818 command computes the @emph{population} standard deviation.
20819 It is defined by the same formula as above but dividing
20820 by @expr{N} instead of by @expr{N-1}.  The population standard
20821 deviation is used when the input represents the entire set of
20822 data values in the distribution; the sample standard deviation
20823 is used when the input represents a sample of the set of all
20824 data values, so that the mean computed from the input is itself
20825 only an estimate of the true mean.
20826 @tex
20827 \turnoffactive
20828 $$ \sigma^2 = {1 \over N} \sum (x_i - \mu)^2 $$
20829 @end tex
20831 For error forms and continuous intervals, @code{vpsdev} works
20832 exactly like @code{vsdev}.  For integer intervals, it computes the
20833 population standard deviation of the equivalent vector of integers.
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
20842 The @kbd{H u S} (@code{calc-vector-variance}) [@code{vvar}] and
20843 @kbd{H I u S} (@code{calc-vector-pop-variance}) [@code{vpvar}]
20844 commands compute the variance of the data values.  The variance
20845 is the 
20846 @texline square@tie{}@math{\sigma^2}
20847 @infoline square
20848 of the standard deviation, i.e., the sum of the
20849 squares of the deviations of the data values from the mean.
20850 (This definition also applies when the argument is a distribution.)
20852 @ignore
20853 @starindex
20854 @end ignore
20855 @tindex vflat
20856 The @code{vflat} algebraic function returns a vector of its
20857 arguments, interpreted in the same way as the other functions
20858 in this section.  For example, @samp{vflat(1, [2, [3, 4]], 5)}
20859 returns @samp{[1, 2, 3, 4, 5]}.
20861 @node Paired-Sample Statistics, , Single-Variable Statistics, Statistical Operations
20862 @subsection Paired-Sample Statistics
20864 @noindent
20865 The functions in this section take two arguments, which must be
20866 vectors of equal size.  The vectors are each flattened in the same
20867 way as by the single-variable statistical functions.  Given a numeric
20868 prefix argument of 1, these functions instead take one object from
20869 the stack, which must be an 
20870 @texline @math{N\times2}
20871 @infoline Nx2
20872 matrix of data values.  Once again, variable names can be used in place
20873 of actual vectors and matrices.
20875 @kindex u C
20876 @pindex calc-vector-covariance
20877 @tindex vcov
20878 @cindex Covariance
20879 The @kbd{u C} (@code{calc-vector-covariance}) [@code{vcov}] command
20880 computes the sample covariance of two vectors.  The covariance
20881 of vectors @var{x} and @var{y} is the sum of the products of the
20882 differences between the elements of @var{x} and the mean of @var{x}
20883 times the differences between the corresponding elements of @var{y}
20884 and the mean of @var{y}, all divided by @expr{N-1}.  Note that
20885 the variance of a vector is just the covariance of the vector
20886 with itself.  Once again, if the inputs are error forms the
20887 errors are used as weight factors.  If both @var{x} and @var{y}
20888 are composed of error forms, the error for a given data point
20889 is taken as the square root of the sum of the squares of the two
20890 input 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}}
20899 @end tex
20901 @kindex I u C
20902 @pindex calc-vector-pop-covariance
20903 @tindex vpcov
20904 The @kbd{I u C} (@code{calc-vector-pop-covariance}) [@code{vpcov}]
20905 command computes the population covariance, which is the same as the
20906 sample covariance computed by @kbd{u C} except dividing by @expr{N}
20907 instead of @expr{N-1}.
20909 @kindex H u C
20910 @pindex calc-vector-correlation
20911 @tindex vcorr
20912 @cindex Correlation coefficient
20913 @cindex Linear correlation
20914 The @kbd{H u C} (@code{calc-vector-correlation}) [@code{vcorr}]
20915 command computes the linear correlation coefficient of two vectors.
20916 This is defined by the covariance of the vectors divided by the
20917 product of their standard deviations.  (There is no difference
20918 between 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
20924 @node Reducing and Mapping, Vector and Matrix Formats, Statistical Operations, Matrix Functions
20925 @section Reducing and Mapping Vectors
20927 @noindent
20928 The commands in this section allow for more general operations on the
20929 elements of vectors.
20931 @kindex V A
20932 @pindex calc-apply
20933 @tindex apply
20934 The 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.
20936 For 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)}.
20938 Applying 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
20940 error, since the @code{+} function expects exactly two arguments.
20942 While @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.
20945 @menu
20946 * Specifying Operators::
20947 * Mapping::
20948 * Reducing::
20949 * Nesting and Fixed Points::
20950 * Generalized Products::
20951 @end menu
20953 @node Specifying Operators, Mapping, Reducing and Mapping, Reducing and Mapping
20954 @subsection Specifying Operators
20956 @noindent
20957 Commands in this section (like @kbd{V A}) prompt you to press the key
20958 corresponding to the desired operator.  Press @kbd{?} for a partial
20959 list of the available operators.  Generally, an operator is any key or
20960 sequence of keys that would normally take one or more arguments from
20961 the stack and replace them with a result.  For example, @kbd{V A H C}
20962 uses the hyperbolic cosine operator, @code{cosh}.  (Since @code{cosh}
20963 expects one argument, @kbd{V A H C} requires a vector with a single
20964 element as its argument.)
20966 You can press @kbd{x} at the operator prompt to select any algebraic
20967 function by name to use as the operator.  This includes functions you
20968 have defined yourself using the @kbd{Z F} command.  (@xref{Algebraic
20969 Definitions}.)  If you give a name for which no function has been
20970 defined, the result is left in symbolic form, as in @samp{f(1, 2, 3)}.
20971 Calc will prompt for the number of arguments the function takes if it
20972 can't figure it out on its own (say, because you named a function that
20973 is currently undefined).  It is also possible to type a digit key before
20974 the function name to specify the number of arguments, e.g.,
20975 @kbd{V M 3 x f @key{RET}} calls @code{f} with three arguments even if it
20976 looks like it ought to have only two.  This technique may be necessary
20977 if the function allows a variable number of arguments.  For example,
20978 the @kbd{v e} [@code{vexp}] function accepts two or three arguments;
20979 if you want to map with the three-argument version, you will have to
20980 type @kbd{V M 3 v e}.
20982 It is also possible to apply any formula to a vector by treating that
20983 formula as a function.  When prompted for the operator to use, press
20984 @kbd{'} (the apostrophe) and type your formula as an algebraic entry.
20985 You will then be prompted for the argument list, which defaults to a
20986 list of all variables that appear in the formula, sorted into alphabetic
20987 order.  For example, suppose you enter the formula @w{@samp{x + 2y^x}}.
20988 The default argument list would be @samp{(x y)}, which means that if
20989 this function is applied to the arguments @samp{[3, 10]} the result will
20990 be @samp{3 + 2*10^3}.  (If you plan to use a certain formula in this
20991 way often, you might consider defining it as a function with @kbd{Z F}.)
20993 Another way to specify the arguments to the formula you enter is with
20994 @kbd{$}, @kbd{$$}, and so on.  For example, @kbd{V A ' $$ + 2$^$$}
20995 has the same effect as the previous example.  The argument list is
20996 automatically taken to be @samp{($$ $)}.  (The order of the arguments
20997 may seem backwards, but it is analogous to the way normal algebraic
20998 entry interacts with the stack.)
21000 If you press @kbd{$} at the operator prompt, the effect is similar to
21001 the apostrophe except that the relevant formula is taken from top-of-stack
21002 instead.  The actual vector arguments of the @kbd{V A $} or related command
21003 then start at the second-to-top stack position.  You will still be
21004 prompted for an argument list.
21006 @cindex Nameless functions
21007 @cindex Generic functions
21008 A function can be written without a name using the notation @samp{<#1 - #2>},
21009 which means ``a function of two arguments that computes the first
21010 argument minus the second argument.''  The symbols @samp{#1} and @samp{#2}
21011 are placeholders for the arguments.  You can use any names for these
21012 placeholders if you wish, by including an argument list followed by a
21013 colon:  @samp{<x, y : x - y>}.  When you type @kbd{V A ' $$ + 2$^$$ @key{RET}},
21014 Calc builds the nameless function @samp{<#1 + 2 #2^#1>} as the function
21015 to map across the vectors.  When you type @kbd{V A ' x + 2y^x @key{RET} @key{RET}},
21016 Calc builds the nameless function @w{@samp{<x, y : x + 2 y^x>}}.  In both
21017 cases, Calc also writes the nameless function to the Trail so that you
21018 can get it back later if you wish.
21020 If 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
21022 that @samp{<@var{stuff}>} is a nameless function by the presence of
21023 @samp{#} signs inside @var{stuff}, or by the fact that @var{stuff}
21024 begins with a list of variables followed by a colon.)
21026 You can type a nameless function directly to @kbd{V A '}, or put one on
21027 the stack and use it with @w{@kbd{V A $}}.  Calc will not prompt for an
21028 argument list in this case, since the nameless function specifies the
21029 argument list as well as the function itself.  In @kbd{V A '}, you can
21030 omit the @samp{< >} marks if you use @samp{#} notation for the arguments,
21031 so that @kbd{V A ' #1+#2 @key{RET}} is the same as @kbd{V A ' <#1+#2> @key{RET}},
21032 which in turn is the same as @kbd{V A ' $$+$ @key{RET}}.
21034 @cindex Lambda expressions
21035 @ignore
21036 @starindex
21037 @end ignore
21038 @tindex lambda
21039 The 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
21041 functions.)  The internal format for @samp{<#1 + #2>} is @samp{lambda(ArgA,
21042 ArgB, ArgA + ArgB)}.  Note that there is no actual Calc function called
21043 @code{lambda}; the whole point is that the @code{lambda} expression is
21044 used in its symbolic form, not evaluated for an answer until it is applied
21045 to specific arguments by a command like @kbd{V A} or @kbd{V M}.
21047 (Actually, @code{lambda} does have one special property:  Its arguments
21048 are never evaluated; for example, putting @samp{<(2/3) #>} on the stack
21049 will not simplify the @samp{2/3} until the nameless function is actually
21050 called.)
21052 @tindex add
21053 @tindex sub
21054 @ignore
21055 @mindex @idots
21056 @end ignore
21057 @tindex mul
21058 @ignore
21059 @mindex @null
21060 @end ignore
21061 @tindex div
21062 @ignore
21063 @mindex @null
21064 @end ignore
21065 @tindex pow
21066 @ignore
21067 @mindex @null
21068 @end ignore
21069 @tindex neg
21070 @ignore
21071 @mindex @null
21072 @end ignore
21073 @tindex mod
21074 @ignore
21075 @mindex @null
21076 @end ignore
21077 @tindex vconcat
21078 As usual, commands like @kbd{V A} have algebraic function name equivalents.
21079 For 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,
21081 and is either a variable whose name is the same as the function name,
21082 or a nameless function like @samp{<#^3+1>}.  Operators that are normally
21083 written as algebraic symbols have the names @code{add}, @code{sub},
21084 @code{mul}, @code{div}, @code{pow}, @code{neg}, @code{mod}, and
21085 @code{vconcat}.
21087 @ignore
21088 @starindex
21089 @end ignore
21090 @tindex call
21091 The @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
21093 in turn is the same as @samp{gcd(x, y)}.  The first argument of @code{call},
21094 like the other functions described here, may be either a variable naming a
21095 function, or a nameless function (@samp{call(<#1+2#2>, x, y)} is the same
21096 as @samp{x + 2y}).
21098 (Experts will notice that it's not quite proper to use a variable to name
21099 a function, since the name @code{gcd} corresponds to the Lisp variable
21100 @code{var-gcd} but to the Lisp function @code{calcFunc-gcd}.  Calc
21101 automatically makes this translation, so you don't have to worry
21102 about it.)
21104 @node Mapping, Reducing, Specifying Operators, Reducing and Mapping
21105 @subsection Mapping
21107 @noindent
21108 @kindex V M
21109 @pindex calc-map
21110 @tindex map
21111 The @kbd{V M} (@code{calc-map}) [@code{map}] command applies a given
21112 operator elementwise to one or more vectors.  For example, mapping
21113 @code{A} [@code{abs}] produces a vector of the absolute values of the
21114 elements in the input vector.  Mapping @code{+} pops two vectors from
21115 the stack, which must be of equal length, and produces a vector of the
21116 pairwise sums of the elements.  If either argument is a non-vector, it
21117 is 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.
21119 With the 2 listed first, it would have computed a vector of powers of
21120 two.  Mapping a user-defined function pops as many arguments from the
21121 stack as the function requires.  If you give an undefined name, you will
21122 be prompted for the number of arguments to use.
21124 If any argument to @kbd{V M} is a matrix, the operator is normally mapped
21125 across all elements of the matrix.  For example, given the matrix
21126 @expr{[[1, -2, 3], [-4, 5, -6]]}, @kbd{V M A} takes six absolute values to
21127 produce another 
21128 @texline @math{3\times2}
21129 @infoline 3x2
21130 matrix, @expr{[[1, 2, 3], [4, 5, 6]]}.
21132 @tindex mapr
21133 The command @kbd{V M _} [@code{mapr}] (i.e., type an underscore at the
21134 operator prompt) maps by rows instead.  For example, @kbd{V M _ A} views
21135 the above matrix as a vector of two 3-element row vectors.  It produces
21136 a new vector which contains the absolute values of those row vectors,
21137 namely @expr{[3.74, 8.77]}.  (Recall, the absolute value of a vector is
21138 defined as the square root of the sum of the squares of the elements.)
21139 Some 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
21141 of the matrix to get a new matrix, @expr{[[3, -2, 1], [-6, 5, -4]]}.
21143 Sometimes a vector of vectors (representing, say, strings, sets, or lists)
21144 happens to look like a matrix.  If so, remember to use @kbd{V M _} if you
21145 want to map a function across the whole strings or sets rather than across
21146 their individual elements.
21148 @tindex mapc
21149 The command @kbd{V M :} [@code{mapc}] maps by columns.  Basically, it
21150 transposes the input matrix, maps by rows, and then, if the result is a
21151 matrix, transposes again.  For example, @kbd{V M : A} takes the absolute
21152 values of the three columns of the matrix, treating each as a 2-vector,
21153 and @kbd{V M : v v} reverses the columns to get the matrix
21154 @expr{[[-4, 5, -6], [1, -2, 3]]}.
21156 (The symbols @kbd{_} and @kbd{:} were chosen because they had row-like
21157 and column-like appearances, and were not already taken by useful
21158 operators.  Also, they appear shifted on most keyboards so they are easy
21159 to type after @kbd{V M}.)
21161 The @kbd{_} and @kbd{:} modifiers have no effect on arguments that are
21162 not matrices (so if none of the arguments are matrices, they have no
21163 effect at all).  If some of the arguments are matrices and others are
21164 plain numbers, the plain numbers are held constant for all rows of the
21165 matrix (so that @kbd{2 V M _ ^} squares every row of a matrix; squaring
21166 a vector takes a dot product of the vector with itself).
21168 If some of the arguments are vectors with the same lengths as the
21169 rows (for @kbd{V M _}) or columns (for @kbd{V M :}) of the matrix
21170 arguments, those vectors are also held constant for every row or
21171 column.
21173 Sometimes it is useful to specify another mapping command as the operator
21174 to use with @kbd{V M}.  For example, @kbd{V M _ V A +} applies @kbd{V A +}
21175 to each row of the input matrix, which in turn adds the two values on that
21176 row.  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
21178 otherwise; thus @kbd{V M V A +} is equivalent to @kbd{V M _ V A +}.  (If
21179 you really want to map-by-elements another mapping command, you can use
21180 a 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
21182 mapped over the elements of each row.)
21184 @tindex mapa
21185 @tindex mapd
21186 Previous versions of Calc had ``map across'' and ``map down'' modes
21187 that 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
21189 functions @code{mapa} and @code{mapd} are still supported, though.
21190 Note also that, while the old mapping modes were persistent (once you
21191 set the mode, it would apply to later mapping commands until you reset
21192 it), the new @kbd{:} and @kbd{_} modifiers apply only to the current
21193 mapping command.  The default @kbd{V M} always means map-by-elements.
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
21198 variable's stored value using a @kbd{V M}-like operator.
21200 @node Reducing, Nesting and Fixed Points, Mapping, Reducing and Mapping
21201 @subsection Reducing
21203 @noindent
21204 @kindex V R
21205 @pindex calc-reduce
21206 @tindex reduce
21207 The @kbd{V R} (@code{calc-reduce}) [@code{reduce}] command applies a given
21208 binary operator across all the elements of a vector.  A binary operator is
21209 a function such as @code{+} or @code{max} which takes two arguments.  For
21210 example, reducing @code{+} over a vector computes the sum of the elements
21211 of the vector.  Reducing @code{-} computes the first element minus each of
21212 the remaining elements.  Reducing @code{max} computes the maximum element
21213 and so on.  In general, reducing @code{f} over the vector @samp{[a, b, c, d]}
21214 produces @samp{f(f(f(a, b), c), d)}.
21216 @kindex I V R
21217 @tindex rreduce
21218 The @kbd{I V R} [@code{rreduce}] command is similar to @kbd{V R} except
21219 that 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}
21221 but @kbd{I V R -} on the same vector produces @samp{a - (b - (c - d))},
21222 or @samp{a - b + c - d}.  This ``alternating sum'' occurs frequently
21223 in power series expansions.
21225 @kindex V U
21226 @tindex accum
21227 The @kbd{V U} (@code{calc-accumulate}) [@code{accum}] command does an
21228 accumulation operation.  Here Calc does the corresponding reduction
21229 operation, but instead of producing only the final result, it produces
21230 a vector of all the intermediate results.  Accumulating @code{+} over
21231 the vector @samp{[a, b, c, d]} produces the vector
21232 @samp{[a, a + b, a + b + c, a + b + c + d]}.
21234 @kindex I V U
21235 @tindex raccum
21236 The @kbd{I V U} [@code{raccum}] command does a right-to-left accumulation.
21237 For example, @kbd{I V U -} on the vector @samp{[a, b, c, d]} produces the
21238 vector @samp{[a - b + c - d, b - c + d, c - d, d]}.
21240 @tindex reducea
21241 @tindex rreducea
21242 @tindex reduced
21243 @tindex rreduced
21244 As for @kbd{V M}, @kbd{V R} normally reduces a matrix elementwise.  For
21245 example, given the matrix @expr{[[a, b, c], [d, e, f]]}, @kbd{V R +} will
21246 compute @expr{a + b + c + d + e + f}.  You can type @kbd{V R _} or
21247 @kbd{V R :} to modify this behavior.  The @kbd{V R _} [@code{reducea}]
21248 command reduces ``across'' the matrix; it reduces each row of the matrix
21249 as a vector, then collects the results.  Thus @kbd{V R _ +} of this
21250 matrix 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,
21252 b + e, c + f]}.
21254 @tindex reducer
21255 @tindex rreducer
21256 There is a third ``by rows'' mode for reduction that is occasionally
21257 useful; @kbd{V R =} [@code{reducer}] simply reduces the operator over
21258 the rows of the matrix themselves.  Thus @kbd{V R = +} on the above
21259 matrix would get the same result as @kbd{V R : +}, since adding two
21260 row vectors is equivalent to adding their elements.  But @kbd{V R = *}
21261 would multiply the two rows (to get a single number, their dot product),
21262 while @kbd{V R : *} would produce a vector of the products of the columns.
21264 These three matrix reduction modes work with @kbd{V R} and @kbd{I V R},
21265 but they are not currently supported with @kbd{V U} or @kbd{I V U}.
21267 @tindex reducec
21268 @tindex rreducec
21269 The obsolete reduce-by-columns function, @code{reducec}, is still
21270 supported but there is no way to get it through the @kbd{V R} command.
21272 The 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
21275 rows of the matrix.  @xref{Grabbing From Buffers}.
21277 @node Nesting and Fixed Points, Generalized Products, Reducing, Reducing and Mapping
21278 @subsection Nesting and Fixed Points
21280 @noindent
21281 @kindex H V R
21282 @tindex nest
21283 The @kbd{H V R} [@code{nest}] command applies a function to a given
21284 argument repeatedly.  It takes two values, @samp{a} and @samp{n}, from
21285 the stack, where @samp{n} must be an integer.  It then applies the
21286 function nested @samp{n} times; if the function is @samp{f} and @samp{n}
21287 is 3, the result is @samp{f(f(f(a)))}.  The number @samp{n} may be
21288 negative if Calc knows an inverse for the function @samp{f}; for
21289 example, @samp{nest(sin, a, -2)} returns @samp{arcsin(arcsin(a))}.
21291 @kindex H V U
21292 @tindex anest
21293 The @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
21297 form @samp{[a, F(a), F(F(a)), F(F(F(a)))]}.
21299 @kindex H I V R
21300 @tindex fixp
21301 @cindex Fixed points
21302 The @kbd{H I V R} [@code{fixp}] command is like @kbd{H V R}, except
21303 that it takes only an @samp{a} value from the stack; the function is
21304 applied until it reaches a ``fixed point,'' i.e., until the result
21305 no longer changes.
21307 @kindex H I V U
21308 @tindex afixp
21309 The @kbd{H I V U} [@code{afixp}] command is an accumulating @code{fixp}.
21310 The first element of the return vector will be the initial value @samp{a};
21311 the last element will be the final result that would have been returned
21312 by @code{fixp}.
21314 For 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,
21316 1.0 on the stack and typing @kbd{H I V U C}.  (We use the accumulating
21317 version so we can see the intermediate results:  @samp{[1, 0.540302, 0.857553,
21318 0.65329, ...]}.  With a precision of six, this command will take 36 steps
21319 to converge to 0.739085.)
21321 Newton's method for finding roots is a classic example of iteration
21322 to a fixed point.  To find the square root of five starting with an
21323 initial guess, Newton's method would look for a fixed point of the
21324 function @samp{(x + 5/x) / 2}.  Putting a guess of 1 on the stack
21325 and typing @kbd{H I V R ' ($ + 5/$)/2 @key{RET}} quickly yields the result
21326 2.23607.  This is equivalent to using the @kbd{a R} (@code{calc-find-root})
21327 command to find a root of the equation @samp{x^2 = 5}.
21329 These examples used numbers for @samp{a} values.  Calc keeps applying
21330 the function until two successive results are equal to within the
21331 current precision.  For complex numbers, both the real parts and the
21332 imaginary parts must be equal to within the current precision.  If
21333 @samp{a} is a formula (say, a variable name), then the function is
21334 applied until two successive results are exactly the same formula.
21335 It is up to you to ensure that the function will eventually converge;
21336 if it doesn't, you may have to press @kbd{C-g} to stop the Calculator.
21338 The algebraic @code{fixp} function takes two optional arguments, @samp{n}
21339 and @samp{tol}.  The first is the maximum number of steps to be allowed,
21340 and must be either an integer or the symbol @samp{inf} (infinity, the
21341 default).  The second is a convergence tolerance.  If a tolerance is
21342 specified, all results during the calculation must be numbers, not
21343 formulas, and the iteration stops when the magnitude of the difference
21344 between two successive results is less than or equal to the tolerance.
21345 (This implies that a tolerance of zero iterates until the results are
21346 exactly equal.)
21348 Putting it all together, @samp{fixp(<(# + A/#)/2>, B, 20, 1e-10)}
21349 computes the square root of @samp{A} given the initial guess @samp{B},
21350 stopping when the result is correct within the specified tolerance, or
21351 when 20 steps have been taken, whichever is sooner.
21353 @node Generalized Products, , Nesting and Fixed Points, Reducing and Mapping
21354 @subsection Generalized Products
21356 @kindex V O
21357 @pindex calc-outer-product
21358 @tindex outer
21359 The @kbd{V O} (@code{calc-outer-product}) [@code{outer}] command applies
21360 a given binary operator to all possible pairs of elements from two
21361 vectors, to produce a matrix.  For example, @kbd{V O *} with @samp{[a, b]}
21362 and @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
21364 the result matrix is obtained by applying the operator to element @var{r}
21365 of the lefthand vector and element @var{c} of the righthand vector.
21367 @kindex V I
21368 @pindex calc-inner-product
21369 @tindex inner
21370 The @kbd{V I} (@code{calc-inner-product}) [@code{inner}] command computes
21371 the generalized inner product of two vectors or matrices, given a
21372 ``multiplicative'' operator and an ``additive'' operator.  These can each
21373 actually be any binary operators; if they are @samp{*} and @samp{+},
21374 respectively, the result is a standard matrix multiplication.  Element
21375 @var{r},@var{c} of the result matrix is obtained by mapping the
21376 multiplicative operator across row @var{r} of the lefthand matrix and
21377 column @var{c} of the righthand matrix, and then reducing with the additive
21378 operator.  Just as for the standard @kbd{*} command, this can also do a
21379 vector-matrix or matrix-vector inner product, or a vector-vector
21380 generalized dot product.
21382 Since @kbd{V I} requires two operators, it prompts twice.  In each case,
21383 you can use any of the usual methods for entering the operator.  If you
21384 use @kbd{$} twice to take both operator formulas from the stack, the
21385 first (multiplicative) operator is taken from the top of the stack
21386 and the second (additive) operator is taken from second-to-top.
21388 @node Vector and Matrix Formats, , Reducing and Mapping, Matrix Functions
21389 @section Vector and Matrix Display Formats
21391 @noindent
21392 Commands for controlling vector and matrix display use the @kbd{v} prefix
21393 instead of the usual @kbd{d} prefix.  But they are display modes; in
21394 particular, they are influenced by the @kbd{I} and @kbd{H} prefix keys
21395 in the same way (@pxref{Display Modes}).  Matrix display is also
21396 influenced by the @kbd{d O} (@code{calc-flat-language}) mode;
21397 @pxref{Normal Language Modes}.
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
21405 The 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
21408 are justified to the left, right, or center of their columns.
21410 @kindex V [
21411 @pindex calc-vector-brackets
21412 @kindex V @{
21413 @pindex calc-vector-braces
21414 @kindex V (
21415 @pindex calc-vector-parens
21416 The @kbd{v [} (@code{calc-vector-brackets}) command turns the square
21417 brackets that surround vectors and matrices displayed in the stack on
21418 and off.  The @kbd{v @{} (@code{calc-vector-braces}) and @kbd{v (}
21419 (@code{calc-vector-parens}) commands use curly braces or parentheses,
21420 respectively, instead of square brackets.  For example, @kbd{v @{} might
21421 be used in preparation for yanking a matrix into a buffer running
21422 Mathematica.  (In fact, the Mathematica language mode uses this mode;
21423 @pxref{Mathematica Language Mode}.)  Note that, regardless of the
21424 display mode, either brackets or braces may be used to enter vectors,
21425 and parentheses may never be used for this purpose.
21427 @kindex V ]
21428 @pindex calc-matrix-brackets
21429 The @kbd{v ]} (@code{calc-matrix-brackets}) command controls the
21430 ``big'' style display of matrices.  It prompts for a string of code
21431 letters; currently implemented letters are @code{R}, which enables
21432 brackets on each row of the matrix; @code{O}, which enables outer
21433 brackets in opposite corners of the matrix; and @code{C}, which
21434 enables commas or semicolons at the ends of all rows but the last.
21435 The default format is @samp{RO}.  (Before Calc 2.00, the format
21436 was fixed at @samp{ROC}.)  Here are some example matrices:
21438 @example
21439 @group
21440 [ [ 123,  0,   0  ]       [ [ 123,  0,   0  ],
21441   [  0,  123,  0  ]         [  0,  123,  0  ],
21442   [  0,   0,  123 ] ]       [  0,   0,  123 ] ]
21444          RO                        ROC
21446 @end group
21447 @end example
21448 @noindent
21449 @example
21450 @group
21451   [ 123,  0,   0            [ 123,  0,   0 ;
21452      0,  123,  0               0,  123,  0 ;
21453      0,   0,  123 ]            0,   0,  123 ]
21455           O                        OC
21457 @end group
21458 @end example
21459 @noindent
21460 @example
21461 @group
21462   [ 123,  0,   0  ]           123,  0,   0
21463   [  0,  123,  0  ]            0,  123,  0
21464   [  0,   0,  123 ]            0,   0,  123
21466           R                       @r{blank}
21467 @end group
21468 @end example
21470 @noindent
21471 Note that of the formats shown here, @samp{RO}, @samp{ROC}, and
21472 @samp{OC} are all recognized as matrices during reading, while
21473 the others are useful for display only.
21475 @kindex V ,
21476 @pindex calc-vector-commas
21477 The @kbd{v ,} (@code{calc-vector-commas}) command turns commas on and
21478 off in vector and matrix display.
21480 In vectors of length one, and in all vectors when commas have been
21481 turned off, Calc adds extra parentheses around formulas that might
21482 otherwise be ambiguous.  For example, @samp{[a b]} could be a vector
21483 of the one formula @samp{a b}, or it could be a vector of two
21484 variables with commas turned off.  Calc will display the former
21485 case as @samp{[(a b)]}.  You can disable these extra parentheses
21486 (to make the output less cluttered at the expense of allowing some
21487 ambiguity) by adding the letter @code{P} to the control string you
21488 give to @kbd{v ]} (as described above).
21490 @kindex V .
21491 @pindex calc-full-vectors
21492 The @kbd{v .} (@code{calc-full-vectors}) command turns abbreviated
21493 display of long vectors on and off.  In this mode, vectors of six
21494 or more elements, or matrices of six or more rows or columns, will
21495 be displayed in an abbreviated form that displays only the first
21496 three elements and the last element:  @samp{[a, b, c, ..., z]}.
21497 When very large vectors are involved this will substantially
21498 improve Calc's display speed.
21500 @kindex t .
21501 @pindex calc-full-trail-vectors
21502 The @kbd{t .} (@code{calc-full-trail-vectors}) command controls a
21503 similar mode for recording vectors in the Trail.  If you turn on
21504 this mode, vectors of six or more elements and matrices of six or
21505 more rows or columns will be abbreviated when they are put in the
21506 Trail.  The @kbd{t y} (@code{calc-trail-yank}) command will be
21507 unable to recover those vectors.  If you are working with very
21508 large vectors, this mode will improve the speed of all operations
21509 that involve the trail.
21511 @kindex V /
21512 @pindex calc-break-vectors
21513 The @kbd{v /} (@code{calc-break-vectors}) command turns multi-line
21514 vector display on and off.  Normally, matrices are displayed with one
21515 row per line but all other types of vectors are displayed in a single
21516 line.  This mode causes all vectors, whether matrices or not, to be
21517 displayed with a single element per line.  Sub-vectors within the
21518 vectors will still use the normal linear form.
21520 @node Algebra, Units, Matrix Functions, Top
21521 @chapter Algebra
21523 @noindent
21524 This section covers the Calc features that help you work with
21525 algebraic formulas.  First, the general sub-formula selection
21526 mechanism is described; this works in conjunction with any Calc
21527 commands.  Then, commands for specific algebraic operations are
21528 described.  Finally, the flexible @dfn{rewrite rule} mechanism
21529 is discussed.
21531 The algebraic commands use the @kbd{a} key prefix; selection
21532 commands use the @kbd{j} (for ``just a letter that wasn't used
21533 for anything else'') prefix.
21535 @xref{Editing Stack Entries}, to see how to manipulate formulas
21536 using regular Emacs editing commands.
21538 When doing algebraic work, you may find several of the Calculator's
21539 modes to be helpful, including Algebraic Simplification mode (@kbd{m A})
21540 or No-Simplification mode (@kbd{m O}),
21541 Algebraic entry mode (@kbd{m a}), Fraction mode (@kbd{m f}), and
21542 Symbolic mode (@kbd{m s}).  @xref{Mode Settings}, for discussions
21543 of these modes.  You may also wish to select Big display mode (@kbd{d B}).
21544 @xref{Normal Language Modes}.
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
21560 @node Selecting Subformulas, Algebraic Manipulation, Algebra, Algebra
21561 @section Selecting Sub-Formulas
21563 @noindent
21564 @cindex Selections
21565 @cindex Sub-formulas
21566 @cindex Parts of formulas
21567 When working with an algebraic formula it is often necessary to
21568 manipulate a portion of the formula rather than the formula as a
21569 whole.  Calc allows you to ``select'' a portion of any formula on
21570 the stack.  Commands which would normally operate on that stack
21571 entry will now operate only on the sub-formula, leaving the
21572 surrounding part of the stack entry alone.
21574 One common non-algebraic use for selection involves vectors.  To work
21575 on one element of a vector in-place, simply select that element as a
21576 ``sub-formula'' of the vector.
21578 @menu
21579 * Making Selections::
21580 * Changing Selections::
21581 * Displaying Selections::
21582 * Operating on Selections::
21583 * Rearranging with Selections::
21584 @end menu
21586 @node Making Selections, Changing Selections, Selecting Subformulas, Selecting Subformulas
21587 @subsection Making Selections
21589 @noindent
21590 @kindex j s
21591 @pindex calc-select-here
21592 To select a sub-formula, move the Emacs cursor to any character in that
21593 sub-formula, and press @w{@kbd{j s}} (@code{calc-select-here}).  Calc will
21594 highlight the smallest portion of the formula that contains that
21595 character.  By default the sub-formula is highlighted by blanking out
21596 all of the rest of the formula with dots.  Selection works in any
21597 display mode but is perhaps easiest in Big mode (@kbd{d B}).
21598 Suppose you enter the following formula:
21600 @smallexample
21601 @group
21602            3    ___
21603     (a + b)  + V c
21604 1:  ---------------
21605         2 x + 1
21606 @end group
21607 @end smallexample
21609 @noindent
21610 (by typing @kbd{' ((a+b)^3 + sqrt(c)) / (2x+1)}).  If you move the
21611 cursor to the letter @samp{b} and press @w{@kbd{j s}}, the display changes
21614 @smallexample
21615 @group
21616            .    ...
21617     .. . b.  . . .
21618 1*  ...............
21619         . . . .
21620 @end group
21621 @end smallexample
21623 @noindent
21624 Every character not part of the sub-formula @samp{b} has been changed
21625 to a dot.  The @samp{*} next to the line number is to remind you that
21626 the formula has a portion of it selected.  (In this case, it's very
21627 obvious, but it might not always be.  If Embedded mode is enabled,
21628 the word @samp{Sel} also appears in the mode line because the stack
21629 may not be visible.  @pxref{Embedded Mode}.)
21631 If you had instead placed the cursor on the parenthesis immediately to
21632 the right of the @samp{b}, the selection would have been:
21634 @smallexample
21635 @group
21636            .    ...
21637     (a + b)  . . .
21638 1*  ...............
21639         . . . .
21640 @end group
21641 @end smallexample
21643 @noindent
21644 The portion selected is always large enough to be considered a complete
21645 formula all by itself, so selecting the parenthesis selects the whole
21646 formula that it encloses.  Putting the cursor on the @samp{+} sign
21647 would have had the same effect.
21649 (Strictly speaking, the Emacs cursor is really the manifestation of
21650 the Emacs ``point,'' which is a position @emph{between} two characters
21651 in the buffer.  So purists would say that Calc selects the smallest
21652 sub-formula which contains the character to the right of ``point.'')
21654 If you supply a numeric prefix argument @var{n}, the selection is
21655 expanded to the @var{n}th enclosing sub-formula.  Thus, positioning
21656 the 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},
21658 and so on.
21660 If the cursor is not on any part of the formula, or if you give a
21661 numeric prefix that is too large, the entire formula is selected.
21663 If 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
21665 formula at stack level 1.  Most selection commands similarly operate
21666 on the formula at the top of the stack if you haven't positioned the
21667 cursor on any stack entry.
21669 @kindex j a
21670 @pindex calc-select-additional
21671 The @kbd{j a} (@code{calc-select-additional}) command enlarges the
21672 current selection to encompass the cursor.  To select the smallest
21673 sub-formula defined by two different points, move to the first and
21674 press @kbd{j s}, then move to the other and press @kbd{j a}.  This
21675 is roughly analogous to using @kbd{C-@@} (@code{set-mark-command}) to
21676 select the two ends of a region of text during normal Emacs editing.
21678 @kindex j o
21679 @pindex calc-select-once
21680 The @kbd{j o} (@code{calc-select-once}) command selects a formula in
21681 exactly the same way as @kbd{j s}, except that the selection will
21682 last 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
21684 by the cursor.
21686 (A somewhat more precise definition: The @kbd{j o} command sets a flag
21687 such that the next command involving selected stack entries will clear
21688 the selections on those stack entries afterwards.  All other selection
21689 commands except @kbd{j a} and @kbd{j O} clear this flag.)
21691 @kindex j S
21692 @kindex j O
21693 @pindex calc-select-here-maybe
21694 @pindex calc-select-once-maybe
21695 The @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}
21697 and @kbd{j o}, respectively, except that if the formula already
21698 has a selection they have no effect.  This is analogous to the
21699 behavior of some commands such as @kbd{j r} (@code{calc-rewrite-selection};
21700 @pxref{Selections with Rewrite Rules}) and is mainly intended to be
21701 used in keyboard macros that implement your own selection-oriented
21702 commands.
21704 Selection 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.
21706 If you place the cursor anywhere inside @samp{a + b - c + d} except
21707 on one of the variable names and use @kbd{j s}, you will select the
21708 entire four-term sum.
21710 @kindex j b
21711 @pindex calc-break-selections
21712 The @kbd{j b} (@code{calc-break-selections}) command controls a mode
21713 in which the ``deep structure'' of these associative formulas shows
21714 through.  Calc actually stores the above formulas as @samp{((a + b) - c) + d}
21715 and @samp{x * (y * z)}.  (Note that for certain obscure reasons, Calc
21716 treats multiplication as right-associative.)  Once you have enabled
21717 @kbd{j b} mode, selecting with the cursor on the @samp{-} sign would
21718 only select the @samp{a + b - c} portion, which makes sense when the
21719 deep structure of the sum is considered.  There is no way to select
21720 the @samp{b - c + d} portion; although this might initially look
21721 like just as legitimate a sub-formula as @samp{a + b - c}, the deep
21722 structure shows that it isn't.  The @kbd{d U} command can be used
21723 to view the deep structure of any formula (@pxref{Normal Language Modes}).
21725 When @kbd{j b} mode has not been enabled, the deep structure is
21726 generally hidden by the selection commands---what you see is what
21727 you get.
21729 @kindex j u
21730 @pindex calc-unselect
21731 The @kbd{j u} (@code{calc-unselect}) command unselects the formula
21732 that the cursor is on.  If there was no selection in the formula,
21733 this command has no effect.  With a numeric prefix argument, it
21734 unselects the @var{n}th stack element rather than using the cursor
21735 position.
21737 @kindex j c
21738 @pindex calc-clear-selections
21739 The @kbd{j c} (@code{calc-clear-selections}) command unselects all
21740 stack elements.
21742 @node Changing Selections, Displaying Selections, Making Selections, Selecting Subformulas
21743 @subsection Changing Selections
21745 @noindent
21746 @kindex j m
21747 @pindex calc-select-more
21748 Once 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
21750 selected, pressing @w{@kbd{j m}} repeatedly works as follows:
21752 @smallexample
21753 @group
21754            3    ...                3    ___                3    ___
21755     (a + b)  . . .          (a + b)  + V c          (a + b)  + V c
21756 1*  ...............     1*  ...............     1*  ---------------
21757         . . . .                 . . . .                 2 x + 1
21758 @end group
21759 @end smallexample
21761 @noindent
21762 In the last example, the entire formula is selected.  This is roughly
21763 the same as having no selection at all, but because there are subtle
21764 differences the @samp{*} character is still there on the line number.
21766 With a numeric prefix argument @var{n}, @kbd{j m} expands @var{n}
21767 times (or until the entire formula is selected).  Note that @kbd{j s}
21768 with 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
21770 is no current selection, it is equivalent to @w{@kbd{j s}}.
21772 Even though @kbd{j m} does not explicitly use the location of the
21773 cursor within the formula, it nevertheless uses the cursor to determine
21774 which stack element to operate on.  As usual, @kbd{j m} when the cursor
21775 is not on any stack element operates on the top stack element.
21777 @kindex j l
21778 @pindex calc-select-less
21779 The @kbd{j l} (@code{calc-select-less}) command reduces the current
21780 selection around the cursor position.  That is, it selects the
21781 immediate sub-formula of the current selection which contains the
21782 cursor, the opposite of @kbd{j m}.  If the cursor is not inside the
21783 current selection, the command de-selects the formula.
21785 @kindex j 1-9
21786 @pindex calc-select-part
21787 The @kbd{j 1} through @kbd{j 9} (@code{calc-select-part}) commands
21788 select the @var{n}th sub-formula of the current selection.  They are
21789 like @kbd{j l} (@code{calc-select-less}) except they use counting
21790 rather than the cursor position to decide which sub-formula to select.
21791 For 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
21794 these cases, @kbd{j 4} through @kbd{j 9} would be errors.
21796 If there is no current selection, @kbd{j 1} through @kbd{j 9} select
21797 the @var{n}th top-level sub-formula.  (In other words, they act as if
21798 the entire stack entry were selected first.)  To select the @var{n}th
21799 sub-formula where @var{n} is greater than nine, you must instead invoke
21800 @w{@kbd{j 1}} with @var{n} as a numeric prefix argument.
21802 @kindex j n
21803 @kindex j p
21804 @pindex calc-select-next
21805 @pindex calc-select-previous
21806 The @kbd{j n} (@code{calc-select-next}) and @kbd{j p}
21807 (@code{calc-select-previous}) commands change the current selection
21808 to the next or previous sub-formula at the same level.  For example,
21809 if @samp{b} is selected in @w{@samp{2 + a*b*c + x}}, then @kbd{j n}
21810 selects @samp{c}.  Further @kbd{j n} commands would be in error because,
21811 even though there is something to the right of @samp{c} (namely, @samp{x}),
21812 it is not at the same level; in this case, it is not a term of the
21813 same product as @samp{b} and @samp{c}.  However, @kbd{j m} (to select
21814 the 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}.
21817 Similarly, @kbd{j p} moves the selection from the @samp{b} in this
21818 sample formula to the @samp{a}.  Both commands accept numeric prefix
21819 arguments to move several steps at a time.
21821 It is interesting to compare Calc's selection commands with the
21822 Emacs Info system's commands for navigating through hierarchically
21823 organized documentation.  Calc's @kbd{j n} command is completely
21824 analogous 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''.)
21827 The 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
21829 of the hierarchy simply by pointing to it with the cursor.
21831 @node Displaying Selections, Operating on Selections, Changing Selections, Selecting Subformulas
21832 @subsection Displaying Selections
21834 @noindent
21835 @kindex j d
21836 @pindex calc-show-selections
21837 The @kbd{j d} (@code{calc-show-selections}) command controls how
21838 selected sub-formulas are displayed.  One of the alternatives is
21839 illustrated in the above examples; if we press @kbd{j d} we switch
21840 to the other style in which the selected portion itself is obscured
21841 by @samp{#} signs:
21843 @smallexample
21844 @group
21845            3    ...                  #    ___
21846     (a + b)  . . .            ## # ##  + V c
21847 1*  ...............       1*  ---------------
21848         . . . .                   2 x + 1
21849 @end group
21850 @end smallexample
21852 @node Operating on Selections, Rearranging with Selections, Displaying Selections, Selecting Subformulas
21853 @subsection Operating on Selections
21855 @noindent
21856 Once a selection is made, all Calc commands that manipulate items
21857 on the stack will operate on the selected portions of the items
21858 instead.  (Note that several stack elements may have selections
21859 at once, though there can be only one selection at a time in any
21860 given stack element.)
21862 @kindex j e
21863 @pindex calc-enable-selections
21864 The @kbd{j e} (@code{calc-enable-selections}) command disables the
21865 effect that selections have on Calc commands.  The current selections
21866 still exist, but Calc commands operate on whole stack elements anyway.
21867 This mode can be identified by the fact that the @samp{*} markers on
21868 the line numbers are gone, even though selections are visible.  To
21869 reactivate the selections, press @kbd{j e} again.
21871 To extract a sub-formula as a new formula, simply select the
21872 sub-formula and press @key{RET}.  This normally duplicates the top
21873 stack element; here it duplicates only the selected portion of that
21874 element.
21876 To replace a sub-formula with something different, you can enter the
21877 new value onto the stack and press @key{TAB}.  This normally exchanges
21878 the top two stack elements; here it swaps the value you entered into
21879 the selected portion of the formula, returning the old selected
21880 portion to the top of the stack.
21882 @smallexample
21883 @group
21884            3    ...                    ...                    ___
21885     (a + b)  . . .           17 x y . . .           17 x y + V c
21886 2*  ...............      2*  .............      2:  -------------
21887         . . . .                 . . . .                2 x + 1
21889                                     3                      3
21890 1:  17 x y               1:  (a + b)            1:  (a + b)
21891 @end group
21892 @end smallexample
21894 In this example we select a sub-formula of our original example,
21895 enter a new formula, @key{TAB} it into place, then deselect to see
21896 the complete, edited formula.
21898 If you want to swap whole formulas around even though they contain
21899 selections, just use @kbd{j e} before and after.
21901 @kindex j '
21902 @pindex calc-enter-selection
21903 The @kbd{j '} (@code{calc-enter-selection}) command is another way
21904 to replace a selected sub-formula.  This command does an algebraic
21905 entry just like the regular @kbd{'} key.  When you press @key{RET},
21906 the formula you type replaces the original selection.  You can use
21907 the @samp{$} symbol in the formula to refer to the original
21908 selection.  If there is no selection in the formula under the cursor,
21909 the cursor is used to make a temporary selection for the purposes of
21910 the command.  Thus, to change a term of a formula, all you have to
21911 do is move the Emacs cursor to that term and press @kbd{j '}.
21913 @kindex j `
21914 @pindex calc-edit-selection
21915 The @kbd{j `} (@code{calc-edit-selection}) command is a similar
21916 analogue of the @kbd{`} (@code{calc-edit}) command.  It edits the
21917 selected sub-formula in a separate buffer.  If there is no
21918 selection, it edits the sub-formula indicated by the cursor.
21920 To delete a sub-formula, press @key{DEL}.  This generally replaces
21921 the sub-formula with the constant zero, but in a few suitable contexts
21922 it uses the constant one instead.  The @key{DEL} key automatically
21923 deselects and re-simplifies the entire formula afterwards.  Thus:
21925 @smallexample
21926 @group
21927               ###
21928     17 x y + # #          17 x y         17 # y          17 y
21929 1*  -------------     1:  -------    1*  -------    1:  -------
21930        2 x + 1            2 x + 1        2 x + 1        2 x + 1
21931 @end group
21932 @end smallexample
21934 In this example, we first delete the @samp{sqrt(c)} term; Calc
21935 accomplishes this by replacing @samp{sqrt(c)} with zero and
21936 resimplifying.  We then delete the @kbd{x} in the numerator;
21937 since this is part of a product, Calc replaces it with @samp{1}
21938 and resimplifies.
21940 If you select an element of a vector and press @key{DEL}, that
21941 element is deleted from the vector.  If you delete one side of
21942 an equation or inequality, only the opposite side remains.
21944 @kindex j @key{DEL}
21945 @pindex calc-del-selection
21946 The @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
21949 indicated by the cursor, or, in the absence of a selection, it
21950 deletes the sub-formula indicated by the cursor position.
21952 @kindex j @key{RET}
21953 @pindex calc-grab-selection
21954 (There is also an auto-selecting @kbd{j @key{RET}} (@code{calc-copy-selection})
21955 command.)
21957 Normal arithmetic operations also apply to sub-formulas.  Here we
21958 select the denominator, press @kbd{5 -} to subtract five from the
21959 denominator, press @kbd{n} to negate the denominator, then
21960 press @kbd{Q} to take the square root.
21962 @smallexample
21963 @group
21964      .. .           .. .           .. .             .. .
21965 1*  .......    1*  .......    1*  .......    1*  ..........
21966     2 x + 1        2 x - 4        4 - 2 x         _________
21967                                                  V 4 - 2 x
21968 @end group
21969 @end smallexample
21971 Certain types of operations on selections are not allowed.  For
21972 example, for an arithmetic function like @kbd{-} no more than one of
21973 the arguments may be a selected sub-formula.  (As the above example
21974 shows, the result of the subtraction is spliced back into the argument
21975 which had the selection; if there were more than one selection involved,
21976 this would not be well-defined.)  If you try to subtract two selections,
21977 the command will abort with an error message.
21979 Operations on sub-formulas sometimes leave the formula as a whole
21980 in an ``un-natural'' state.  Consider negating the @samp{2 x} term
21981 of our sample formula by selecting it and pressing @kbd{n}
21982 (@code{calc-change-sign}).
21984 @smallexample
21985 @group
21986        .. .                .. .
21987 1*  ..........      1*  ...........
21988      .........           ..........
21989     . . . 2 x           . . . -2 x
21990 @end group
21991 @end smallexample
21993 Unselecting the sub-formula reveals that the minus sign, which would
21994 normally have cancelled out with the subtraction automatically, has
21995 not been able to do so because the subtraction was not part of the
21996 selected portion.  Pressing @kbd{=} (@code{calc-evaluate}) or doing
21997 any other mathematical operation on the whole formula will cause it
21998 to be simplified.
22000 @smallexample
22001 @group
22002        17 y                17 y
22003 1:  -----------     1:  ----------
22004      __________          _________
22005     V 4 - -2 x          V 4 + 2 x
22006 @end group
22007 @end smallexample
22009 @node Rearranging with Selections, , Operating on Selections, Selecting Subformulas
22010 @subsection Rearranging Formulas using Selections
22012 @noindent
22013 @kindex j R
22014 @pindex calc-commute-right
22015 The @kbd{j R} (@code{calc-commute-right}) command moves the selected
22016 sub-formula to the right in its surrounding formula.  Generally the
22017 selection is one term of a sum or product; the sum or product is
22018 rearranged according to the commutative laws of algebra.
22020 As with @kbd{j '} and @kbd{j @key{DEL}}, the term under the cursor is used
22021 if there is no selection in the current formula.  All commands described
22022 in this section share this property.  In this example, we place the
22023 cursor on the @samp{a} and type @kbd{j R}, then repeat.
22025 @smallexample
22026 1:  a + b - c          1:  b + a - c          1:  b - c + a
22027 @end smallexample
22029 @noindent
22030 Note that in the final step above, the @samp{a} is switched with
22031 the @samp{c} but the signs are adjusted accordingly.  When moving
22032 terms of sums and products, @kbd{j R} will never change the
22033 mathematical meaning of the formula.
22035 The selected term may also be an element of a vector or an argument
22036 of a function.  The term is exchanged with the one to its right.
22037 In this case, the ``meaning'' of the vector or function may of
22038 course be drastically changed.
22040 @smallexample
22041 1:  [a, b, c]          1:  [b, a, c]          1:  [b, c, a]
22043 1:  f(a, b, c)         1:  f(b, a, c)         1:  f(b, c, a)
22044 @end smallexample
22046 @kindex j L
22047 @pindex calc-commute-left
22048 The @kbd{j L} (@code{calc-commute-left}) command is like @kbd{j R}
22049 except that it swaps the selected term with the one to its left.
22051 With numeric prefix arguments, these commands move the selected
22052 term several steps at a time.  It is an error to try to move a
22053 term left or right past the end of its enclosing formula.
22054 With numeric prefix arguments of zero, these commands move the
22055 selected term as far as possible in the given direction.
22057 @kindex j D
22058 @pindex calc-sel-distribute
22059 The @kbd{j D} (@code{calc-sel-distribute}) command mixes the selected
22060 sum or product into the surrounding formula using the distributive
22061 law.  For example, in @samp{a * (b - c)} with the @samp{b - c}
22062 selected, the result is @samp{a b - a c}.  This also distributes
22063 products or quotients into surrounding powers, and can also do
22064 transformations like @samp{exp(a + b)} to @samp{exp(a) exp(b)},
22065 where @samp{a + b} is the selected term, and @samp{ln(a ^ b)}
22066 to @samp{ln(a) b}, where @samp{a ^ b} is the selected term.
22068 For multiple-term sums or products, @kbd{j D} takes off one term
22069 at a time:  @samp{a * (b + c - d)} goes to @samp{a * (c - d) + a b}
22070 with the @samp{c - d} selected so that you can type @kbd{j D}
22071 repeatedly to expand completely.  The @kbd{j D} command allows a
22072 numeric prefix argument which specifies the maximum number of
22073 times to expand at once; the default is one time only.
22075 @vindex DistribRules
22076 The @kbd{j D} command is implemented using rewrite rules.
22077 @xref{Selections with Rewrite Rules}.  The rules are stored in
22078 the Calc variable @code{DistribRules}.  A convenient way to view
22079 these rules is to use @kbd{s e} (@code{calc-edit-variable}) which
22080 displays and edits the stored value of a variable.  Press @kbd{C-c C-c}
22081 to return from editing mode; be careful not to make any actual changes
22082 or else you will affect the behavior of future @kbd{j D} commands!
22084 To extend @kbd{j D} to handle new cases, just edit @code{DistribRules}
22085 as described above.  You can then use the @kbd{s p} command to save
22086 this variable's value permanently for future Calc sessions.
22087 @xref{Operations on Variables}.
22089 @kindex j M
22090 @pindex calc-sel-merge
22091 @vindex MergeRules
22092 The @kbd{j M} (@code{calc-sel-merge}) command is the complement
22093 of @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
22095 again, @kbd{j M} can also merge calls to functions like @code{exp}
22096 and @code{ln}; examine the variable @code{MergeRules} to see all
22097 the relevant rules.
22099 @kindex j C
22100 @pindex calc-sel-commute
22101 @vindex CommuteRules
22102 The @kbd{j C} (@code{calc-sel-commute}) command swaps the arguments
22103 of the selected sum, product, or equation.  It always behaves as
22104 if @kbd{j b} mode were in effect, i.e., the sum @samp{a + b + c} is
22105 treated as the nested sums @samp{(a + b) + c} by this command.
22106 If 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
22108 result is @samp{c + (a + b)} (which the default simplifications
22109 will rearrange to @samp{(c + a) + b}).  The relevant rules are stored
22110 in the variable @code{CommuteRules}.
22112 You may need to turn default simplifications off (with the @kbd{m O}
22113 command) in order to get the full benefit of @kbd{j C}.  For example,
22114 commuting @samp{a - b} produces @samp{-b + a}, but the default
22115 simplifications will ``simplify'' this right back to @samp{a - b} if
22116 you don't turn them off.  The same is true of some of the other
22117 manipulations described in this section.
22119 @kindex j N
22120 @pindex calc-sel-negate
22121 @vindex NegateRules
22122 The @kbd{j N} (@code{calc-sel-negate}) command replaces the selected
22123 term with the negative of that term, then adjusts the surrounding
22124 formula 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
22127 regular @kbd{n} (@code{calc-change-sign}) command negates the
22128 term without adjusting the surroundings, thus changing the meaning
22129 of the formula as a whole.  The rules variable is @code{NegateRules}.
22131 @kindex j &
22132 @pindex calc-sel-invert
22133 @vindex InvertRules
22134 The @kbd{j &} (@code{calc-sel-invert}) command is similar to @kbd{j N}
22135 except it takes the reciprocal of the selected term.  For example,
22136 given @samp{a - ln(b)} with @samp{b} selected, the result is
22137 @samp{a + ln(1/b)}.  The rules variable is @code{InvertRules}.
22139 @kindex j E
22140 @pindex calc-sel-jump-equals
22141 @vindex JumpRules
22142 The @kbd{j E} (@code{calc-sel-jump-equals}) command moves the
22143 selected 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
22146 term is part of a @samp{*}, @samp{/}, or @samp{^} formula.  The
22147 relevant rules variable is @code{JumpRules}.
22149 @kindex j I
22150 @kindex H j I
22151 @pindex calc-sel-isolate
22152 The @kbd{j I} (@code{calc-sel-isolate}) command isolates the
22153 selected 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
22155 Hyperbolic flag affects it in the same way.  @xref{Solving Equations}.
22156 When it applies, @kbd{j I} is often easier to use than @kbd{j E}.
22157 It understands more rules of algebra, and works for inequalities
22158 as well as equations.
22160 @kindex j *
22161 @kindex j /
22162 @pindex calc-sel-mult-both-sides
22163 @pindex calc-sel-div-both-sides
22164 The @kbd{j *} (@code{calc-sel-mult-both-sides}) command prompts for a
22165 formula using algebraic entry, then multiplies both sides of the
22166 selected quotient or equation by that formula.  It simplifies each
22167 side with @kbd{a s} (@code{calc-simplify}) before re-forming the
22168 quotient or equation.  You can suppress this simplification by
22169 providing any numeric prefix argument.  There is also a @kbd{j /}
22170 (@code{calc-sel-div-both-sides}) which is similar to @kbd{j *} but
22171 dividing instead of multiplying by the factor you enter.
22173 As a special feature, if the numerator of the quotient is 1, then
22174 the denominator is expanded at the top level using the distributive
22175 law (i.e., using the @kbd{C-u -1 a x} command).  Suppose the
22176 formula on the stack is @samp{1 / (sqrt(a) + 1)}, and you wish
22177 to eliminate the square root in the denominator by multiplying both
22178 sides by @samp{sqrt(a) - 1}.  Calc's default simplifications would
22179 change the result @samp{(sqrt(a) - 1) / (sqrt(a) - 1) (sqrt(a) + 1)}
22180 right back to the original form by cancellation; Calc expands the
22181 denominator to @samp{sqrt(a) (sqrt(a) - 1) + sqrt(a) - 1} to prevent
22182 this.  (You would now want to use an @kbd{a x} command to expand
22183 the rest of the way, whereupon the denominator would cancel out to
22184 the desired form, @samp{a - 1}.)  When the numerator is not 1, this
22185 initial expansion is not necessary because Calc's default
22186 simplifications will not notice the potential cancellation.
22188 If the selection is an inequality, @kbd{j *} and @kbd{j /} will
22189 accept any factor, but will warn unless they can prove the factor
22190 is either positive or negative.  (In the latter case the direction
22191 of the inequality will be switched appropriately.)  @xref{Declarations},
22192 for ways to inform Calc that a given variable is positive or
22193 negative.  If Calc can't tell for sure what the sign of the factor
22194 will be, it will assume it is positive and display a warning
22195 message.
22197 For selections that are not quotients, equations, or inequalities,
22198 these commands pull out a multiplicative factor:  They divide (or
22199 multiply) by the entered formula, simplify, then multiply (or divide)
22200 back by the formula.
22202 @kindex j +
22203 @kindex j -
22204 @pindex calc-sel-add-both-sides
22205 @pindex calc-sel-sub-both-sides
22206 The @kbd{j +} (@code{calc-sel-add-both-sides}) and @kbd{j -}
22207 (@code{calc-sel-sub-both-sides}) commands analogously add to or
22208 subtract from both sides of an equation or inequality.  For other
22209 types of selections, they extract an additive factor.  A numeric
22210 prefix argument suppresses simplification of the intermediate
22211 results.
22213 @kindex j U
22214 @pindex calc-sel-unpack
22215 The @kbd{j U} (@code{calc-sel-unpack}) command replaces the
22216 selected function call with its argument.  For example, given
22217 @samp{a + sin(x^2)} with @samp{sin(x^2)} selected, the result
22218 is @samp{a + x^2}.  (The @samp{x^2} will remain selected; if you
22219 wanted to change the @code{sin} to @code{cos}, just press @kbd{C}
22220 now to take the cosine of the selected part.)
22222 @kindex j v
22223 @pindex calc-sel-evaluate
22224 The @kbd{j v} (@code{calc-sel-evaluate}) command performs the
22225 normal default simplifications on the selected sub-formula.
22226 These are the simplifications that are normally done automatically
22227 on all results, but which may have been partially inhibited by
22228 previous selection-related operations, or turned off altogether
22229 by the @kbd{m O} command.  This command is just an auto-selecting
22230 version of the @w{@kbd{a v}} command (@pxref{Algebraic Manipulation}).
22232 With a numeric prefix argument of 2, @kbd{C-u 2 j v} applies
22233 the @kbd{a s} (@code{calc-simplify}) command to the selected
22234 sub-formula.  With a prefix argument of 3 or more, e.g., @kbd{C-u j v}
22235 applies the @kbd{a e} (@code{calc-simplify-extended}) command.
22236 @xref{Simplifying Formulas}.  With a negative prefix argument
22237 it simplifies at the top level only, just as with @kbd{a v}.
22238 Here the ``top'' level refers to the top level of the selected
22239 sub-formula.
22241 @kindex j "
22242 @pindex calc-sel-expand-formula
22243 The @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}.
22246 You can use the @kbd{j r} (@code{calc-rewrite-selection}) command
22247 to define other algebraic operations on sub-formulas.  @xref{Rewrite Rules}.
22249 @node Algebraic Manipulation, Simplifying Formulas, Selecting Subformulas, Algebra
22250 @section Algebraic Manipulation
22252 @noindent
22253 The commands in this section perform general-purpose algebraic
22254 manipulations.  They work on the whole formula at the top of the
22255 stack (unless, of course, you have made a selection in that
22256 formula).
22258 Many algebra commands prompt for a variable name or formula.  If you
22259 answer the prompt with a blank line, the variable or formula is taken
22260 from top-of-stack, and the normal argument for the command is taken
22261 from the second-to-top stack level.
22263 @kindex a v
22264 @pindex calc-alg-evaluate
22265 The @kbd{a v} (@code{calc-alg-evaluate}) command performs the normal
22266 default simplifications on a formula; for example, @samp{a - -b} is
22267 changed to @samp{a + b}.  These simplifications are normally done
22268 automatically on all Calc results, so this command is useful only if
22269 you have turned default simplifications off with an @kbd{m O}
22270 command.  @xref{Simplification Modes}.
22272 It is often more convenient to type @kbd{=}, which is like @kbd{a v}
22273 but which also substitutes stored values for variables in the formula.
22274 Use @kbd{a v} if you want the variables to ignore their stored values.
22276 If you give a numeric prefix argument of 2 to @kbd{a v}, it simplifies
22277 as if in Algebraic Simplification mode.  This is equivalent to typing
22278 @kbd{a s}; @pxref{Simplifying Formulas}.  If you give a numeric prefix
22279 of 3 or more, it uses Extended Simplification mode (@kbd{a e}).
22281 If you give a negative prefix argument @mathit{-1}, @mathit{-2}, or @mathit{-3},
22282 it simplifies in the corresponding mode but only works on the top-level
22283 function call of the formula.  For example, @samp{(2 + 3) * (2 + 3)} will
22284 simplify 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])}
22287 in No-Simplify mode.  Using @kbd{a v} will evaluate this all the way to
22288 10; using @kbd{C-u - a v} will evaluate it only to @samp{1 + 2 + 3 + 4}.
22289 (@xref{Reducing and Mapping}.)
22291 @tindex evalv
22292 @tindex evalvn
22293 The @kbd{=} command corresponds to the @code{evalv} function, and
22294 the related @kbd{N} command, which is like @kbd{=} but temporarily
22295 disables Symbolic mode (@kbd{m s}) during the evaluation, corresponds
22296 to the @code{evalvn} function.  (These commands interpret their prefix
22297 arguments differently than @kbd{a v}; @kbd{=} treats the prefix as
22298 the number of stack elements to evaluate at once, and @kbd{N} treats
22299 it as a temporary different working precision.)
22301 The @code{evalvn} function can take an alternate working precision
22302 as an optional second argument.  This argument can be either an
22303 integer, to set the precision absolutely, or a vector containing
22304 a single integer, to adjust the precision relative to the current
22305 precision.  Note that @code{evalvn} with a larger than current
22306 precision will do the calculation at this higher precision, but the
22307 result will as usual be rounded back down to the current precision
22308 afterward.  For example, @samp{evalvn(pi - 3.1415)} at a precision
22309 of 12 will return @samp{9.265359e-5}; @samp{evalvn(pi - 3.1415, 30)}
22310 will return @samp{9.26535897932e-5} (computing a 25-digit result which
22311 is then rounded down to 12); and @samp{evalvn(pi - 3.1415, [-2])}
22312 will return @samp{9.2654e-5}.
22314 @kindex a "
22315 @pindex calc-expand-formula
22316 The @kbd{a "} (@code{calc-expand-formula}) command expands functions
22317 into their defining formulas wherever possible.  For example,
22318 @samp{deg(x^2)} is changed to @samp{180 x^2 / pi}.  Most functions,
22319 like @code{sin} and @code{gcd}, are not defined by simple formulas
22320 and so are unaffected by this command.  One important class of
22321 functions which @emph{can} be expanded is the user-defined functions
22322 created by the @kbd{Z F} command.  @xref{Algebraic Definitions}.
22323 Other functions which @kbd{a "} can expand include the probability
22324 distribution functions, most of the financial functions, and the
22325 hyperbolic and inverse hyperbolic functions.  A numeric prefix argument
22326 affects @kbd{a "} in the same way as it does @kbd{a v}:  A positive
22327 argument expands all functions in the formula and then simplifies in
22328 various ways; a negative argument expands and simplifies only the
22329 top-level function call.
22331 @kindex a M
22332 @pindex calc-map-equation
22333 @tindex mapeq
22334 The @kbd{a M} (@code{calc-map-equation}) [@code{mapeq}] command applies
22335 a given function or operator to one or more equations.  It is analogous
22336 to @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
22339 @samp{x = y+1} and @expr{6} on the stack produces @samp{x+6 = y+7}.
22340 With two equations on the stack, @kbd{a M +} would add the lefthand
22341 sides together and the righthand sides together to get the two
22342 respective sides of a new equation.
22344 Mapping also works on inequalities.  Mapping two similar inequalities
22345 produces another inequality of the same type.  Mapping an inequality
22346 with an equation produces an inequality of the same type.  Mapping a
22347 @samp{<=} with a @samp{<} or @samp{!=} (not-equal) produces a @samp{<}.
22348 If inequalities with opposite direction (e.g., @samp{<} and @samp{>})
22349 are mapped, the direction of the second inequality is reversed to
22350 match the first:  Using @kbd{a M +} on @samp{a < b} and @samp{a > 2}
22351 reverses the latter to get @samp{2 < a}, which then allows the
22352 combination @samp{a + 2 < b + a}, which the @kbd{a s} command can
22353 then simplify to get @samp{2 < b}.
22355 Using @kbd{a M *}, @kbd{a M /}, @kbd{a M n}, or @kbd{a M &} to negate
22356 or invert an inequality will reverse the direction of the inequality.
22357 Other 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
22359 though this is not true for all values of the variables.
22361 @kindex H a M
22362 @tindex mapeqp
22363 With the Hyperbolic flag, @kbd{H a M} [@code{mapeqp}] does a plain
22364 mapping operation without reversing the direction of any inequalities.
22365 Thus, @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
22367 fixing an inequality which was already incorrect.)
22369 @kindex I a M
22370 @tindex mapeqr
22371 With the Inverse flag, @kbd{I a M} [@code{mapeqr}] always reverses
22372 the direction of the inequality.  You might use @kbd{I a M C} to
22373 change @samp{x < y} to @samp{cos(x) > cos(y)} if you know you are
22374 working with small positive angles.
22376 @kindex a b
22377 @pindex calc-substitute
22378 @tindex subst
22379 The @kbd{a b} (@code{calc-substitute}) [@code{subst}] command substitutes
22380 all occurrences
22381 of some variable or sub-expression of an expression with a new
22382 sub-expression.  For example, substituting @samp{sin(x)} with @samp{cos(y)}
22383 in @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)}}.
22385 Note that this is a purely structural substitution; the lone @samp{x} and
22386 the @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
22388 doing substitutions.
22390 The @kbd{a b} command normally prompts for two formulas, the old
22391 one and the new one.  If you enter a blank line for the first
22392 prompt, all three arguments are taken from the stack (new, then old,
22393 then target expression).  If you type an old formula but then enter a
22394 blank line for the new one, the new formula is taken from top-of-stack
22395 and the target from second-to-top.  If you answer both prompts, the
22396 target is taken from top-of-stack as usual.
22398 Note that @kbd{a b} has no understanding of commutativity or
22399 associativity.  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}
22401 because the @samp{+} operator is left-associative, so the ``deep
22402 structure'' of that formula is @samp{(x+y) + z}.  Use @kbd{d U}
22403 (@code{calc-unformatted-language}) mode to see the true structure of
22404 a formula.  The rewrite rule mechanism, discussed later, does not have
22405 these limitations.
22407 As an algebraic function, @code{subst} takes three arguments:
22408 Target expression, old, new.  Note that @code{subst} is always
22409 evaluated immediately, even if its arguments are variables, so if
22410 you wish to put a call to @code{subst} onto the stack you must
22411 turn the default simplifications off first (with @kbd{m O}).
22413 @node Simplifying Formulas, Polynomials, Algebraic Manipulation, Algebra
22414 @section Simplifying Formulas
22416 @noindent
22417 @kindex a s
22418 @pindex calc-simplify
22419 @tindex simplify
22420 The @kbd{a s} (@code{calc-simplify}) [@code{simplify}] command applies
22421 various algebraic rules to simplify a formula.  This includes rules which
22422 are not part of the default simplifications because they may be too slow
22423 to apply all the time, or may not be desirable all of the time.  For
22424 example, non-adjacent terms of sums are combined, as in @samp{a + b + 2 a}
22425 to @samp{b + 3 a}, and some formulas like @samp{sin(arcsin(x))} are
22426 simplified to @samp{x}.
22428 The sections below describe all the various kinds of algebraic
22429 simplifications Calc provides in full detail.  None of Calc's
22430 simplification commands are designed to pull rabbits out of hats;
22431 they simply apply certain specific rules to put formulas into
22432 less redundant or more pleasing forms.  Serious algebra in Calc
22433 must be done manually, usually with a combination of selections
22434 and rewrite rules.  @xref{Rearranging with Selections}.
22435 @xref{Rewrite Rules}.
22437 @xref{Simplification Modes}, for commands to control what level of
22438 simplification occurs automatically.  Normally only the ``default
22439 simplifications'' occur.
22441 @menu
22442 * Default Simplifications::
22443 * Algebraic Simplifications::
22444 * Unsafe Simplifications::
22445 * Simplification of Units::
22446 @end menu
22448 @node Default Simplifications, Algebraic Simplifications, Simplifying Formulas, Simplifying Formulas
22449 @subsection Default Simplifications
22451 @noindent
22452 @cindex Default simplifications
22453 This section describes the ``default simplifications,'' those which are
22454 normally applied to all results.  For example, if you enter the variable
22455 @expr{x} on the stack twice and push @kbd{+}, Calc's default
22456 simplifications automatically change @expr{x + x} to @expr{2 x}.
22458 The @kbd{m O} command turns off the default simplifications, so that
22459 @expr{x + x} will remain in this form unless you give an explicit
22460 ``simplify'' command like @kbd{=} or @kbd{a v}.  @xref{Algebraic
22461 Manipulation}.  The @kbd{m D} command turns the default simplifications
22462 back on.
22464 The most basic default simplification is the evaluation of functions.
22465 For example, @expr{2 + 3} is evaluated to @expr{5}, and @expr{@tfn{sqrt}(9)}
22466 is evaluated to @expr{3}.  Evaluation does not occur if the arguments
22467 to a function are somehow of the wrong type @expr{@tfn{tan}([2,3,4])}),
22468 range (@expr{@tfn{tan}(90)}), or number (@expr{@tfn{tan}(3,5)}), 
22469 or if the function name is not recognized (@expr{@tfn{f}(5)}), or if
22470 Symbolic mode (@pxref{Symbolic Mode}) prevents evaluation
22471 (@expr{@tfn{sqrt}(2)}).
22473 Calc simplifies (evaluates) the arguments to a function before it
22474 simplifies the function itself.  Thus @expr{@tfn{sqrt}(5+4)} is
22475 simplified to @expr{@tfn{sqrt}(9)} before the @code{sqrt} function
22476 itself is applied.  There are very few exceptions to this rule:
22477 @code{quote}, @code{lambda}, and @code{condition} (the @code{::}
22478 operator) do not evaluate their arguments, @code{if} (the @code{? :}
22479 operator) does not evaluate all of its arguments, and @code{evalto}
22480 does not evaluate its lefthand argument.
22482 Most commands apply the default simplifications to all arguments they
22483 take from the stack, perform a particular operation, then simplify
22484 the result before pushing it back on the stack.  In the common special
22485 case of regular arithmetic commands like @kbd{+} and @kbd{Q} [@code{sqrt}],
22486 the arguments are simply popped from the stack and collected into a
22487 suitable function call, which is then simplified (the arguments being
22488 simplified first as part of the process, as described above).
22490 The default simplifications are too numerous to describe completely
22491 here, but this section will describe the ones that apply to the
22492 major arithmetic operators.  This list will be rather technical in
22493 nature, and will probably be interesting to you only if you are
22494 a serious user of Calc's algebra facilities.
22496 @tex
22497 \bigskip
22498 @end tex
22500 As well as the simplifications described here, if you have stored
22501 any rewrite rules in the variable @code{EvalRules} then these rules
22502 will also be applied before any built-in default simplifications.
22503 @xref{Automatic Rewrites}, for details.
22505 @tex
22506 \bigskip
22507 @end tex
22509 And now, on with the default simplifications:
22511 Arithmetic operators like @kbd{+} and @kbd{*} always take two
22512 arguments in Calc's internal form.  Sums and products of three or
22513 more terms are arranged by the associative law of algebra into
22514 a left-associative form for sums, @expr{((a + b) + c) + d}, and
22515 a right-associative form for products, @expr{a * (b * (c * d))}.
22516 Formulas like @expr{(a + b) + (c + d)} are rearranged to
22517 left-associative form, though this rarely matters since Calc's
22518 algebra commands are designed to hide the inner structure of
22519 sums and products as much as possible.  Sums and products in
22520 their proper associative form will be written without parentheses
22521 in the examples below.
22523 Sums and products are @emph{not} rearranged according to the
22524 commutative law (@expr{a + b} to @expr{b + a}) except in a few
22525 special cases described below.  Some algebra programs always
22526 rearrange terms into a canonical order, which enables them to
22527 see that @expr{a b + b a} can be simplified to @expr{2 a b}.
22528 Calc assumes you have put the terms into the order you want
22529 and generally leaves that order alone, with the consequence
22530 that formulas like the above will only be simplified if you
22531 explicitly give the @kbd{a s} command.  @xref{Algebraic
22532 Simplifications}.
22534 Differences @expr{a - b} are treated like sums @expr{a + (-b)}
22535 for purposes of simplification; one of the default simplifications
22536 is to rewrite @expr{a + (-b)} or @expr{(-b) + a}, where @expr{-b}
22537 represents a ``negative-looking'' term, into @expr{a - b} form.
22538 ``Negative-looking'' means negative numbers, negated formulas like
22539 @expr{-x}, and products or quotients in which either term is
22540 negative-looking.
22542 Other 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
22544 negative-looking, simplified by negating that term, or else where
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
22548 cases where the order of terms in a sum is changed by the default
22549 simplifications.)
22551 The distributive law is used to simplify sums in some cases:
22552 @expr{a x + b x} to @expr{(a + b) x}, where @expr{a} represents
22553 a number or an implicit 1 or @mathit{-1} (as in @expr{x} or @expr{-x})
22554 and similarly for @expr{b}.  Use the @kbd{a c}, @w{@kbd{a f}}, or
22555 @kbd{j M} commands to merge sums with non-numeric coefficients
22556 using the distributive law.
22558 The distributive law is only used for sums of two terms, or
22559 for adjacent terms in a larger sum.  Thus @expr{a + b + b + c}
22560 is simplified to @expr{a + 2 b + c}, but @expr{a + b + c + b}
22561 is not simplified.  The reason is that comparing all terms of a
22562 sum with one another would require time proportional to the
22563 square of the number of terms; Calc relegates potentially slow
22564 operations like this to commands that have to be invoked
22565 explicitly, like @kbd{a s}.
22567 Finally, @expr{a + 0} and @expr{0 + a} are simplified to @expr{a}.
22568 A consequence of the above rules is that @expr{0 - a} is simplified
22569 to @expr{-a}.
22571 @tex
22572 \bigskip
22573 @end tex
22575 The 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
22578 in Matrix mode where @expr{a} is not provably scalar the result
22579 is the generic zero matrix @samp{idn(0)}, and that if @expr{a} is
22580 infinite the result is @samp{nan}.
22582 Also, @expr{(-a) b} and @expr{a (-b)} are simplified to @expr{-(a b)},
22583 where this occurs for negated formulas but not for regular negative
22584 numbers.
22586 Products are commuted only to move numbers to the front:
22587 @expr{a b 2} is commuted to @expr{2 a b}.
22589 The 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
22593 rewritten to @expr{a (c - b)}.
22595 The distributive law of products and powers is used for adjacent
22596 terms of the product: @expr{x^a x^b} goes to 
22597 @texline @math{x^{a+b}}
22598 @infoline @expr{x^(a+b)}
22599 where @expr{a} is a number, or an implicit 1 (as in @expr{x}),
22600 or the implicit one-half of @expr{@tfn{sqrt}(x)}, and similarly for
22601 @expr{b}.  The result is written using @samp{sqrt} or @samp{1/sqrt}
22602 if the sum of the powers is @expr{1/2} or @expr{-1/2}, respectively.
22603 If the sum of the powers is zero, the product is simplified to
22604 @expr{1} or to @samp{idn(1)} if Matrix mode is enabled.
22606 The product of a negative power times anything but another negative
22607 power is changed to use division:  
22608 @texline @math{x^{-2} y}
22609 @infoline @expr{x^(-2) y} 
22610 goes to @expr{y / x^2} unless Matrix mode is
22611 in effect and neither @expr{x} nor @expr{y} are scalar (in which
22612 case it is considered unsafe to rearrange the order of the terms).
22614 Finally, @expr{a (b/c)} is rewritten to @expr{(a b)/c}, and also
22615 @expr{(a/b) c} is changed to @expr{(a c)/b} unless in Matrix mode.
22617 @tex
22618 \bigskip
22619 @end tex
22621 Simplifications for quotients are analogous to those for products.
22622 The quotient @expr{0 / x} is simplified to @expr{0}, with the same
22623 exceptions that were noted for @expr{0 x}.  Likewise, @expr{x / 1}
22624 and @expr{x / (-1)} are simplified to @expr{x} and @expr{-x},
22625 respectively.
22627 The quotient @expr{x / 0} is left unsimplified or changed to an
22628 infinite quantity, as directed by the current infinite mode.
22629 @xref{Infinite Mode}.
22631 The expression 
22632 @texline @math{a / b^{-c}}
22633 @infoline @expr{a / b^(-c)} 
22634 is changed to @expr{a b^c}, where @expr{-c} is any negative-looking
22635 power.  Also, @expr{1 / b^c} is changed to 
22636 @texline @math{b^{-c}}
22637 @infoline @expr{b^(-c)} 
22638 for any power @expr{c}.
22640 Also, @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)}
22642 goes to @expr{(a c) / b} unless Matrix mode prevents this
22643 rearrangement.  Similarly, @expr{a / (b:c)} is simplified to
22644 @expr{(c:b) a} for any fraction @expr{b:c}.
22646 The 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.
22648 Quotients of powers and square roots are distributed just as
22649 described for multiplication.
22651 Quotients of products cancel only in the leading terms of the
22652 numerator and denominator.  In other words, @expr{a x b / a y b}
22653 is cancelled to @expr{x b / y b} but not to @expr{x / y}.  Once
22654 again this is because full cancellation can be slow; use @kbd{a s}
22655 to cancel all terms of the quotient.
22657 Quotients of negative-looking values are simplified according
22658 to @expr{(-a) / (-b)} to @expr{a / b}, @expr{(-a) / (b - c)}
22659 to @expr{a / (c - b)}, and @expr{(a - b) / (-c)} to @expr{(b - a) / c}.
22661 @tex
22662 \bigskip
22663 @end tex
22665 The formula @expr{x^0} is simplified to @expr{1}, or to @samp{idn(1)}
22666 in Matrix mode.  The formula @expr{0^x} is simplified to @expr{0}
22667 unless @expr{x} is a negative number, complex number or zero.
22668 If @expr{x} is negative, complex or @expr{0.0}, @expr{0^x} is an
22669 infinity or an unsimplified formula according to the current infinite
22670 mode.  The expression @expr{0^0} is simplified to @expr{1}.
22672 Powers of products or quotients @expr{(a b)^c}, @expr{(a/b)^c}
22673 are distributed to @expr{a^c b^c}, @expr{a^c / b^c} only if @expr{c}
22674 is an integer, or if either @expr{a} or @expr{b} are nonnegative
22675 real numbers.  Powers of powers @expr{(a^b)^c} are simplified to
22676 @texline @math{a^{b c}}
22677 @infoline @expr{a^(b c)} 
22678 only when @expr{c} is an integer and @expr{b c} also
22679 evaluates to an integer.  Without these restrictions these simplifications
22680 would not be safe because of problems with principal values.
22681 (In other words, 
22682 @texline @math{((-3)^{1/2})^2}
22683 @infoline @expr{((-3)^1:2)^2} 
22684 is safe to simplify, but
22685 @texline @math{((-3)^2)^{1/2}}
22686 @infoline @expr{((-3)^2)^1:2} 
22687 is not.)  @xref{Declarations}, for ways to inform Calc that your
22688 variables satisfy these requirements.
22690 As a special case of this rule, @expr{@tfn{sqrt}(x)^n} is simplified to
22691 @texline @math{x^{n/2}}
22692 @infoline @expr{x^(n/2)} 
22693 only for even integers @expr{n}.
22695 If @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
22697 simplified to @expr{@tfn{abs}(a^(b c))}.
22699 Also, @expr{(-a)^b} is simplified to @expr{a^b} if @expr{b} is an
22700 even integer, or to @expr{-(a^b)} if @expr{b} is an odd integer,
22701 for any negative-looking expression @expr{-a}.
22703 Square roots @expr{@tfn{sqrt}(x)} generally act like one-half powers
22704 @texline @math{x^{1:2}}
22705 @infoline @expr{x^1:2} 
22706 for the purposes of the above-listed simplifications.
22708 Also, note that 
22709 @texline @math{1 / x^{1:2}}
22710 @infoline @expr{1 / x^1:2} 
22711 is changed to 
22712 @texline @math{x^{-1:2}},
22713 @infoline @expr{x^(-1:2)},
22714 but @expr{1 / @tfn{sqrt}(x)} is left alone.
22716 @tex
22717 \bigskip
22718 @end tex
22720 Generic identity matrices (@pxref{Matrix Mode}) are simplified by the
22721 following rules:  @expr{@tfn{idn}(a) + b} to @expr{a + b} if @expr{b}
22722 is provably scalar, or expanded out if @expr{b} is a matrix;
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} 
22726 if @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
22729 @expr{n} is an integer.
22731 @tex
22732 \bigskip
22733 @end tex
22735 The @code{floor} function and other integer truncation functions
22736 vanish if the argument is provably integer-valued, so that
22737 @expr{@tfn{floor}(@tfn{round}(x))} simplifies to @expr{@tfn{round}(x)}.
22738 Also, combinations of @code{float}, @code{floor} and its friends,
22739 and @code{ffloor} and its friends, are simplified in appropriate
22740 ways.  @xref{Integer Truncation}.
22742 The expression @expr{@tfn{abs}(-x)} changes to @expr{@tfn{abs}(x)}.
22743 The 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
22745 @expr{-x} if @expr{x} is provably nonnegative or nonpositive
22746 (@pxref{Declarations}). 
22748 While most functions do not recognize the variable @code{i} as an
22749 imaginary number, the @code{arg} function does handle the two cases
22750 @expr{@tfn{arg}(@tfn{i})} and @expr{@tfn{arg}(-@tfn{i})} just for convenience.
22752 The expression @expr{@tfn{conj}(@tfn{conj}(x))} simplifies to @expr{x}.
22753 Various other expressions involving @code{conj}, @code{re}, and
22754 @code{im} are simplified, especially if some of the arguments are
22755 provably real or involve the constant @code{i}.  For example,
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}
22758 and @expr{b} are known to be real.
22760 Functions like @code{sin} and @code{arctan} generally don't have
22761 any default simplifications beyond simply evaluating the functions
22762 for suitable numeric arguments and infinity.  The @kbd{a s} command
22763 described in the next section does provide some simplifications for
22764 these functions, though.
22766 One important simplification that does occur is that
22767 @expr{@tfn{ln}(@tfn{e})} is simplified to 1, and @expr{@tfn{ln}(@tfn{e}^x)} is
22768 simplified to @expr{x} for any @expr{x}.  This occurs even if you have
22769 stored a different value in the Calc variable @samp{e}; but this would
22770 be a bad idea in any case if you were also using natural logarithms!
22772 Among the logical functions, @tfn{!(@var{a} <= @var{b})} changes to
22773 @tfn{@var{a} > @var{b}} and so on.  Equations and inequalities where both sides
22774 are either negative-looking or zero are simplified by negating both sides
22775 and reversing the inequality.  While it might seem reasonable to simplify
22776 @expr{!!x} to @expr{x}, this would not be valid in general because
22777 @expr{!!2} is 1, not 2.
22779 Most other Calc functions have few if any default simplifications
22780 defined, aside of course from evaluation when the arguments are
22781 suitable numbers.
22783 @node Algebraic Simplifications, Unsafe Simplifications, Default Simplifications, Simplifying Formulas
22784 @subsection Algebraic Simplifications
22786 @noindent
22787 @cindex Algebraic simplifications
22788 The @kbd{a s} command makes simplifications that may be too slow to
22789 do all the time, or that may not be desirable all of the time.
22790 If you find these simplifications are worthwhile, you can type
22791 @kbd{m A} to have Calc apply them automatically.
22793 This section describes all simplifications that are performed by
22794 the @kbd{a s} command.  Note that these occur in addition to the
22795 default simplifications; even if the default simplifications have
22796 been turned off by an @kbd{m O} command, @kbd{a s} will turn them
22797 back on temporarily while it simplifies the formula.
22799 There is a variable, @code{AlgSimpRules}, in which you can put rewrites
22800 to be applied by @kbd{a s}.  Its use is analogous to @code{EvalRules},
22801 but without the special restrictions.  Basically, the simplifier does
22802 @samp{@w{a r} AlgSimpRules} with an infinite repeat count on the whole
22803 expression being simplified, then it traverses the expression applying
22804 the built-in rules described below.  If the result is different from
22805 the original expression, the process repeats with the default
22806 simplifications (including @code{EvalRules}), then @code{AlgSimpRules},
22807 then the built-in simplifications, and so on.
22809 @tex
22810 \bigskip
22811 @end tex
22813 Sums are simplified in two ways.  Constant terms are commuted to the
22814 end of the sum, so that @expr{a + 2 + b} changes to @expr{a + b + 2}.
22815 The only exception is that a constant will not be commuted away
22816 from the first position of a difference, i.e., @expr{2 - x} is not
22817 commuted to @expr{-x + 2}.
22819 Also, terms of sums are combined by the distributive law, as in
22820 @expr{x + y + 2 x} to @expr{y + 3 x}.  This always occurs for
22821 adjacent terms, but @kbd{a s} compares all pairs of terms including
22822 non-adjacent ones.
22824 @tex
22825 \bigskip
22826 @end tex
22828 Products are sorted into a canonical order using the commutative
22829 law.  For example, @expr{b c a} is commuted to @expr{a b c}.
22830 This allows easier comparison of products; for example, the default
22831 simplifications will not change @expr{x y + y x} to @expr{2 x y},
22832 but @kbd{a s} will; it first rewrites the sum to @expr{x y + x y},
22833 and then the default simplifications are able to recognize a sum
22834 of identical terms.
22836 The canonical ordering used to sort terms of products has the
22837 property that real-valued numbers, interval forms and infinities
22838 come first, and are sorted into increasing order.  The @kbd{V S}
22839 command uses the same ordering when sorting a vector.
22841 Sorting of terms of products is inhibited when Matrix mode is
22842 turned on; in this case, Calc will never exchange the order of
22843 two terms unless it knows at least one of the terms is a scalar.
22845 Products of powers are distributed by comparing all pairs of
22846 terms, using the same method that the default simplifications
22847 use for adjacent terms of products.
22849 Even though sums are not sorted, the commutative law is still
22850 taken into account when terms of a product are being compared.
22851 Thus @expr{(x + y) (y + x)} will be simplified to @expr{(x + y)^2}.
22852 A subtle point is that @expr{(x - y) (y - x)} will @emph{not}
22853 be simplified to @expr{-(x - y)^2}; Calc does not notice that
22854 one term can be written as a constant times the other, even if
22855 that constant is @mathit{-1}.
22857 A fraction times any expression, @expr{(a:b) x}, is changed to
22858 a quotient involving integers:  @expr{a x / b}.  This is not
22859 done for floating-point numbers like @expr{0.5}, however.  This
22860 is one reason why you may find it convenient to turn Fraction mode
22861 on while doing algebra; @pxref{Fraction Mode}.
22863 @tex
22864 \bigskip
22865 @end tex
22867 Quotients are simplified by comparing all terms in the numerator
22868 with all terms in the denominator for possible cancellation using
22869 the distributive law.  For example, @expr{a x^2 b / c x^3 d} will
22870 cancel @expr{x^2} from the top and bottom to get @expr{a b / c x d}.
22871 (The terms in the denominator will then be rearranged to @expr{c d x}
22872 as described above.)  If there is any common integer or fractional
22873 factor in the numerator and denominator, it is cancelled out;
22874 for example, @expr{(4 x + 6) / 8 x} simplifies to @expr{(2 x + 3) / 4 x}.
22876 Non-constant common factors are not found even by @kbd{a s}.  To
22877 cancel the factor @expr{a} in @expr{(a x + a) / a^2} you could first
22878 use @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.
22881 @tex
22882 \bigskip
22883 @end tex
22885 Integer powers of the variable @code{i} are simplified according
22886 to the identity @expr{i^2 = -1}.  If you store a new value other
22887 than the complex number @expr{(0,1)} in @code{i}, this simplification
22888 will no longer occur.  This is done by @kbd{a s} instead of by default
22889 in case someone (unwisely) uses the name @code{i} for a variable
22890 unrelated to complex numbers; it would be unfortunate if Calc
22891 quietly and automatically changed this formula for reasons the
22892 user might not have been thinking of.
22894 Square roots of integer or rational arguments are simplified in
22895 several ways.  (Note that these will be left unevaluated only in
22896 Symbolic mode.)  First, square integer or rational factors are
22897 pulled out so that @expr{@tfn{sqrt}(8)} is rewritten as
22898 @texline @math{2\,@tfn{sqrt}(2)}.
22899 @infoline @expr{2 sqrt(2)}.  
22900 Conceptually speaking this implies factoring the argument into primes
22901 and moving pairs of primes out of the square root, but for reasons of
22902 efficiency Calc only looks for primes up to 29.
22904 Square roots in the denominator of a quotient are moved to the
22905 numerator:  @expr{1 / @tfn{sqrt}(3)} changes to @expr{@tfn{sqrt}(3) / 3}.
22906 The same effect occurs for the square root of a fraction:
22907 @expr{@tfn{sqrt}(2:3)} changes to @expr{@tfn{sqrt}(6) / 3}.
22909 @tex
22910 \bigskip
22911 @end tex
22913 The @code{%} (modulo) operator is simplified in several ways
22914 when the modulus @expr{M} is a positive real number.  First, if
22915 the 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
22917 example, @samp{(x - 23) % 10} is simplified to @samp{(x + 7) % 10}.
22919 If the argument is multiplied by a constant, and this constant
22920 has a common integer divisor with the modulus, then this factor is
22921 cancelled 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}
22923 is changed to @samp{3 ((4 x + 1:3) % 5)}.  While these forms may
22924 not seem ``simpler,'' they allow Calc to discover useful information
22925 about modulo forms in the presence of declarations.
22927 If the modulus is 1, then Calc can use @code{int} declarations to
22928 evaluate the expression.  For example, the idiom @samp{x % 2} is
22929 often used to check whether a number is odd or even.  As described
22930 above, @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
22932 can simplify these to 0 and 1 (respectively) if @code{n} has been
22933 declared to be an integer.
22935 @tex
22936 \bigskip
22937 @end tex
22939 Trigonometric functions are simplified in several ways.  Whenever a
22940 products of two trigonometric functions can be replaced by a single
22941 function, the replacement is made; for example,
22942 @expr{@tfn{tan}(x) @tfn{cos}(x)} is simplified to @expr{@tfn{sin}(x)}. 
22943 Reciprocals of trigonometric functions are replaced by their reciprocal
22944 function; for example, @expr{1/@tfn{sec}(x)} is simplified to
22945 @expr{@tfn{cos}(x)}.  The corresponding simplifications for the
22946 hyperbolic functions are also handled.
22948 Trigonometric functions of their inverse functions are
22949 simplified. The expression @expr{@tfn{sin}(@tfn{arcsin}(x))} is
22950 simplified to @expr{x}, and similarly for @code{cos} and @code{tan}.  
22951 Trigonometric functions of inverses of different trigonometric
22952 functions can also be simplified, as in @expr{@tfn{sin}(@tfn{arccos}(x))}
22953 to @expr{@tfn{sqrt}(1 - x^2)}.
22955 If 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}.
22957 Finally, certain special values of the argument are recognized;
22958 @pxref{Trigonometric and Hyperbolic Functions}.
22960 Hyperbolic functions of their inverses and of negative-looking
22961 arguments are also handled, as are exponentials of inverse
22962 hyperbolic functions.
22964 No simplifications for inverse trigonometric and hyperbolic
22965 functions are known, except for negative arguments of @code{arcsin},
22966 @code{arctan}, @code{arcsinh}, and @code{arctanh}.  Note that
22967 @expr{@tfn{arcsin}(@tfn{sin}(x))} can @emph{not} safely change to
22968 @expr{x}, since this only correct within an integer multiple of 
22969 @texline @math{2 \pi}
22970 @infoline @expr{2 pi} 
22971 radians or 360 degrees.  However, @expr{@tfn{arcsinh}(@tfn{sinh}(x))} is
22972 simplified to @expr{x} if @expr{x} is known to be real.
22974 Several simplifications that apply to logarithms and exponentials
22975 are that @expr{@tfn{exp}(@tfn{ln}(x))}, 
22976 @texline @tfn{e}@math{^{\ln(x)}},
22977 @infoline @expr{e^@tfn{ln}(x)}, 
22979 @texline @math{10^{{\rm log10}(x)}}
22980 @infoline @expr{10^@tfn{log10}(x)} 
22981 all reduce to @expr{x}.  Also, @expr{@tfn{ln}(@tfn{exp}(x))}, etc., can
22982 reduce to @expr{x} if @expr{x} is provably real.  The form
22983 @expr{@tfn{exp}(x)^y} is simplified to @expr{@tfn{exp}(x y)}.  If @expr{x}
22984 is a suitable multiple of 
22985 @texline @math{\pi i} 
22986 @infoline @expr{pi i}
22987 (as described above for the trigonometric functions), then
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
22990 @code{i} where @expr{x} is provably negative, positive imaginary, or
22991 negative imaginary. 
22993 The error functions @code{erf} and @code{erfc} are simplified when
22994 their arguments are negative-looking or are calls to the @code{conj}
22995 function.
22997 @tex
22998 \bigskip
22999 @end tex
23001 Equations and inequalities are simplified by cancelling factors
23002 of products, quotients, or sums on both sides.  Inequalities
23003 change sign if a negative multiplicative factor is cancelled.
23004 Non-constant multiplicative factors as in @expr{a b = a c} are
23005 cancelled from equations only if they are provably nonzero (generally
23006 because they were declared so; @pxref{Declarations}).  Factors
23007 are cancelled from inequalities only if they are nonzero and their
23008 sign is known.
23010 Simplification also replaces an equation or inequality with
23011 1 or 0 (``true'' or ``false'') if it can through the use of
23012 declarations.  If @expr{x} is declared to be an integer greater
23013 than 5, then @expr{x < 3}, @expr{x = 3}, and @expr{x = 7.5} are
23014 all simplified to 0, but @expr{x > 3} is simplified to 1.
23015 By a similar analysis, @expr{abs(x) >= 0} is simplified to 1,
23016 as is @expr{x^2 >= 0} if @expr{x} is known to be real.
23018 @node Unsafe Simplifications, Simplification of Units, Algebraic Simplifications, Simplifying Formulas
23019 @subsection ``Unsafe'' Simplifications
23021 @noindent
23022 @cindex Unsafe simplifications
23023 @cindex Extended simplification
23024 @kindex a e
23025 @pindex calc-simplify-extended
23026 @ignore
23027 @mindex esimpl@idots
23028 @end ignore
23029 @tindex esimplify
23030 The @kbd{a e} (@code{calc-simplify-extended}) [@code{esimplify}] command
23031 is like @kbd{a s}
23032 except that it applies some additional simplifications which are not
23033 ``safe'' in all cases.  Use this only if you know the values in your
23034 formula lie in the restricted ranges for which these simplifications
23035 are valid.  The symbolic integrator uses @kbd{a e};
23036 one effect of this is that the integrator's results must be used with
23037 caution.  Where an integral table will often attach conditions like
23038 ``for positive @expr{a} only,'' Calc (like most other symbolic
23039 integration programs) will simply produce an unqualified result.
23041 Because @kbd{a e}'s simplifications are unsafe, it is sometimes better
23042 to type @kbd{C-u -3 a v}, which does extended simplification only
23043 on the top level of the formula without affecting the sub-formulas.
23044 In fact, @kbd{C-u -3 j v} allows you to target extended simplification
23045 to any specific part of a formula.
23047 The variable @code{ExtSimpRules} contains rewrites to be applied by
23048 the @kbd{a e} command.  These are applied in addition to
23049 @code{EvalRules} and @code{AlgSimpRules}.  (The @kbd{a r AlgSimpRules}
23050 step described above is simply followed by an @kbd{a r ExtSimpRules} step.)
23052 Following is a complete list of ``unsafe'' simplifications performed
23053 by @kbd{a e}.
23055 @tex
23056 \bigskip
23057 @end tex
23059 Inverse trigonometric or hyperbolic functions, called with their
23060 corresponding non-inverse functions as arguments, are simplified
23061 by @kbd{a e}.  For example, @expr{@tfn{arcsin}(@tfn{sin}(x))} changes
23062 to @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}.
23064 These simplifications are unsafe because they are valid only for
23065 values of @expr{x} in a certain range; outside that range, values
23066 are folded down to the 360-degree range that the inverse trigonometric
23067 functions always produce.
23069 Powers of powers @expr{(x^a)^b} are simplified to 
23070 @texline @math{x^{a b}}
23071 @infoline @expr{x^(a b)}
23072 for all @expr{a} and @expr{b}.  These results will be valid only
23073 in a restricted range of @expr{x}; for example, in 
23074 @texline @math{(x^2)^{1:2}}
23075 @infoline @expr{(x^2)^1:2}
23076 the powers cancel to get @expr{x}, which is valid for positive values
23077 of @expr{x} but not for negative or complex values.
23079 Similarly, @expr{@tfn{sqrt}(x^a)} and @expr{@tfn{sqrt}(x)^a} are both
23080 simplified (possibly unsafely) to 
23081 @texline @math{x^{a/2}}.
23082 @infoline @expr{x^(a/2)}.
23084 Forms 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},
23086 @code{cos}, @code{tan}, @code{sinh}, and @code{cosh}.
23088 Arguments of square roots are partially factored to look for
23089 squared terms that can be extracted.  For example,
23090 @expr{@tfn{sqrt}(a^2 b^3 + a^3 b^2)} simplifies to 
23091 @expr{a b @tfn{sqrt}(a+b)}.
23093 The 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
23095 unsafe because of problems with principal values (although these
23096 simplifications are safe if @expr{x} is known to be real).
23098 Common factors are cancelled from products on both sides of an
23099 equation, even if those factors may be zero:  @expr{a x / b x}
23100 to @expr{a / b}.  Such factors are never cancelled from
23101 inequalities:  Even @kbd{a e} is not bold enough to reduce
23102 @expr{a x < b x} to @expr{a < b} (or @expr{a > b}, depending
23103 on whether you believe @expr{x} is positive or negative).
23104 The @kbd{a M /} command can be used to divide a factor out of
23105 both sides of an inequality.
23107 @node Simplification of Units, , Unsafe Simplifications, Simplifying Formulas
23108 @subsection Simplification of Units
23110 @noindent
23111 The simplifications described in this section are applied by the
23112 @kbd{u s} (@code{calc-simplify-units}) command.  These are in addition
23113 to the regular @kbd{a s} (but not @kbd{a e}) simplifications described
23114 earlier.  @xref{Basic Operations on Units}.
23116 The variable @code{UnitSimpRules} contains rewrites to be applied by
23117 the @kbd{u s} command.  These are applied in addition to @code{EvalRules}
23118 and @code{AlgSimpRules}.
23120 Scalar mode is automatically put into effect when simplifying units.
23121 @xref{Matrix Mode}.
23123 Sums @expr{a + b} involving units are simplified by extracting the
23124 units 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}
23126 using @kbd{u b} and @kbd{u s}.  If the result has units then the sum
23127 is inconsistent and is left alone.  Otherwise, it is rewritten
23128 in terms of the units @expr{u_a}.
23130 If units auto-ranging mode is enabled, products or quotients in
23131 which the first argument is a number which is out of range for the
23132 leading unit are modified accordingly.
23134 When cancelling and combining units in products and quotients,
23135 Calc accounts for unit names that differ only in the prefix letter.
23136 For example, @samp{2 km m} is simplified to @samp{2000 m^2}.
23137 However, compatible but different units like @code{ft} and @code{in}
23138 are not combined in this way.
23140 Quotients @expr{a / b} are simplified in three additional ways.  First,
23141 if @expr{b} is a number or a product beginning with a number, Calc
23142 computes the reciprocal of this number and moves it to the numerator.
23144 Second, for each pair of unit names from the numerator and denominator
23145 of a quotient, if the units are compatible (e.g., they are both
23146 units of area) then they are replaced by the ratio between those
23147 units.  For example, in @samp{3 s in N / kg cm} the units
23148 @samp{in / cm} will be replaced by @expr{2.54}.
23150 Third, if the units in the quotient exactly cancel out, so that
23151 a @kbd{u b} command on the quotient would produce a dimensionless
23152 number for an answer, then the quotient simplifies to that number.
23154 For powers and square roots, the ``unsafe'' simplifications
23155 @expr{(a b)^c} to @expr{a^c b^c}, @expr{(a/b)^c} to @expr{a^c / b^c},
23156 and @expr{(a^b)^c} to 
23157 @texline @math{a^{b c}}
23158 @infoline @expr{a^(b c)} 
23159 are done if the powers are real numbers.  (These are safe in the context
23160 of units because all numbers involved can reasonably be assumed to be
23161 real.)
23163 Also, if a unit name is raised to a fractional power, and the
23164 base units in that unit name all occur to powers which are a
23165 multiple of the denominator of the power, then the unit name
23166 is expanded out into its base units, which can then be simplified
23167 according to the previous paragraph.  For example, @samp{acre^1.5}
23168 is simplified by noting that @expr{1.5 = 3:2}, that @samp{acre}
23169 is defined in terms of @samp{m^2}, and that the 2 in the power of
23170 @code{m} is a multiple of 2 in @expr{3:2}.  Thus, @code{acre^1.5} is
23171 replaced by approximately 
23172 @texline @math{(4046 m^2)^{1.5}}
23173 @infoline @expr{(4046 m^2)^1.5}, 
23174 which is then changed to 
23175 @texline @math{4046^{1.5} \, (m^2)^{1.5}},
23176 @infoline @expr{4046^1.5 (m^2)^1.5}, 
23177 then to @expr{257440 m^3}.
23179 The functions @code{float}, @code{frac}, @code{clean}, @code{abs},
23180 as well as @code{floor} and the other integer truncation functions,
23181 applied to unit names or products or quotients involving units, are
23182 simplified.  For example, @samp{round(1.6 in)} is changed to
23183 @samp{round(1.6) round(in)}; the lefthand term evaluates to 2,
23184 and the righthand term simplifies to @code{in}.
23186 The functions @code{sin}, @code{cos}, and @code{tan} with arguments
23187 that have angular units like @code{rad} or @code{arcmin} are
23188 simplified by converting to base units (radians), then evaluating
23189 with the angular mode temporarily set to radians.
23191 @node Polynomials, Calculus, Simplifying Formulas, Algebra
23192 @section Polynomials
23194 A @dfn{polynomial} is a sum of terms which are coefficients times
23195 various powers of a ``base'' variable.  For example, @expr{2 x^2 + 3 x - 4}
23196 is a polynomial in @expr{x}.  Some formulas can be considered
23197 polynomials in several different variables:  @expr{1 + 2 x + 3 y + 4 x y^2}
23198 is a polynomial in both @expr{x} and @expr{y}.  Polynomial coefficients
23199 are often numbers, but they may in general be any formulas not
23200 involving the base variable.
23202 @kindex a f
23203 @pindex calc-factor
23204 @tindex factor
23205 The @kbd{a f} (@code{calc-factor}) [@code{factor}] command factors a
23206 polynomial into a product of terms.  For example, the polynomial
23207 @expr{x^3 + 2 x^2 + x} is factored into @samp{x*(x+1)^2}.  As another
23208 example, @expr{a c + b d + b c + a d} is factored into the product
23209 @expr{(a + b) (c + d)}.
23211 Calc currently has three algorithms for factoring.  Formulas which are
23212 linear in several variables, such as the second example above, are
23213 merged according to the distributive law.  Formulas which are
23214 polynomials in a single variable, with constant integer or fractional
23215 coefficients, are factored into irreducible linear and/or quadratic
23216 terms.  The first example above factors into three linear terms
23217 (@expr{x}, @expr{x+1}, and @expr{x+1} again).  Finally, formulas
23218 which do not fit the above criteria are handled by the algebraic
23219 rewrite mechanism.
23221 Calc's polynomial factorization algorithm works by using the general
23222 root-finding command (@w{@kbd{a P}}) to solve for the roots of the
23223 polynomial.  It then looks for roots which are rational numbers
23224 or complex-conjugate pairs, and converts these into linear and
23225 quadratic terms, respectively.  Because it uses floating-point
23226 arithmetic, it may be unable to find terms that involve large
23227 integers (whose number of digits approaches the current precision).
23228 Also, irreducible factors of degree higher than quadratic are not
23229 found, and polynomials in more than one variable are not treated.
23230 (A more robust factorization algorithm may be included in a future
23231 version of Calc.)
23233 @vindex FactorRules
23234 @ignore
23235 @starindex
23236 @end ignore
23237 @tindex thecoefs
23238 @ignore
23239 @starindex
23240 @end ignore
23241 @ignore
23242 @mindex @idots
23243 @end ignore
23244 @tindex thefactors
23245 The rewrite-based factorization method uses rules stored in the variable
23246 @code{FactorRules}.  @xref{Rewrite Rules}, for a discussion of the
23247 operation of rewrite rules.  The default @code{FactorRules} are able
23248 to factor quadratic forms symbolically into two linear terms,
23249 @expr{(a x + b) (c x + d)}.  You can edit these rules to include other
23250 cases if you wish.  To use the rules, Calc builds the formula
23251 @samp{thecoefs(x, [a, b, c, ...])} where @code{x} is the polynomial
23252 base variable and @code{a}, @code{b}, etc., are polynomial coefficients
23253 (which may be numbers or formulas).  The constant term is written first,
23254 i.e., in the @code{a} position.  When the rules complete, they should have
23255 changed the formula into the form @samp{thefactors(x, [f1, f2, f3, ...])}
23256 where each @code{fi} should be a factored term, e.g., @samp{x - ai}.
23257 Calc then multiplies these terms together to get the complete
23258 factored 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
23260 polynomial alone on the assumption that it is unfactorable.  (Note that
23261 the function names @code{thecoefs} and @code{thefactors} are used only
23262 as placeholders; there are no actual Calc functions by those names.)
23264 @kindex H a f
23265 @tindex factors
23266 The @kbd{H a f} [@code{factors}] command also factors a polynomial,
23267 but it returns a list of factors instead of an expression which is the
23268 product of the factors.  Each factor is represented by a sub-vector
23269 of the factor, and the power with which it appears.  For example,
23270 @expr{x^5 + x^4 - 33 x^3 + 63 x^2} factors to @expr{(x + 7) x^2 (x - 3)^2}
23271 in @kbd{a f}, or to @expr{[ [x, 2], [x+7, 1], [x-3, 2] ]} in @kbd{H a f}.
23272 If there is an overall numeric factor, it always comes first in the list.
23273 The functions @code{factor} and @code{factors} allow a second argument
23274 when written in algebraic form; @samp{factor(x,v)} factors @expr{x} with
23275 respect to the specific variable @expr{v}.  The default is to factor with
23276 respect to all the variables that appear in @expr{x}.
23278 @kindex a c
23279 @pindex calc-collect
23280 @tindex collect
23281 The @kbd{a c} (@code{calc-collect}) [@code{collect}] command rearranges a
23282 formula as a
23283 polynomial in a given variable, ordered in decreasing powers of that
23284 variable.  For example, given @expr{1 + 2 x + 3 y + 4 x y^2} on
23285 the stack, @kbd{a c x} would produce @expr{(2 + 4 y^2) x + (1 + 3 y)},
23286 and @kbd{a c y} would produce @expr{(4 x) y^2 + 3 y + (1 + 2 x)}.
23287 The polynomial will be expanded out using the distributive law as
23288 necessary:  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
23290 not be expanded.
23292 The ``variable'' you specify at the prompt can actually be any
23293 expression: @kbd{a c ln(x+1)} will collect together all terms multiplied
23294 by @samp{ln(x+1)} or integer powers thereof.  If @samp{x} also appears
23295 in the formula in a context other than @samp{ln(x+1)}, @kbd{a c} will
23296 treat those occurrences as unrelated to @samp{ln(x+1)}, i.e., as constants.
23298 @kindex a x
23299 @pindex calc-expand
23300 @tindex expand
23301 The @kbd{a x} (@code{calc-expand}) [@code{expand}] command expands an
23302 expression by applying the distributive law everywhere.  It applies to
23303 products, quotients, and powers involving sums.  By default, it fully
23304 distributes all parts of the expression.  With a numeric prefix argument,
23305 the distributive law is applied only the specified number of times, then
23306 the partially expanded expression is left on the stack.
23308 The @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.
23310 Use @kbd{j D} if you want to expand a particular specified term of
23311 the 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
23313 also 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}
23315 do not do.)
23317 Calc's automatic simplifications will sometimes reverse a partial
23318 expansion.  For example, the first step in expanding @expr{(x+1)^3} is
23319 to write @expr{(x+1) (x+1)^2}.  If @kbd{a x} stops there and tries
23320 to put this formula onto the stack, though, Calc will automatically
23321 simplify it back to @expr{(x+1)^3} form.  The solution is to turn
23322 simplification off first (@pxref{Simplification Modes}), or to run
23323 @kbd{a x} without a numeric prefix argument so that it expands all
23324 the way in one step.
23326 @kindex a a
23327 @pindex calc-apart
23328 @tindex apart
23329 The @kbd{a a} (@code{calc-apart}) [@code{apart}] command expands a
23330 rational function by partial fractions.  A rational function is the
23331 quotient of two polynomials; @code{apart} pulls this apart into a
23332 sum of rational functions with simple denominators.  In algebraic
23333 notation, the @code{apart} function allows a second argument that
23334 specifies which variable to use as the ``base''; by default, Calc
23335 chooses the base variable automatically.
23337 @kindex a n
23338 @pindex calc-normalize-rat
23339 @tindex nrat
23340 The @kbd{a n} (@code{calc-normalize-rat}) [@code{nrat}] command
23341 attempts to arrange a formula into a quotient of two polynomials.
23342 For 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
23345 out the common factor @expr{x + 1}, yielding @expr{(x + 1) / (x - 1)}.
23347 @kindex a \
23348 @pindex calc-poly-div
23349 @tindex pdiv
23350 The @kbd{a \} (@code{calc-poly-div}) [@code{pdiv}] command divides
23351 two polynomials @expr{u} and @expr{v}, yielding a new polynomial
23352 @expr{q}.  If several variables occur in the inputs, the inputs are
23353 considered multivariate polynomials.  (Calc divides by the variable
23354 with the largest power in @expr{u} first, or, in the case of equal
23355 powers, chooses the variables in alphabetical order.)  For example,
23356 dividing @expr{x^2 + 3 x + 2} by @expr{x + 2} yields @expr{x + 1}.
23357 The remainder from the division, if any, is reported at the bottom
23358 of the screen and is also placed in the Trail along with the quotient.
23360 Using @code{pdiv} in algebraic notation, you can specify the particular
23361 variable to be used as the base: @code{pdiv(@var{a},@var{b},@var{x})}.
23362 If @code{pdiv} is given only two arguments (as is always the case with
23363 the @kbd{a \} command), then it does a multivariate division as outlined
23364 above.
23366 @kindex a %
23367 @pindex calc-poly-rem
23368 @tindex prem
23369 The @kbd{a %} (@code{calc-poly-rem}) [@code{prem}] command divides
23370 two polynomials and keeps the remainder @expr{r}.  The quotient
23371 @expr{q} is discarded.  For any formulas @expr{a} and @expr{b}, the
23372 results of @kbd{a \} and @kbd{a %} satisfy @expr{a = q b + r}.
23373 (This is analogous to plain @kbd{\} and @kbd{%}, which compute the
23374 integer quotient and remainder from dividing two numbers.)
23376 @kindex a /
23377 @kindex H a /
23378 @pindex calc-poly-div-rem
23379 @tindex pdivrem
23380 @tindex pdivide
23381 The @kbd{a /} (@code{calc-poly-div-rem}) [@code{pdivrem}] command
23382 divides two polynomials and reports both the quotient and the
23383 remainder as a vector @expr{[q, r]}.  The @kbd{H a /} [@code{pdivide}]
23384 command divides two polynomials and constructs the formula
23385 @expr{q + r/b} on the stack.  (Naturally if the remainder is zero,
23386 this will immediately simplify to @expr{q}.)
23388 @kindex a g
23389 @pindex calc-poly-gcd
23390 @tindex pgcd
23391 The @kbd{a g} (@code{calc-poly-gcd}) [@code{pgcd}] command computes
23392 the greatest common divisor of two polynomials.  (The GCD actually
23393 is unique only to within a constant multiplier; Calc attempts to
23394 choose a GCD which will be unsurprising.)  For example, the @kbd{a n}
23395 command uses @kbd{a g} to take the GCD of the numerator and denominator
23396 of a quotient, then divides each by the result using @kbd{a \}.  (The
23397 definition of GCD ensures that this division can take place without
23398 leaving a remainder.)
23400 While the polynomials used in operations like @kbd{a /} and @kbd{a g}
23401 often have integer coefficients, this is not required.  Calc can also
23402 deal with polynomials over the rationals or floating-point reals.
23403 Polynomials with modulo-form coefficients are also useful in many
23404 applications; if you enter @samp{(x^2 + 3 x - 1) mod 5}, Calc
23405 automatically transforms this into a polynomial over the field of
23406 integers mod 5:  @samp{(1 mod 5) x^2 + (3 mod 5) x + (4 mod 5)}.
23408 Congratulations and thanks go to Ove Ewerlid
23409 (@code{ewerlid@@mizar.DoCS.UU.SE}), who contributed many of the
23410 polynomial routines used in the above commands.
23412 @xref{Decomposing Polynomials}, for several useful functions for
23413 extracting the individual coefficients of a polynomial.
23415 @node Calculus, Solving Equations, Polynomials, Algebra
23416 @section Calculus
23418 @noindent
23419 The following calculus commands do not automatically simplify their
23420 inputs or outputs using @code{calc-simplify}.  You may find it helps
23421 to do this by hand by typing @kbd{a s} or @kbd{a e}.  It may also help
23422 to use @kbd{a x} and/or @kbd{a c} to arrange a result in the most
23423 readable way.
23425 @menu
23426 * Differentiation::
23427 * Integration::
23428 * Customizing the Integrator::
23429 * Numerical Integration::
23430 * Taylor Series::
23431 @end menu
23433 @node Differentiation, Integration, Calculus, Calculus
23434 @subsection Differentiation
23436 @noindent
23437 @kindex a d
23438 @kindex H a d
23439 @pindex calc-derivative
23440 @tindex deriv
23441 @tindex tderiv
23442 The @kbd{a d} (@code{calc-derivative}) [@code{deriv}] command computes
23443 the derivative of the expression on the top of the stack with respect to
23444 some variable, which it will prompt you to enter.  Normally, variables
23445 in the formula other than the specified differentiation variable are
23446 considered constant, i.e., @samp{deriv(y,x)} is reduced to zero.  With
23447 the Hyperbolic flag, the @code{tderiv} (total derivative) operation is used
23448 instead, in which derivatives of variables are not reduced to zero
23449 unless those variables are known to be ``constant,'' i.e., independent
23450 of any other variables.  (The built-in special variables like @code{pi}
23451 are considered constant, as are variables that have been declared
23452 @code{const}; @pxref{Declarations}.)
23454 With a numeric prefix argument @var{n}, this command computes the
23455 @var{n}th derivative.
23457 When working with trigonometric functions, it is best to switch to
23458 Radians mode first (with @w{@kbd{m r}}).  The derivative of @samp{sin(x)}
23459 in degrees is @samp{(pi/180) cos(x)}, probably not the expected
23460 answer!
23462 If you use the @code{deriv} function directly in an algebraic formula,
23463 you can write @samp{deriv(f,x,x0)} which represents the derivative
23464 of @expr{f} with respect to @expr{x}, evaluated at the point 
23465 @texline @math{x=x_0}.
23466 @infoline @expr{x=x0}.
23468 If the formula being differentiated contains functions which Calc does
23469 not know, the derivatives of those functions are produced by adding
23470 primes (apostrophe characters).  For example, @samp{deriv(f(2x), x)}
23471 produces @samp{2 f'(2 x)}, where the function @code{f'} represents the
23472 derivative of @code{f}.
23474 For functions you have defined with the @kbd{Z F} command, Calc expands
23475 the functions according to their defining formulas unless you have
23476 also defined @code{f'} suitably.  For example, suppose we define
23477 @samp{sinc(x) = sin(x)/x} using @kbd{Z F}.  If we then differentiate
23478 the formula @samp{sinc(2 x)}, the formula will be expanded to
23479 @samp{sin(2 x) / (2 x)} and differentiated.  However, if we also
23480 define @samp{sinc'(x) = dsinc(x)}, say, then Calc will write the
23481 result as @samp{2 dsinc(2 x)}.  @xref{Algebraic Definitions}.
23483 For multi-argument functions @samp{f(x,y,z)}, the derivative with respect
23484 to the first argument is written @samp{f'(x,y,z)}; derivatives with
23485 respect to the other arguments are @samp{f'2(x,y,z)} and @samp{f'3(x,y,z)}.
23486 Various 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
23489 argument once).
23491 @node Integration, Customizing the Integrator, Differentiation, Calculus
23492 @subsection Integration
23494 @noindent
23495 @kindex a i
23496 @pindex calc-integral
23497 @tindex integ
23498 The @kbd{a i} (@code{calc-integral}) [@code{integ}] command computes the
23499 indefinite integral of the expression on the top of the stack with
23500 respect to a variable.  The integrator is not guaranteed to work for
23501 all integrable functions, but it is able to integrate several large
23502 classes of formulas.  In particular, any polynomial or rational function
23503 (a polynomial divided by a polynomial) is acceptable.  (Rational functions
23504 don't have to be in explicit quotient form, however; 
23505 @texline @math{x/(1+x^{-2})}
23506 @infoline @expr{x/(1+x^-2)}
23507 is not strictly a quotient of polynomials, but it is equivalent to
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
23510 integrated.  Finally, rational functions involving trigonometric or
23511 hyperbolic functions can be integrated.
23513 @ifinfo
23514 If you use the @code{integ} function directly in an algebraic formula,
23515 you can also write @samp{integ(f,x,v)} which expresses the resulting
23516 indefinite integral in terms of variable @code{v} instead of @code{x}.
23517 With four arguments, @samp{integ(f(x),x,a,b)} represents a definite
23518 integral from @code{a} to @code{b}.
23519 @end ifinfo
23520 @tex
23521 If you use the @code{integ} function directly in an algebraic formula,
23522 you can also write @samp{integ(f,x,v)} which expresses the resulting
23523 indefinite integral in terms of variable @code{v} instead of @code{x}.
23524 With four arguments, @samp{integ(f(x),x,a,b)} represents a definite
23525 integral $\int_a^b f(x) \, dx$.
23526 @end tex
23528 Please note that the current implementation of Calc's integrator sometimes
23529 produces results that are significantly more complex than they need to
23530 be.  For example, the integral Calc finds for 
23531 @texline @math{1/(x+\sqrt{x^2+1})}
23532 @infoline @expr{1/(x+sqrt(x^2+1))}
23533 is several times more complicated than the answer Mathematica
23534 returns for the same input, although the two forms are numerically
23535 equivalent.  Also, any indefinite integral should be considered to have
23536 an arbitrary constant of integration added to it, although Calc does not
23537 write an explicit constant of integration in its result.  For example,
23538 Calc's solution for 
23539 @texline @math{1/(1+\tan x)}
23540 @infoline @expr{1/(1+tan(x))} 
23541 differs from the solution given in the @emph{CRC Math Tables} by a
23542 constant factor of  
23543 @texline @math{\pi i / 2}
23544 @infoline @expr{pi i / 2},
23545 due to a different choice of constant of integration.
23547 The Calculator remembers all the integrals it has done.  If conditions
23548 change in a way that would invalidate the old integrals, say, a switch
23549 from Degrees to Radians mode, then they will be thrown out.  If you
23550 suspect this is not happening when it should, use the
23551 @code{calc-flush-caches} command; @pxref{Caches}.
23553 @vindex IntegLimit
23554 Calc normally will pursue integration by substitution or integration by
23555 parts up to 3 nested times before abandoning an approach as fruitless.
23556 If the integrator is taking too long, you can lower this limit by storing
23557 a number (like 2) in the variable @code{IntegLimit}.  (The @kbd{s I}
23558 command is a convenient way to edit @code{IntegLimit}.)  If this variable
23559 has no stored value or does not contain a nonnegative integer, a limit
23560 of 3 is used.  The lower this limit is, the greater the chance that Calc
23561 will be unable to integrate a function it could otherwise handle.  Raising
23562 this limit allows the Calculator to solve more integrals, though the time
23563 it takes may grow exponentially.  You can monitor the integrator's actions
23564 by creating an Emacs buffer called @code{*Trace*}.  If such a buffer
23565 exists, the @kbd{a i} command will write a log of its actions there.
23567 If you want to manipulate integrals in a purely symbolic way, you can
23568 set the integration nesting limit to 0 to prevent all but fast
23569 table-lookup solutions of integrals.  You might then wish to define
23570 rewrite rules for integration by parts, various kinds of substitutions,
23571 and so on.  @xref{Rewrite Rules}.
23573 @node Customizing the Integrator, Numerical Integration, Integration, Calculus
23574 @subsection Customizing the Integrator
23576 @noindent
23577 @vindex IntegRules
23578 Calc has two built-in rewrite rules called @code{IntegRules} and
23579 @code{IntegAfterRules} which you can edit to define new integration
23580 methods.  @xref{Rewrite Rules}.  At each step of the integration process,
23581 Calc wraps the current integrand in a call to the fictitious function
23582 @samp{integtry(@var{expr},@var{var})}, where @var{expr} is the
23583 integrand and @var{var} is the integration variable.  If your rules
23584 rewrite this to be a plain formula (not a call to @code{integtry}), then
23585 Calc will use this formula as the integral of @var{expr}.  For example,
23586 the rule @samp{integtry(mysin(x),x) := -mycos(x)} would define a rule to
23587 integrate a function @code{mysin} that acts like the sine function.
23588 Then, putting @samp{4 mysin(2y+1)} on the stack and typing @kbd{a i y}
23589 will produce the integral @samp{-2 mycos(2y+1)}.  Note that Calc has
23590 automatically made various transformations on the integral to allow it
23591 to 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
23593 in your @code{IntegRules}.
23595 @cindex Exponential integral Ei(x)
23596 @ignore
23597 @starindex
23598 @end ignore
23599 @tindex Ei
23600 As a more serious example, the expression @samp{exp(x)/x} cannot be
23601 integrated in terms of the standard functions, so the ``exponential
23602 integral'' function 
23603 @texline @math{{\rm Ei}(x)}
23604 @infoline @expr{Ei(x)} 
23605 was invented to describe it.
23606 We can get Calc to do this integral in terms of a made-up @code{Ei}
23607 function by adding the rule @samp{[integtry(exp(x)/x, x) := Ei(x)]}
23608 to @code{IntegRules}.  Now entering @samp{exp(2x)/x} on the stack
23609 and typing @kbd{a i x} yields @samp{Ei(2 x)}.  This new rule will
23610 work with Calc's various built-in integration methods (such as
23611 integration by substitution) to solve a variety of other problems
23612 involving @code{Ei}:  For example, now Calc will also be able to
23613 integrate @samp{exp(exp(x))} and @samp{ln(ln(x))} (to get @samp{Ei(exp(x))}
23614 and @samp{x ln(ln(x)) - Ei(ln(x))}, respectively).
23616 Your rule may do further integration by calling @code{integ}.  For
23617 example, @samp{integtry(twice(u),x) := twice(integ(u))} allows Calc
23618 to integrate @samp{twice(sin(x))} to get @samp{twice(-cos(x))}.
23619 Note that @code{integ} was called with only one argument.  This notation
23620 is allowed only within @code{IntegRules}; it means ``integrate this
23621 with respect to the same integration variable.''  If Calc is unable
23622 to integrate @code{u}, the integration that invoked @code{IntegRules}
23623 also fails.  Thus integrating @samp{twice(f(x))} fails, returning the
23624 unevaluated integral @samp{integ(twice(f(x)), x)}.  It is still valid
23625 to call @code{integ} with two or more arguments, however; in this case,
23626 if @code{u} is not integrable, @code{twice} itself will still be
23627 integrated:  If the above rule is changed to @samp{... := twice(integ(u,x))},
23628 then integrating @samp{twice(f(x))} will yield @samp{twice(integ(f(x),x))}.
23630 If a rule instead produces the formula @samp{integsubst(@var{sexpr},
23631 @var{svar})}, either replacing the top-level @code{integtry} call or
23632 nested anywhere inside the expression, then Calc will apply the
23633 substitution @samp{@var{u} = @var{sexpr}(@var{svar})} to try to
23634 integrate the original @var{expr}.  For example, the rule
23635 @samp{sqrt(a) := integsubst(sqrt(x),x)} says that if Calc ever finds
23636 a square root in the integrand, it should attempt the substitution
23637 @samp{u = sqrt(x)}.  (This particular rule is unnecessary because
23638 Calc always tries ``obvious'' substitutions where @var{sexpr} actually
23639 appears in the integrand.)  The variable @var{svar} may be the same
23640 as the @var{var} that appeared in the call to @code{integtry}, but
23641 it need not be.
23643 When integrating according to an @code{integsubst}, Calc uses the
23644 equation solver to find the inverse of @var{sexpr} (if the integrand
23645 refers to @var{var} anywhere except in subexpressions that exactly
23646 match @var{sexpr}).  It uses the differentiator to find the derivative
23647 of @var{sexpr} and/or its inverse (it has two methods that use one
23648 derivative or the other).  You can also specify these items by adding
23649 extra arguments to the @code{integsubst} your rules construct; the
23650 general form is @samp{integsubst(@var{sexpr}, @var{svar}, @var{sinv},
23651 @var{sprime})}, where @var{sinv} is the inverse of @var{sexpr} (still
23652 written as a function of @var{svar}), and @var{sprime} is the
23653 derivative of @var{sexpr} with respect to @var{svar}.  If you don't
23654 specify these things, and Calc is not able to work them out on its
23655 own with the information it knows, then your substitution rule will
23656 work only in very specific, simple cases.
23658 Calc applies @code{IntegRules} as if by @kbd{C-u 1 a r IntegRules};
23659 in other words, Calc stops rewriting as soon as any rule in your rule
23660 set succeeds.  (If it weren't for this, the @samp{integsubst(sqrt(x),x)}
23661 example above would keep on adding layers of @code{integsubst} calls
23662 forever!)
23664 @vindex IntegSimpRules
23665 Another set of rules, stored in @code{IntegSimpRules}, are applied
23666 every time the integrator uses @kbd{a s} to simplify an intermediate
23667 result.  For example, putting the rule @samp{twice(x) := 2 x} into
23668 @code{IntegSimpRules} would tell Calc to convert the @code{twice}
23669 function into a form it knows whenever integration is attempted.
23671 One more way to influence the integrator is to define a function with
23672 the @kbd{Z F} command (@pxref{Algebraic Definitions}).  Calc's
23673 integrator automatically expands such functions according to their
23674 defining formulas, even if you originally asked for the function to
23675 be left unevaluated for symbolic arguments.  (Certain other Calc
23676 systems, such as the differentiator and the equation solver, also
23677 do this.)
23679 @vindex IntegAfterRules
23680 Sometimes Calc is able to find a solution to your integral, but it
23681 expresses the result in a way that is unnecessarily complicated.  If
23682 this happens, you can either use @code{integsubst} as described
23683 above to try to hint at a more direct path to the desired result, or
23684 you can use @code{IntegAfterRules}.  This is an extra rule set that
23685 runs after the main integrator returns its result; basically, Calc does
23686 an @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
23688 to further simplify the result.)  For example, Calc's integrator
23689 sometimes produces expressions of the form @samp{ln(1+x) - ln(1-x)};
23690 the default @code{IntegAfterRules} rewrite this into the more readable
23691 form @samp{2 arctanh(x)}.  Note that, unlike @code{IntegRules},
23692 @code{IntegSimpRules} and @code{IntegAfterRules} are applied any number
23693 of times until no further changes are possible.  Rewriting by
23694 @code{IntegAfterRules} occurs only after the main integrator has
23695 finished, not at every step as for @code{IntegRules} and
23696 @code{IntegSimpRules}.
23698 @node Numerical Integration, Taylor Series, Customizing the Integrator, Calculus
23699 @subsection Numerical Integration
23701 @noindent
23702 @kindex a I
23703 @pindex calc-num-integral
23704 @tindex ninteg
23705 If you want a purely numerical answer to an integration problem, you can
23706 use the @kbd{a I} (@code{calc-num-integral}) [@code{ninteg}] command.  This
23707 command prompts for an integration variable, a lower limit, and an
23708 upper limit.  Except for the integration variable, all other variables
23709 that appear in the integrand formula must have stored values.  (A stored
23710 value, if any, for the integration variable itself is ignored.)
23712 Numerical integration works by evaluating your formula at many points in
23713 the specified interval.  Calc uses an ``open Romberg'' method; this means
23714 that it does not evaluate the formula actually at the endpoints (so that
23715 it is safe to integrate @samp{sin(x)/x} from zero, for example).  Also,
23716 the Romberg method works especially well when the function being
23717 integrated is fairly smooth.  If the function is not smooth, Calc will
23718 have to evaluate it at quite a few points before it can accurately
23719 determine the value of the integral.
23721 Integration is much faster when the current precision is small.  It is
23722 best to set the precision to the smallest acceptable number of digits
23723 before 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
23725 to need hundreds of evaluations, check to make sure your function is
23726 well-behaved in the specified interval.
23728 It is possible for the lower integration limit to be @samp{-inf} (minus
23729 infinity).  Likewise, the upper limit may be plus infinity.  Calc
23730 internally transforms the integral into an equivalent one with finite
23731 limits.  However, integration to or across singularities is not supported:
23732 The integral of @samp{1/sqrt(x)} from 0 to 1 exists (it can be found
23733 by Calc's symbolic integrator, for example), but @kbd{a I} will fail
23734 because the integrand goes to infinity at one of the endpoints.
23736 @node Taylor Series, , Numerical Integration, Calculus
23737 @subsection Taylor Series
23739 @noindent
23740 @kindex a t
23741 @pindex calc-taylor
23742 @tindex taylor
23743 The @kbd{a t} (@code{calc-taylor}) [@code{taylor}] command computes a
23744 power series expansion or Taylor series of a function.  You specify the
23745 variable and the desired number of terms.  You may give an expression of
23746 the form @samp{@var{var} = @var{a}} or @samp{@var{var} - @var{a}} instead
23747 of just a variable to produce a Taylor expansion about the point @var{a}.
23748 You may specify the number of terms with a numeric prefix argument;
23749 otherwise the command will prompt you for the number of terms.  Note that
23750 many series expansions have coefficients of zero for some terms, so you
23751 may appear to get fewer terms than you asked for.
23753 If the @kbd{a i} command is unable to find a symbolic integral for a
23754 function, you can get an approximation by integrating the function's
23755 Taylor series.
23757 @node Solving Equations, Numerical Solutions, Calculus, Algebra
23758 @section Solving Equations
23760 @noindent
23761 @kindex a S
23762 @pindex calc-solve-for
23763 @tindex solve
23764 @cindex Equations, solving
23765 @cindex Solving equations
23766 The @kbd{a S} (@code{calc-solve-for}) [@code{solve}] command rearranges
23767 an equation to solve for a specific variable.  An equation is an
23768 expression of the form @expr{L = R}.  For example, the command @kbd{a S x}
23769 will rearrange @expr{y = 3x + 6} to the form, @expr{x = y/3 - 2}.  If the
23770 input is not an equation, it is treated like an equation of the
23771 form @expr{X = 0}.
23773 This command also works for inequalities, as in @expr{y < 3x + 6}.
23774 Some inequalities cannot be solved where the analogous equation could
23775 be; for example, solving 
23776 @texline @math{a < b \, c}
23777 @infoline @expr{a < b c} 
23778 for @expr{b} is impossible
23779 without knowing the sign of @expr{c}.  In this case, @kbd{a S} will
23780 produce the result 
23781 @texline @math{b \mathbin{\hbox{\code{!=}}} a/c}
23782 @infoline @expr{b != a/c} 
23783 (using the not-equal-to operator) to signify that the direction of the
23784 inequality is now unknown.  The inequality 
23785 @texline @math{a \le b \, c}
23786 @infoline @expr{a <= b c} 
23787 is not even partially solved.  @xref{Declarations}, for a way to tell
23788 Calc that the signs of the variables in a formula are in fact known.
23790 Two useful commands for working with the result of @kbd{a S} are
23791 @kbd{a .} (@pxref{Logical Operations}), which converts @expr{x = y/3 - 2}
23792 to @expr{y/3 - 2}, and @kbd{s l} (@pxref{Let Command}) which evaluates
23793 another formula with @expr{x} set equal to @expr{y/3 - 2}.
23795 @menu
23796 * Multiple Solutions::
23797 * Solving Systems of Equations::
23798 * Decomposing Polynomials::
23799 @end menu
23801 @node Multiple Solutions, Solving Systems of Equations, Solving Equations, Solving Equations
23802 @subsection Multiple Solutions
23804 @noindent
23805 @kindex H a S
23806 @tindex fsolve
23807 Some equations have more than one solution.  The Hyperbolic flag
23808 (@code{H a S}) [@code{fsolve}] tells the solver to report the fully
23809 general 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
23812 signs (either @mathit{+1} or @mathit{-1}).  If you don't use the Hyperbolic
23813 flag, Calc will use zero in place of all arbitrary integers, and plus
23814 one in place of all arbitrary signs.  Note that variables like @code{n1}
23815 and @code{s1} are not given any special interpretation in Calc except by
23816 the 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
23818 of these variables.
23820 For example, @kbd{' x^2 = y @key{RET} H a S x @key{RET}} solves to
23821 get @samp{x = s1 sqrt(y)}, indicating that the two solutions to the
23822 equation are @samp{sqrt(y)} and @samp{-sqrt(y)}.  Another way to
23823 think about it is that the square-root operation is really a
23824 two-valued function; since every Calc function must return a
23825 single result, @code{sqrt} chooses to return the positive result.
23826 Then @kbd{H a S} doctors this result using @code{s1} to indicate
23827 the full set of possible values of the mathematical square-root.
23829 There is a similar phenomenon going the other direction:  Suppose
23830 we solve @samp{sqrt(y) = x} for @code{y}.  Calc squares both sides
23831 to get @samp{y = x^2}.  This is correct, except that it introduces
23832 some dubious solutions.  Consider solving @samp{sqrt(y) = -3}:
23833 Calc will report @expr{y = 9} as a valid solution, which is true
23834 in the mathematical sense of square-root, but false (there is no
23835 solution) for the actual Calc positive-valued @code{sqrt}.  This
23836 happens for both @kbd{a S} and @kbd{H a S}.
23838 @cindex @code{GenCount} variable
23839 @vindex GenCount
23840 @ignore
23841 @starindex
23842 @end ignore
23843 @tindex an
23844 @ignore
23845 @starindex
23846 @end ignore
23847 @tindex as
23848 If you store a positive integer in the Calc variable @code{GenCount},
23849 then Calc will generate formulas of the form @samp{as(@var{n})} for
23850 arbitrary signs, and @samp{an(@var{n})} for arbitrary integers,
23851 where @var{n} represents successive values taken by incrementing
23852 @code{GenCount} by one.  While the normal arbitrary sign and
23853 integer symbols start over at @code{s1} and @code{n1} with each
23854 new Calc command, the @code{GenCount} approach will give each
23855 arbitrary value a name that is unique throughout the entire Calc
23856 session.  Also, the arbitrary values are function calls instead
23857 of variables, which is advantageous in some cases.  For example,
23858 you can make a rewrite rule that recognizes all arbitrary signs
23859 using a pattern like @samp{as(n)}.  The @kbd{s l} command only works
23860 on variables, but you can use the @kbd{a b} (@code{calc-substitute})
23861 command to substitute actual values for function calls like @samp{as(3)}.
23863 The @kbd{s G} (@code{calc-edit-GenCount}) command is a convenient
23864 way to create or edit this variable.  Press @kbd{C-c C-c} to finish.
23866 If you have not stored a value in @code{GenCount}, or if the value
23867 in that variable is not a positive integer, the regular
23868 @code{s1}/@code{n1} notation is used.
23870 @kindex I a S
23871 @kindex H I a S
23872 @tindex finv
23873 @tindex ffinv
23874 With the Inverse flag, @kbd{I a S} [@code{finv}] treats the expression
23875 on top of the stack as a function of the specified variable and solves
23876 to find the inverse function, written in terms of the same variable.
23877 For example, @kbd{I a S x} inverts @expr{2x + 6} to @expr{x/2 - 3}.
23878 You can use both Inverse and Hyperbolic [@code{ffinv}] to obtain a
23879 fully general inverse, as described above.
23881 @kindex a P
23882 @pindex calc-poly-roots
23883 @tindex roots
23884 Some equations, specifically polynomials, have a known, finite number
23885 of solutions.  The @kbd{a P} (@code{calc-poly-roots}) [@code{roots}]
23886 command uses @kbd{H a S} to solve an equation in general form, then, for
23887 all arbitrary-sign variables like @code{s1}, and all arbitrary-integer
23888 variables like @code{n1} for which @code{n1} only usefully varies over
23889 a finite range, it expands these variables out to all their possible
23890 values.  The results are collected into a vector, which is returned.
23891 For 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
23893 polynomial will always have @var{n} roots on the complex plane.
23894 (If you have given a @code{real} declaration for the solution
23895 variable, then only the real-valued solutions, if any, will be
23896 reported; @pxref{Declarations}.)
23898 Note that because @kbd{a P} uses @kbd{H a S}, it is able to deliver
23899 symbolic solutions if the polynomial has symbolic coefficients.  Also
23900 note that Calc's solver is not able to get exact symbolic solutions
23901 to all polynomials.  Polynomials containing powers up to @expr{x^4}
23902 can always be solved exactly; polynomials of higher degree sometimes
23903 can be:  @expr{x^6 + x^3 + 1} is converted to @expr{(x^3)^2 + (x^3) + 1},
23904 which can be solved for @expr{x^3} using the quadratic equation, and then
23905 for @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
23907 into a form it can solve.  The @kbd{a P} command can still deliver a
23908 list of numerical roots, however, provided that Symbolic mode (@kbd{m s})
23909 is not turned on.  (If you work with Symbolic mode on, recall that the
23910 @kbd{N} (@code{calc-eval-num}) key is a handy way to reevaluate the
23911 formula on the stack with Symbolic mode temporarily off.)  Naturally,
23912 @kbd{a P} can only provide numerical roots if the polynomial coefficients
23913 are all numbers (real or complex).
23915 @node Solving Systems of Equations, Decomposing Polynomials, Multiple Solutions, Solving Equations
23916 @subsection Solving Systems of Equations
23918 @noindent
23919 @cindex Systems of equations, symbolic
23920 You can also use the commands described above to solve systems of
23921 simultaneous equations.  Just create a vector of equations, then
23922 specify a vector of variables for which to solve.  (You can omit
23923 the surrounding brackets when entering the vector of variables
23924 at the prompt.)
23926 For example, putting @samp{[x + y = a, x - y = b]} on the stack
23927 and 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
23929 have the same length as the variables vector, and the variables
23930 will be listed in the same order there.  Note that the solutions
23931 are not always simplified as far as possible; the solution for
23932 @expr{x} here could be improved by an application of the @kbd{a n}
23933 command.
23935 Calc's algorithm works by trying to eliminate one variable at a
23936 time by solving one of the equations for that variable and then
23937 substituting into the other equations.  Calc will try all the
23938 possibilities, but you can speed things up by noting that Calc
23939 first tries to eliminate the first variable with the first
23940 equation, then the second variable with the second equation,
23941 and so on.  It also helps to put the simpler (e.g., more linear)
23942 equations toward the front of the list.  Calc's algorithm will
23943 solve any system of linear equations, and also many kinds of
23944 nonlinear systems.
23946 @ignore
23947 @starindex
23948 @end ignore
23949 @tindex elim
23950 Normally there will be as many variables as equations.  If you
23951 give fewer variables than equations (an ``over-determined'' system
23952 of equations), Calc will find a partial solution.  For example,
23953 typing @kbd{a S y @key{RET}} with the above system of equations
23954 would produce @samp{[y = a - x]}.  There are now several ways to
23955 express this solution in terms of the original variables; Calc uses
23956 the first one that it finds.  You can control the choice by adding
23957 variable specifiers of the form @samp{elim(@var{v})} to the
23958 variables list.  This says that @var{v} should be eliminated from
23959 the equations; the variable will not appear at all in the solution.
23960 For example, typing @kbd{a S y,elim(x)} would yield
23961 @samp{[y = a - (b+a)/2]}.
23963 If the variables list contains only @code{elim} specifiers,
23964 Calc simply eliminates those variables from the equations
23965 and then returns the resulting set of equations.  For example,
23966 @kbd{a S elim(x)} produces @samp{[a - 2 y = b]}.  Every variable
23967 eliminated will reduce the number of equations in the system
23968 by one.
23970 Again, @kbd{a S} gives you one solution to the system of
23971 equations.  If there are several solutions, you can use @kbd{H a S}
23972 to get a general family of solutions, or, if there is a finite
23973 number of solutions, you can use @kbd{a P} to get a list.  (In
23974 the latter case, the result will take the form of a matrix where
23975 the rows are different solutions and the columns correspond to the
23976 variables you requested.)
23978 Another way to deal with certain kinds of overdetermined systems of
23979 equations is the @kbd{a F} command, which does least-squares fitting
23980 to satisfy the equations.  @xref{Curve Fitting}.
23982 @node Decomposing Polynomials, , Solving Systems of Equations, Solving Equations
23983 @subsection Decomposing Polynomials
23985 @noindent
23986 @ignore
23987 @starindex
23988 @end ignore
23989 @tindex poly
23990 The @code{poly} function takes a polynomial and a variable as
23991 arguments, and returns a vector of polynomial coefficients (constant
23992 coefficient first).  For example, @samp{poly(x^3 + 2 x, x)} returns
23993 @expr{[0, 2, 0, 1]}.  If the input is not a polynomial in @expr{x},
23994 the call to @code{poly} is left in symbolic form.  If the input does
23995 not involve the variable @expr{x}, the input is returned in a list
23996 of length one, representing a polynomial with only a constant
23997 coefficient.  The call @samp{poly(x, x)} returns the vector @expr{[0, 1]}.
23998 The last element of the returned vector is guaranteed to be nonzero;
23999 note that @samp{poly(0, x)} returns the empty vector @expr{[]}.
24000 Note 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]}.
24003 @cindex Coefficients of polynomial
24004 @cindex Degree of polynomial
24005 To 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},
24007 use @samp{vlen(poly(p, x)) - 1}.  For example, @samp{poly((x+1)^4, x)}
24008 returns @samp{[1, 4, 6, 4, 1]}, so @samp{poly((x+1)^4, x)_(2+1)}
24009 gives the @expr{x^2} coefficient of this polynomial, 6.
24011 @ignore
24012 @starindex
24013 @end ignore
24014 @tindex gpoly
24015 One important feature of the solver is its ability to recognize
24016 formulas which are ``essentially'' polynomials.  This ability is
24017 made available to the user through the @code{gpoly} function, which
24018 is used just like @code{poly}:  @samp{gpoly(@var{expr}, @var{var})}.
24019 If @var{expr} is a polynomial in some term which includes @var{var}, then
24020 this function will return a vector @samp{[@var{x}, @var{c}, @var{a}]}
24021 where @var{x} is the term that depends on @var{var}, @var{c} is a
24022 vector of polynomial coefficients (like the one returned by @code{poly}),
24023 and @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
24026 guaranteed to be non-zero, and @var{c} will not equal @samp{[1]}
24027 (i.e., the trivial decomposition @var{expr} = @var{x} is not
24028 considered a polynomial).  One side effect is that @samp{gpoly(x, x)}
24029 and @samp{gpoly(6, x)}, both of which might be expected to recognize
24030 their arguments as polynomials, will not because the decomposition
24031 is considered trivial.
24033 For example, @samp{gpoly((x-2)^2, x)} returns @samp{[x, [4, -4, 1], 1]},
24034 since the expanded form of this polynomial is @expr{4 - 4 x + x^2}.
24036 The term @var{x} may itself be a polynomial in @var{var}.  This is
24037 done 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]},
24039 since a quadratic polynomial in @expr{x^2} is easier to solve than
24040 a quartic polynomial in @expr{x}.
24042 A few more examples of the kinds of polynomials @code{gpoly} can
24043 discover:
24045 @smallexample
24046 sin(x) - 1               [sin(x), [-1, 1], 1]
24047 x + 1/x - 1              [x, [1, -1, 1], 1/x]
24048 x + 1/x                  [x^2, [1, 1], 1/x]
24049 x^3 + 2 x                [x^2, [2, 1], x]
24050 x + x^2:3 + sqrt(x)      [x^1:6, [1, 1, 0, 1], x^1:2]
24051 x^(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
24055 The @code{poly} and @code{gpoly} functions accept a third integer argument
24056 which specifies the largest degree of polynomial that is acceptable.
24057 If this is @expr{n}, then only @var{c} vectors of length @expr{n+1}
24058 or less will be returned.  Otherwise, the @code{poly} or @code{gpoly}
24059 call will remain in symbolic form.  For example, the equation solver
24060 can handle quartics and smaller polynomials, so it calls
24061 @samp{gpoly(@var{expr}, @var{var}, 4)} to discover whether @var{expr}
24062 can be treated by its linear, quadratic, cubic, or quartic formulas.
24064 @ignore
24065 @starindex
24066 @end ignore
24067 @tindex pdeg
24068 The @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
24071 much more efficient.  If @code{p} is constant with respect to @code{x},
24072 then @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.
24074 It 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
24076 polynomial, counting all variables that appear in @code{p}.  Note
24077 that @code{pdeg(c) = pdeg(c,x) = 0} for any nonzero constant @code{c};
24078 the degree of the constant zero is considered to be @code{-inf}
24079 (minus infinity).
24081 @ignore
24082 @starindex
24083 @end ignore
24084 @tindex plead
24085 The @code{plead} function finds the leading term of a polynomial.
24086 Thus @samp{plead(p,x)} is equivalent to @samp{poly(p,x)_vlen(poly(p,x))},
24087 though again more efficient.  In particular, @samp{plead((2x+1)^10, x)}
24088 returns 1024 without expanding out the list of coefficients.  The
24089 value of @code{plead(p,x)} will be zero only if @expr{p = 0}.
24091 @ignore
24092 @starindex
24093 @end ignore
24094 @tindex pcont
24095 The @code{pcont} function finds the @dfn{content} of a polynomial.  This
24096 is the greatest common divisor of all the coefficients of the polynomial.
24097 With two arguments, @code{pcont(p,x)} effectively uses @samp{poly(p,x)}
24098 to get a list of coefficients, then uses @code{pgcd} (the polynomial
24099 GCD 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
24101 basically the ``biggest'' polynomial that can be divided into @code{p}
24102 exactly.  The sign of the content is the same as the sign of the leading
24103 coefficient.
24105 With only one argument, @samp{pcont(p)} computes the numerical
24106 content of the polynomial, i.e., the @code{gcd} of the numerical
24107 coefficients of all the terms in the formula.  Note that @code{gcd}
24108 is defined on rational numbers as well as integers; it computes
24109 the @code{gcd} of the numerators and the @code{lcm} of the
24110 denominators.  Thus @samp{pcont(4:3 x y^2 + 6 x^2 y)} returns 2:3.
24111 Dividing the polynomial by this number will clear all the
24112 denominators, as well as dividing by any common content in the
24113 numerators.  The numerical content of a polynomial is negative only
24114 if all the coefficients in the polynomial are negative.
24116 @ignore
24117 @starindex
24118 @end ignore
24119 @tindex pprim
24120 The @code{pprim} function finds the @dfn{primitive part} of a
24121 polynomial, which is simply the polynomial divided (using @code{pdiv}
24122 if necessary) by its content.  If the input polynomial has rational
24123 coefficients, the result will have integer coefficients in simplest
24124 terms.
24126 @node Numerical Solutions, Curve Fitting, Solving Equations, Algebra
24127 @section Numerical Solutions
24129 @noindent
24130 Not all equations can be solved symbolically.  The commands in this
24131 section use numerical algorithms that can find a solution to a specific
24132 instance of an equation to any desired accuracy.  Note that the
24133 numerical commands are slower than their algebraic cousins; it is a
24134 good idea to try @kbd{a S} before resorting to these commands.
24136 (@xref{Curve Fitting}, for some other, more specialized, operations
24137 on numerical data.)
24139 @menu
24140 * Root Finding::
24141 * Minimization::
24142 * Numerical Systems of Equations::
24143 @end menu
24145 @node Root Finding, Minimization, Numerical Solutions, Numerical Solutions
24146 @subsection Root Finding
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
24155 The @kbd{a R} (@code{calc-find-root}) [@code{root}] command finds a
24156 numerical solution (or @dfn{root}) of an equation.  (This command treats
24157 inequalities the same as equations.  If the input is any other kind
24158 of formula, it is interpreted as an equation of the form @expr{X = 0}.)
24160 The @kbd{a R} command requires an initial guess on the top of the
24161 stack, and a formula in the second-to-top position.  It prompts for a
24162 solution variable, which must appear in the formula.  All other variables
24163 that appear in the formula must have assigned values, i.e., when
24164 a value is assigned to the solution variable and the formula is
24165 evaluated with @kbd{=}, it should evaluate to a number.  Any assigned
24166 value for the solution variable itself is ignored and unaffected by
24167 this command.
24169 When the command completes, the initial guess is replaced on the stack
24170 by a vector of two numbers:  The value of the solution variable that
24171 solves the equation, and the difference between the lefthand and
24172 righthand sides of the equation at that value.  Ordinarily, the second
24173 number will be zero or very nearly zero.  (Note that Calc uses a
24174 slightly higher precision while finding the root, and thus the second
24175 number may be slightly different from the value you would compute from
24176 the equation yourself.)
24178 The @kbd{v h} (@code{calc-head}) command is a handy way to extract
24179 the first element of the result vector, discarding the error term.
24181 The initial guess can be a real number, in which case Calc searches
24182 for a real solution near that number, or a complex number, in which
24183 case Calc searches the whole complex plane near that number for a
24184 solution, or it can be an interval form which restricts the search
24185 to real numbers inside that interval.
24187 Calc tries to use @kbd{a d} to take the derivative of the equation.
24188 If this succeeds, it uses Newton's method.  If the equation is not
24189 differentiable Calc uses a bisection method.  (If Newton's method
24190 appears to be going astray, Calc switches over to bisection if it
24191 can, or otherwise gives up.  In this case it may help to try again
24192 with a slightly different initial guess.)  If the initial guess is a
24193 complex number, the function must be differentiable.
24195 If the formula (or the difference between the sides of an equation)
24196 is negative at one end of the interval you specify and positive at
24197 the other end, the root finder is guaranteed to find a root.
24198 Otherwise, Calc subdivides the interval into small parts looking for
24199 positive and negative values to bracket the root.  When your guess is
24200 an interval, Calc will not look outside that interval for a root.
24202 @kindex H a R
24203 @tindex wroot
24204 The @kbd{H a R} [@code{wroot}] command is similar to @kbd{a R}, except
24205 that if the initial guess is an interval for which the function has
24206 the same sign at both ends, then rather than subdividing the interval
24207 Calc attempts to widen it to enclose a root.  Use this mode if
24208 you are not sure if the function has a root in your interval.
24210 If the function is not differentiable, and you give a simple number
24211 instead of an interval as your initial guess, Calc uses this widening
24212 process even if you did not type the Hyperbolic flag.  (If the function
24213 @emph{is} differentiable, Calc uses Newton's method which does not
24214 require a bounding interval in order to work.)
24216 If Calc leaves the @code{root} or @code{wroot} function in symbolic
24217 form on the stack, it will normally display an explanation for why
24218 no root was found.  If you miss this explanation, press @kbd{w}
24219 (@code{calc-why}) to get it back.
24221 @node Minimization, Numerical Systems of Equations, Root Finding, Numerical Solutions
24222 @subsection Minimization
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
24234 The @kbd{a N} (@code{calc-find-minimum}) [@code{minimize}] command
24235 finds a minimum value for a formula.  It is very similar in operation
24236 to @kbd{a R} (@code{calc-find-root}):  You give the formula and an initial
24237 guess on the stack, and are prompted for the name of a variable.  The guess
24238 may be either a number near the desired minimum, or an interval enclosing
24239 the desired minimum.  The function returns a vector containing the
24240 value of the variable which minimizes the formula's value, along
24241 with the minimum value itself.
24243 Note that this command looks for a @emph{local} minimum.  Many functions
24244 have more than one minimum; some, like 
24245 @texline @math{x \sin x},
24246 @infoline @expr{x sin(x)}, 
24247 have infinitely many.  In fact, there is no easy way to define the
24248 ``global'' minimum of 
24249 @texline @math{x \sin x}
24250 @infoline @expr{x sin(x)} 
24251 but Calc can still locate any particular local minimum
24252 for you.  Calc basically goes downhill from the initial guess until it
24253 finds a point at which the function's value is greater both to the left
24254 and to the right.  Calc does not use derivatives when minimizing a function.
24256 If your initial guess is an interval and it looks like the minimum
24257 occurs at one or the other endpoint of the interval, Calc will return
24258 that endpoint only if that endpoint is closed; thus, minimizing @expr{17 x}
24259 over @expr{[2..3]} will return @expr{[2, 38]}, but minimizing over
24260 @expr{(2..3]} would report no minimum found.  In general, you should
24261 use closed intervals to find literally the minimum value in that
24262 range of @expr{x}, or open intervals to find the local minimum, if
24263 any, that happens to lie in that range.
24265 Most functions are smooth and flat near their minimum values.  Because
24266 of this flatness, if the current precision is, say, 12 digits, the
24267 variable can only be determined meaningfully to about six digits.  Thus
24268 you should set the precision to twice as many digits as you need in your
24269 answer.
24271 @ignore
24272 @mindex wmin@idots
24273 @end ignore
24274 @tindex wminimize
24275 @ignore
24276 @mindex wmax@idots
24277 @end ignore
24278 @tindex wmaximize
24279 The @kbd{H a N} [@code{wminimize}] command, analogously to @kbd{H a R},
24280 expands the guess interval to enclose a minimum rather than requiring
24281 that the minimum lie inside the interval you supply.
24283 The @kbd{a X} (@code{calc-find-maximum}) [@code{maximize}] and
24284 @kbd{H a X} [@code{wmaximize}] commands effectively minimize the
24285 negative of the formula you supply.
24287 The formula must evaluate to a real number at all points inside the
24288 interval (or near the initial guess if the guess is a number).  If
24289 the initial guess is a complex number the variable will be minimized
24290 over the complex numbers; if it is real or an interval it will
24291 be minimized over the reals.
24293 @node Numerical Systems of Equations, , Minimization, Numerical Solutions
24294 @subsection Systems of Equations
24296 @noindent
24297 @cindex Systems of equations, numerical
24298 The @kbd{a R} command can also solve systems of equations.  In this
24299 case, the equation should instead be a vector of equations, the
24300 guess should instead be a vector of numbers (intervals are not
24301 supported), and the variable should be a vector of variables.  You
24302 can omit the brackets while entering the list of variables.  Each
24303 equation must be differentiable by each variable for this mode to
24304 work.  The result will be a vector of two vectors:  The variable
24305 values that solved the system of equations, and the differences
24306 between the sides of the equations with those variable values.
24307 There must be the same number of equations as variables.  Since
24308 only plain numbers are allowed as guesses, the Hyperbolic flag has
24309 no effect when solving a system of equations.
24311 It 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
24313 be replaced by a vector of variables, and the initial guess should
24314 be an equal-sized vector of initial guesses.  But, unlike the case of
24315 multidimensional @kbd{a R}, the formula being minimized should
24316 still be a single formula, @emph{not} a vector.  Beware that
24317 multidimensional minimization is currently @emph{very} slow.
24319 @node Curve Fitting, Summations, Numerical Solutions, Algebra
24320 @section Curve Fitting
24322 @noindent
24323 The @kbd{a F} command fits a set of data to a @dfn{model formula},
24324 such as @expr{y = m x + b} where @expr{m} and @expr{b} are parameters
24325 to be determined.  For a typical set of measured data there will be
24326 no single @expr{m} and @expr{b} that exactly fit the data; in this
24327 case, Calc chooses values of the parameters that provide the closest
24328 possible fit.
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
24339 @node Linear Fits, Polynomial and Multilinear Fits, Curve Fitting, Curve Fitting
24340 @subsection Linear Fits
24342 @noindent
24343 @kindex a F
24344 @pindex calc-curve-fit
24345 @tindex fit
24346 @cindex Linear regression
24347 @cindex Least-squares fits
24348 The @kbd{a F} (@code{calc-curve-fit}) [@code{fit}] command attempts
24349 to fit a set of data (@expr{x} and @expr{y} vectors of numbers) to a
24350 straight line, polynomial, or other function of @expr{x}.  For the
24351 moment we will consider only the case of fitting to a line, and we
24352 will ignore the issue of whether or not the model was in fact a good
24353 fit for the data.
24355 In a standard linear least-squares fit, we have a set of @expr{(x,y)}
24356 data points that we wish to fit to the model @expr{y = m x + b}
24357 by adjusting the parameters @expr{m} and @expr{b} to make the @expr{y}
24358 values calculated from the formula be as close as possible to the actual
24359 @expr{y} values in the data set.  (In a polynomial fit, the model is
24360 instead, say, @expr{y = a x^3 + b x^2 + c x + d}.  In a multilinear fit,
24361 we 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.)
24364 In the model formula, variables like @expr{x} and @expr{x_2} are called
24365 the @dfn{independent variables}, and @expr{y} is the @dfn{dependent
24366 variable}.  Variables like @expr{m}, @expr{a}, and @expr{b} are called
24367 the @dfn{parameters} of the model.
24369 The @kbd{a F} command takes the data set to be fitted from the stack.
24370 By default, it expects the data in the form of a matrix.  For example,
24371 for a linear or polynomial fit, this would be a 
24372 @texline @math{2\times N}
24373 @infoline 2xN
24374 matrix where the first row is a list of @expr{x} values and the second
24375 row has the corresponding @expr{y} values.  For the multilinear fit
24376 shown above, the matrix would have four rows (@expr{x_1}, @expr{x_2},
24377 @expr{x_3}, and @expr{y}, respectively).
24379 If you happen to have an 
24380 @texline @math{N\times2}
24381 @infoline Nx2
24382 matrix instead of a 
24383 @texline @math{2\times N}
24384 @infoline 2xN
24385 matrix, just press @kbd{v t} first to transpose the matrix.
24387 After you type @kbd{a F}, Calc prompts you to select a model.  For a
24388 linear fit, press the digit @kbd{1}.
24390 Calc then prompts for you to name the variables.  By default it chooses
24391 high letters like @expr{x} and @expr{y} for independent variables and
24392 low letters like @expr{a} and @expr{b} for parameters.  (The dependent
24393 variable doesn't need a name.)  The two kinds of variables are separated
24394 by a semicolon.  Since you generally care more about the names of the
24395 independent variables than of the parameters, Calc also allows you to
24396 name only those and let the parameters use default names.
24398 For example, suppose the data matrix
24400 @ifinfo
24401 @example
24402 @group
24403 [ [ 1, 2, 3, 4,  5  ]
24404   [ 5, 7, 9, 11, 13 ] ]
24405 @end group
24406 @end example
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 }
24415 \afterdisplay
24416 @end tex
24418 @noindent
24419 is on the stack and we wish to do a simple linear fit.  Type
24420 @kbd{a F}, then @kbd{1} for the model, then @key{RET} to use
24421 the default names.  The result will be the formula @expr{3 + 2 x}
24422 on the stack.  Calc has created the model expression @kbd{a + b x},
24423 then found the optimal values of @expr{a} and @expr{b} to fit the
24424 data.  (In this case, it was able to find an exact fit.)  Calc then
24425 substituted those values for @expr{a} and @expr{b} in the model
24426 formula.
24428 The @kbd{a F} command puts two entries in the trail.  One is, as
24429 always, a copy of the result that went to the stack; the other is
24430 a vector of the actual parameter values, written as equations:
24431 @expr{[a = 3, b = 2]}, in case you'd rather read them in a list
24432 than pick them out of the formula.  (You can type @kbd{t y}
24433 to move this vector to the stack; see @ref{Trail Commands}.
24435 Specifying a different independent variable name will affect the
24436 resulting formula: @kbd{a F 1 k @key{RET}} produces @kbd{3 + 2 k}.
24437 Changing the parameter names (say, @kbd{a F 1 k;b,m @key{RET}}) will affect
24438 the equations that go into the trail.
24440 @tex
24441 \bigskip
24442 @end tex
24444 To see what happens when the fit is not exact, we could change
24445 the number 13 in the data matrix to 14 and try the fit again.
24446 The result is:
24448 @example
24449 2.6 + 2.2 x
24450 @end example
24452 Evaluating this formula, say with @kbd{v x 5 @key{RET} @key{TAB} V M $ @key{RET}}, shows
24453 a reasonably close match to the y-values in the data.
24455 @example
24456 [4.8, 7., 9.2, 11.4, 13.6]
24457 @end example
24459 Since there is no line which passes through all the @var{n} data points,
24460 Calc has chosen a line that best approximates the data points using
24461 the method of least squares.  The idea is to define the @dfn{chi-square}
24462 error measure
24464 @ifinfo
24465 @example
24466 chi^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
24476 @noindent
24477 which is clearly zero if @expr{a + b x} exactly fits all data points,
24478 and increases as various @expr{a + b x_i} values fail to match the
24479 corresponding @expr{y_i} values.  There are several reasons why the
24480 summand is squared, one of them being to ensure that 
24481 @texline @math{\chi^2 \ge 0}.
24482 @infoline @expr{chi^2 >= 0}.
24483 Least-squares fitting simply chooses the values of @expr{a} and @expr{b}
24484 for which the error 
24485 @texline @math{\chi^2}
24486 @infoline @expr{chi^2} 
24487 is as small as possible.
24489 Other kinds of models do the same thing but with a different model
24490 formula in place of @expr{a + b x_i}.
24492 @tex
24493 \bigskip
24494 @end tex
24496 A numeric prefix argument causes the @kbd{a F} command to take the
24497 data in some other form than one big matrix.  A positive argument @var{n}
24498 will take @var{N} items from the stack, corresponding to the @var{n} rows
24499 of a data matrix.  In the linear case, @var{n} must be 2 since there
24500 is always one independent variable and one dependent variable.
24502 A prefix of zero or plain @kbd{C-u} is a compromise; Calc takes two
24503 items from the stack, an @var{n}-row matrix of @expr{x} values, and a
24504 vector of @expr{y} values.  If there is only one independent variable,
24505 the @expr{x} values can be either a one-row matrix or a plain vector,
24506 in which case the @kbd{C-u} prefix is the same as a @w{@kbd{C-u 2}} prefix.
24508 @node Polynomial and Multilinear Fits, Error Estimates for Fits, Linear Fits, Curve Fitting
24509 @subsection Polynomial and Multilinear Fits
24511 @noindent
24512 To fit the data to higher-order polynomials, just type one of the
24513 digits @kbd{2} through @kbd{9} when prompted for a model.  For example,
24514 we could fit the original data matrix from the previous section
24515 (with 13, not 14) to a parabola instead of a line by typing
24516 @kbd{a F 2 @key{RET}}.
24518 @example
24519 2.00000000001 x - 1.5e-12 x^2 + 2.99999999999
24520 @end example
24522 Note that since the constant and linear terms are enough to fit the
24523 data exactly, it's no surprise that Calc chose a tiny contribution
24524 for @expr{x^2}.  (The fact that it's not exactly zero is due only
24525 to roundoff error.  Since our data are exact integers, we could get
24526 an exact answer by typing @kbd{m f} first to get Fraction mode.
24527 Then the @expr{x^2} term would vanish altogether.  Usually, though,
24528 the data being fitted will be approximate floats so Fraction mode
24529 won't help.)
24531 Doing the @kbd{a F 2} fit on the data set with 14 instead of 13
24532 gives a much larger @expr{x^2} contribution, as Calc bends the
24533 line slightly to improve the fit.
24535 @example
24536 0.142857142855 x^2 + 1.34285714287 x + 3.59999999998
24537 @end example
24539 An important result from the theory of polynomial fitting is that it
24540 is always possible to fit @var{n} data points exactly using a polynomial
24541 of degree @mathit{@var{n}-1}, sometimes called an @dfn{interpolating polynomial}.
24542 Using the modified (14) data matrix, a model number of 4 gives
24543 a polynomial that exactly matches all five data points:
24545 @example
24546 0.04167 x^4 - 0.4167 x^3 + 1.458 x^2 - 0.08333 x + 4.
24547 @end example
24549 The actual coefficients we get with a precision of 12, like
24550 @expr{0.0416666663588}, clearly suffer from loss of precision.
24551 It is a good idea to increase the working precision to several
24552 digits beyond what you need when you do a fitting operation.
24553 Or, if your data are exact, use Fraction mode to get exact
24554 results.
24556 You can type @kbd{i} instead of a digit at the model prompt to fit
24557 the data exactly to a polynomial.  This just counts the number of
24558 columns of the data matrix to choose the degree of the polynomial
24559 automatically.
24561 Fitting data ``exactly'' to high-degree polynomials is not always
24562 a good idea, though.  High-degree polynomials have a tendency to
24563 wiggle uncontrollably in between the fitting data points.  Also,
24564 if the exact-fit polynomial is going to be used to interpolate or
24565 extrapolate the data, it is numerically better to use the @kbd{a p}
24566 command described below.  @xref{Interpolation}.
24568 @tex
24569 \bigskip
24570 @end tex
24572 Another generalization of the linear model is to assume the
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
24575 selected by the @kbd{1} digit key.  (Calc decides whether the fit
24576 is linear or multilinear by counting the rows in the data matrix.)
24578 Given the data matrix,
24580 @example
24581 @group
24582 [ [  1,   2,   3,    4,   5  ]
24583   [  7,   2,   3,    5,   2  ]
24584   [ 14.5, 15, 18.5, 22.5, 24 ] ]
24585 @end group
24586 @end example
24588 @noindent
24589 the command @kbd{a F 1 @key{RET}} will call the first row @expr{x} and the
24590 second row @expr{y}, and will fit the values in the third row to the
24591 model @expr{a + b x + c y}.
24593 @example
24594 8. + 3. x + 0.5 y
24595 @end example
24597 Calc can do multilinear fits with any number of independent variables
24598 (i.e., with any number of data rows).
24600 @tex
24601 \bigskip
24602 @end tex
24604 Yet another variation is @dfn{homogeneous} linear models, in which
24605 the constant term is known to be zero.  In the linear case, this
24606 means the model formula is simply @expr{a x}; in the multilinear
24607 case, the model might be @expr{a x + b y + c z}; and in the polynomial
24608 case, the model could be @expr{a x + b x^2 + c x^3}.  You can get
24609 a homogeneous linear or multilinear model by pressing the letter
24610 @kbd{h} followed by a regular model key, like @kbd{1} or @kbd{2}.
24612 It is certainly possible to have other constrained linear models,
24613 like @expr{2.3 + a x} or @expr{a - 4 x}.  While there is no single
24614 key to select models like these, a later section shows how to enter
24615 any desired model by hand.  In the first case, for example, you
24616 would enter @kbd{a F ' 2.3 + a x}.
24618 Another class of models that will work but must be entered by hand
24619 are multinomial fits, e.g., @expr{a + b x + c y + d x^2 + e y^2 + f x y}.
24621 @node Error Estimates for Fits, Standard Nonlinear Models, Polynomial and Multilinear Fits, Curve Fitting
24622 @subsection Error Estimates for Fits
24624 @noindent
24625 @kindex H a F
24626 @tindex efit
24627 With the Hyperbolic flag, @kbd{H a F} [@code{efit}] performs the same
24628 fitting operation as @kbd{a F}, but reports the coefficients as error
24629 forms instead of plain numbers.  Fitting our two data matrices (first
24630 with 13, then with 14) to a line with @kbd{H a F} gives the results,
24632 @example
24633 3. + 2. x
24634 2.6 +/- 0.382970843103 + 2.2 +/- 0.115470053838 x
24635 @end example
24637 In the first case the estimated errors are zero because the linear
24638 fit is perfect.  In the second case, the errors are nonzero but
24639 moderately small, because the data are still very close to linear.
24641 It is also possible for the @emph{input} to a fitting operation to
24642 contain error forms.  The data values must either all include errors
24643 or all be plain numbers.  Error forms can go anywhere but generally
24644 go on the numbers in the last row of the data matrix.  If the last
24645 row contains error forms
24646 @texline `@var{y_i}@w{ @tfn{+/-} }@math{\sigma_i}', 
24647 @infoline `@var{y_i}@w{ @tfn{+/-} }@var{sigma_i}', 
24648 then the 
24649 @texline @math{\chi^2}
24650 @infoline @expr{chi^2}
24651 statistic is now,
24653 @ifinfo
24654 @example
24655 chi^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
24665 @noindent
24666 so that data points with larger error estimates contribute less to
24667 the fitting operation.
24669 If there are error forms on other rows of the data matrix, all the
24670 errors for a given data point are combined; the square root of the
24671 sum of the squares of the errors forms the 
24672 @texline @math{\sigma_i}
24673 @infoline @expr{sigma_i} 
24674 used for the data point.
24676 Both @kbd{a F} and @kbd{H a F} can accept error forms in the input
24677 matrix, although if you are concerned about error analysis you will
24678 probably use @kbd{H a F} so that the output also contains error
24679 estimates.
24681 If the input contains error forms but all the 
24682 @texline @math{\sigma_i}
24683 @infoline @expr{sigma_i} 
24684 values are the same, it is easy to see that the resulting fitted model
24685 will be the same as if the input did not have error forms at all 
24686 @texline (@math{\chi^2}
24687 @infoline (@expr{chi^2}
24688 is simply scaled uniformly by 
24689 @texline @math{1 / \sigma^2},
24690 @infoline @expr{1 / sigma^2}, 
24691 which doesn't affect where it has a minimum).  But there @emph{will} be
24692 a difference in the estimated errors of the coefficients reported by
24693 @kbd{H a F}. 
24695 Consult any text on statistical modeling of data for a discussion
24696 of where these error estimates come from and how they should be
24697 interpreted.
24699 @tex
24700 \bigskip
24701 @end tex
24703 @kindex I a F
24704 @tindex xfit
24705 With the Inverse flag, @kbd{I a F} [@code{xfit}] produces even more
24706 information.  The result is a vector of six items:
24708 @enumerate
24709 @item
24710 The model formula with error forms for its coefficients or
24711 parameters.  This is the result that @kbd{H a F} would have
24712 produced.
24714 @item
24715 A vector of ``raw'' parameter values for the model.  These are the
24716 polynomial coefficients or other parameters as plain numbers, in the
24717 same order as the parameters appeared in the final prompt of the
24718 @kbd{I a F} command.  For polynomials of degree @expr{d}, this vector
24719 will have length @expr{M = d+1} with the constant term first.
24721 @item
24722 The covariance matrix @expr{C} computed from the fit.  This is
24723 an @var{m}x@var{m} symmetric matrix; the diagonal elements
24724 @texline @math{C_{jj}}
24725 @infoline @expr{C_j_j} 
24726 are the variances 
24727 @texline @math{\sigma_j^2}
24728 @infoline @expr{sigma_j^2} 
24729 of the parameters.  The other elements are covariances
24730 @texline @math{\sigma_{ij}^2} 
24731 @infoline @expr{sigma_i_j^2} 
24732 that describe the correlation between pairs of parameters.  (A related
24733 set of numbers, the @dfn{linear correlation coefficients} 
24734 @texline @math{r_{ij}},
24735 @infoline @expr{r_i_j},
24736 are defined as 
24737 @texline @math{\sigma_{ij}^2 / \sigma_i \, \sigma_j}.)
24738 @infoline @expr{sigma_i_j^2 / sigma_i sigma_j}.)
24740 @item
24741 A vector of @expr{M} ``parameter filter'' functions whose
24742 meanings are described below.  If no filters are necessary this
24743 will instead be an empty vector; this is always the case for the
24744 polynomial and multilinear fits described so far.
24746 @item
24747 The value of 
24748 @texline @math{\chi^2}
24749 @infoline @expr{chi^2} 
24750 for the fit, calculated by the formulas shown above.  This gives a
24751 measure of the quality of the fit; statisticians consider
24752 @texline @math{\chi^2 \approx N - M}
24753 @infoline @expr{chi^2 = N - M} 
24754 to indicate a moderately good fit (where again @expr{N} is the number of
24755 data points and @expr{M} is the number of parameters).
24757 @item
24758 A measure of goodness of fit expressed as a probability @expr{Q}.
24759 This is computed from the @code{utpc} probability distribution
24760 function using 
24761 @texline @math{\chi^2}
24762 @infoline @expr{chi^2} 
24763 with @expr{N - M} degrees of freedom.  A
24764 value of 0.5 implies a good fit; some texts recommend that often
24765 @expr{Q = 0.1} or even 0.001 can signify an acceptable fit.  In
24766 particular, 
24767 @texline @math{\chi^2}
24768 @infoline @expr{chi^2} 
24769 statistics assume the errors in your inputs
24770 follow a normal (Gaussian) distribution; if they don't, you may
24771 have to accept smaller values of @expr{Q}.
24773 The @expr{Q} value is computed only if the input included error
24774 estimates.  Otherwise, Calc will report the symbol @code{nan}
24775 for @expr{Q}.  The reason is that in this case the 
24776 @texline @math{\chi^2}
24777 @infoline @expr{chi^2}
24778 value has effectively been used to estimate the original errors
24779 in the input, and thus there is no redundant information left
24780 over to use for a confidence test.
24781 @end enumerate
24783 @node Standard Nonlinear Models, Curve Fitting Details, Error Estimates for Fits, Curve Fitting
24784 @subsection Standard Nonlinear Models
24786 @noindent
24787 The @kbd{a F} command also accepts other kinds of models besides
24788 lines and polynomials.  Some common models have quick single-key
24789 abbreviations; others must be entered by hand as algebraic formulas.
24791 Here is a complete list of the standard models recognized by @kbd{a F}:
24793 @table @kbd
24794 @item 1
24795 Linear or multilinear.  @mathit{a + b x + c y + d z}.
24796 @item 2-9
24797 Polynomials.  @mathit{a + b x + c x^2 + d x^3}.
24798 @item e
24799 Exponential.  @mathit{a} @tfn{exp}@mathit{(b x)} @tfn{exp}@mathit{(c y)}.
24800 @item E
24801 Base-10 exponential.  @mathit{a} @tfn{10^}@mathit{(b x)} @tfn{10^}@mathit{(c y)}.
24802 @item x
24803 Exponential (alternate notation).  @tfn{exp}@mathit{(a + b x + c y)}.
24804 @item X
24805 Base-10 exponential (alternate).  @tfn{10^}@mathit{(a + b x + c y)}.
24806 @item l
24807 Logarithmic.  @mathit{a + b} @tfn{ln}@mathit{(x) + c} @tfn{ln}@mathit{(y)}.
24808 @item L
24809 Base-10 logarithmic.  @mathit{a + b} @tfn{log10}@mathit{(x) + c} @tfn{log10}@mathit{(y)}.
24810 @item ^
24811 General exponential.  @mathit{a b^x c^y}.
24812 @item p
24813 Power law.  @mathit{a x^b y^c}.
24814 @item q
24815 Quadratic.  @mathit{a + b (x-c)^2 + d (x-e)^2}.
24816 @item g
24817 Gaussian.  
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)}.
24820 @end table
24822 All of these models are used in the usual way; just press the appropriate
24823 letter at the model prompt, and choose variable names if you wish.  The
24824 result will be a formula as shown in the above table, with the best-fit
24825 values of the parameters substituted.  (You may find it easier to read
24826 the parameter values from the vector that is placed in the trail.)
24828 All models except Gaussian and polynomials can generalize as shown to any
24829 number of independent variables.  Also, all the built-in models have an
24830 additive or multiplicative parameter shown as @expr{a} in the above table
24831 which can be replaced by zero or one, as appropriate, by typing @kbd{h}
24832 before the model key.
24834 Note that many of these models are essentially equivalent, but express
24835 the parameters slightly differently.  For example, @expr{a b^x} and
24836 the other two exponential models are all algebraic rearrangements of
24837 each other.  Also, the ``quadratic'' model is just a degree-2 polynomial
24838 with the parameters expressed differently.  Use whichever form best
24839 matches the problem.
24841 The HP-28/48 calculators support four different models for curve
24842 fitting, called @code{LIN}, @code{LOG}, @code{EXP}, and @code{PWR}.
24843 These 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,
24845 @expr{a} is what the HP-48 identifies as the ``intercept,'' and
24846 @expr{b} is what it calls the ``slope.''
24848 @tex
24849 \bigskip
24850 @end tex
24852 If the model you want doesn't appear on this list, press @kbd{'}
24853 (the apostrophe key) at the model prompt to enter any algebraic
24854 formula, such as @kbd{m x - b}, as the model.  (Not all models
24855 will work, though---see the next section for details.)
24857 The model can also be an equation like @expr{y = m x + b}.
24858 In this case, Calc thinks of all the rows of the data matrix on
24859 equal terms; this model effectively has two parameters
24860 (@expr{m} and @expr{b}) and two independent variables (@expr{x}
24861 and @expr{y}), with no ``dependent'' variables.  Model equations
24862 do not need to take this @expr{y =} form.  For example, the
24863 implicit line equation @expr{a x + b y = 1} works fine as a
24864 model.
24866 When you enter a model, Calc makes an alphabetical list of all
24867 the variables that appear in the model.  These are used for the
24868 default parameters, independent variables, and dependent variable
24869 (in that order).  If you enter a plain formula (not an equation),
24870 Calc assumes the dependent variable does not appear in the formula
24871 and thus does not need a name.
24873 For example, if the model formula has the variables @expr{a,mu,sigma,t,x},
24874 and the data matrix has three rows (meaning two independent variables),
24875 Calc will use @expr{a,mu,sigma} as the default parameters, and the
24876 data rows will be named @expr{t} and @expr{x}, respectively.  If you
24877 enter an equation instead of a plain formula, Calc will use @expr{a,mu}
24878 as the parameters, and @expr{sigma,t,x} as the three independent
24879 variables.
24881 You can, of course, override these choices by entering something
24882 different at the prompt.  If you leave some variables out of the list,
24883 those variables must have stored values and those stored values will
24884 be used as constants in the model.  (Stored values for the parameters
24885 and independent variables are ignored by the @kbd{a F} command.)
24886 If you list only independent variables, all the remaining variables
24887 in the model formula will become parameters.
24889 If there are @kbd{$} signs in the model you type, they will stand
24890 for parameters and all other variables (in alphabetical order)
24891 will be independent.  Use @kbd{$} for one parameter, @kbd{$$} for
24892 another, and so on.  Thus @kbd{$ x + $$} is another way to describe
24893 a linear model.
24895 If you type a @kbd{$} instead of @kbd{'} at the model prompt itself,
24896 Calc will take the model formula from the stack.  (The data must then
24897 appear at the second stack level.)  The same conventions are used to
24898 choose which variables in the formula are independent by default and
24899 which are parameters.
24901 Models taken from the stack can also be expressed as vectors of
24902 two or three elements, @expr{[@var{model}, @var{vars}]} or
24903 @expr{[@var{model}, @var{vars}, @var{params}]}.  Each of @var{vars}
24904 and @var{params} may be either a variable or a vector of variables.
24905 (If @var{params} is omitted, all variables in @var{model} except
24906 those listed as @var{vars} are parameters.)
24908 When you enter a model manually with @kbd{'}, Calc puts a 3-vector
24909 describing the model in the trail so you can get it back if you wish.
24911 @tex
24912 \bigskip
24913 @end tex
24915 @vindex Model1
24916 @vindex Model2
24917 Finally, 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
24920 the variable can be any of the formats that @kbd{a F $} would
24921 accept for a model on the stack.
24923 @tex
24924 \bigskip
24925 @end tex
24927 Calc uses the principal values of inverse functions like @code{ln}
24928 and @code{arcsin} when doing fits.  For example, when you enter
24929 the model @samp{y = sin(a t + b)} Calc actually uses the easier
24930 form @samp{arcsin(y) = a t + b}.  The @code{arcsin} function always
24931 returns results in the range from @mathit{-90} to 90 degrees (or the
24932 equivalent range in radians).  Suppose you had data that you
24933 believed to represent roughly three oscillations of a sine wave,
24934 so that the argument of the sine might go from zero to 
24935 @texline @math{3\times360}
24936 @infoline @mathit{3*360} 
24937 degrees.
24938 The above model would appear to be a good way to determine the
24939 true frequency and phase of the sine wave, but in practice it
24940 would fail utterly.  The righthand side of the actual model
24941 @samp{arcsin(y) = a t + b} will grow smoothly with @expr{t}, but
24942 the lefthand side will bounce back and forth between @mathit{-90} and 90.
24943 No values of @expr{a} and @expr{b} can make the two sides match,
24944 even approximately.
24946 There is no good solution to this problem at present.  You could
24947 restrict your data to small enough ranges so that the above problem
24948 doesn't occur (i.e., not straddling any peaks in the sine wave).
24949 Or, in this case, you could use a totally different method such as
24950 Fourier analysis, which is beyond the scope of the @kbd{a F} command.
24951 (Unfortunately, Calc does not currently have any facilities for
24952 taking Fourier and related transforms.)
24954 @node Curve Fitting Details, Interpolation, Standard Nonlinear Models, Curve Fitting
24955 @subsection Curve Fitting Details
24957 @noindent
24958 Calc's internal least-squares fitter can only handle multilinear
24959 models.  More precisely, it can handle any model of the form
24960 @expr{a f(x,y,z) + b g(x,y,z) + c h(x,y,z)}, where @expr{a,b,c}
24961 are the parameters and @expr{x,y,z} are the independent variables
24962 (of course there can be any number of each, not just three).
24964 In a simple multilinear or polynomial fit, it is easy to see how
24965 to convert the model into this form.  For example, if the model
24966 is @expr{a + b x + c x^2}, then @expr{f(x) = 1}, @expr{g(x) = x},
24967 and @expr{h(x) = x^2} are suitable functions.
24969 For other models, Calc uses a variety of algebraic manipulations
24970 to try to put the problem into the form
24972 @smallexample
24973 Y(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
24976 @noindent
24977 where @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,
24979 does a standard linear fit to find the values of @expr{A}, @expr{B},
24980 and @expr{C}, then uses the equation solver to solve for @expr{a,b,c}
24981 in terms of @expr{A,B,C}.
24983 A remarkable number of models can be cast into this general form.
24984 We'll look at two examples here to see how it works.  The power-law
24985 model @expr{y = a x^b} with two independent variables and two parameters
24986 can be rewritten as follows:
24988 @example
24989 y = a x^b
24990 y = a exp(b ln(x))
24991 y = exp(ln(a) + b ln(x))
24992 ln(y) = ln(a) + b ln(x)
24993 @end example
24995 @noindent
24996 which matches the desired form with 
24997 @texline @math{Y = \ln(y)},
24998 @infoline @expr{Y = ln(y)}, 
24999 @texline @math{A = \ln(a)},
25000 @infoline @expr{A = ln(a)},
25001 @expr{F = 1}, @expr{B = b}, and 
25002 @texline @math{G = \ln(x)}.
25003 @infoline @expr{G = ln(x)}.  
25004 Calc thus computes the logarithms of your @expr{y} and @expr{x} values,
25005 does a linear fit for @expr{A} and @expr{B}, then solves to get 
25006 @texline @math{a = \exp(A)} 
25007 @infoline @expr{a = exp(A)} 
25008 and @expr{b = B}.
25010 Another interesting example is the ``quadratic'' model, which can
25011 be handled by expanding according to the distributive law.
25013 @example
25014 y = a + b*(x - c)^2
25015 y = a + b c^2 - 2 b c x + b x^2
25016 @end example
25018 @noindent
25019 which matches with @expr{Y = y}, @expr{A = a + b c^2}, @expr{F = 1},
25020 @expr{B = -2 b c}, @expr{G = x} (the @mathit{-2} factor could just as easily
25021 have been put into @expr{G} instead of @expr{B}), @expr{C = b}, and
25022 @expr{H = x^2}.
25024 The Gaussian model looks quite complicated, but a closer examination
25025 shows that it's actually similar to the quadratic model but with an
25026 exponential that can be brought to the top and moved into @expr{Y}.
25028 An example of a model that cannot be put into general linear
25029 form is a Gaussian with a constant background added on, i.e.,
25030 @expr{d} + the regular Gaussian formula.  If you have a model like
25031 this, your best bet is to replace enough of your parameters with
25032 constants to make the model linearizable, then adjust the constants
25033 manually by doing a series of fits.  You can compare the fits by
25034 graphing them, by examining the goodness-of-fit measures returned by
25035 @kbd{I a F}, or by some other method suitable to your application.
25036 Note that some models can be linearized in several ways.  The
25037 Gaussian-plus-@var{d} model can be linearized by setting @expr{d}
25038 (the background) to a constant, or by setting @expr{b} (the standard
25039 deviation) and @expr{c} (the mean) to constants.
25041 To fit a model with constants substituted for some parameters, just
25042 store suitable values in those parameter variables, then omit them
25043 from the list of parameters when you answer the variables prompt.
25045 @tex
25046 \bigskip
25047 @end tex
25049 A last desperate step would be to use the general-purpose
25050 @code{minimize} function rather than @code{fit}.  After all, both
25051 functions solve the problem of minimizing an expression (the 
25052 @texline @math{\chi^2}
25053 @infoline @expr{chi^2}
25054 sum) by adjusting certain parameters in the expression.  The @kbd{a F}
25055 command is able to use a vastly more efficient algorithm due to its
25056 special knowledge about linear chi-square sums, but the @kbd{a N}
25057 command can do the same thing by brute force.
25059 A compromise would be to pick out a few parameters without which the
25060 fit is linearizable, and use @code{minimize} on a call to @code{fit}
25061 which efficiently takes care of the rest of the parameters.  The thing
25062 to be minimized would be the value of 
25063 @texline @math{\chi^2}
25064 @infoline @expr{chi^2} 
25065 returned as the fifth result of the @code{xfit} function:
25067 @smallexample
25068 minimize(xfit(gaus(a,b,c,d,x), x, [a,b,c], data)_5, d, guess)
25069 @end smallexample
25071 @noindent
25072 where @code{gaus} represents the Gaussian model with background,
25073 @code{data} represents the data matrix, and @code{guess} represents
25074 the initial guess for @expr{d} that @code{minimize} requires.
25075 This operation will only be, shall we say, extraordinarily slow
25076 rather than astronomically slow (as would be the case if @code{minimize}
25077 were used by itself to solve the problem).
25079 @tex
25080 \bigskip
25081 @end tex
25083 The @kbd{I a F} [@code{xfit}] command is somewhat trickier when
25084 nonlinear models are used.  The second item in the result is the
25085 vector of ``raw'' parameters @expr{A}, @expr{B}, @expr{C}.  The
25086 covariance matrix is written in terms of those raw parameters.
25087 The fifth item is a vector of @dfn{filter} expressions.  This
25088 is the empty vector @samp{[]} if the raw parameters were the same
25089 as the requested parameters, i.e., if @expr{A = a}, @expr{B = b},
25090 and so on (which is always true if the model is already linear
25091 in the parameters as written, e.g., for polynomial fits).  If the
25092 parameters had to be rearranged, the fifth item is instead a vector
25093 of one formula per parameter in the original model.  The raw
25094 parameters are expressed in these ``filter'' formulas as
25095 @samp{fitdummy(1)} for @expr{A}, @samp{fitdummy(2)} for @expr{B},
25096 and so on.
25098 When 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
25100 parameters list, and so on for the other raw parameters, then
25101 evaluates the resulting filter formulas to get the actual parameter
25102 values 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,
25104 Calc uses the square roots of the diagonal entries of the covariance
25105 matrix as error values for the raw parameters, then lets Calc's
25106 standard error-form arithmetic take it from there.
25108 If you use @kbd{I a F} with a nonlinear model, be sure to remember
25109 that the covariance matrix is in terms of the raw parameters,
25110 @emph{not} the actual requested parameters.  It's up to you to
25111 figure out how to interpret the covariances in the presence of
25112 nontrivial filter functions.
25114 Things are also complicated when the input contains error forms.
25115 Suppose 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
25117 data.  Calc combines all the error values by taking the square root
25118 of the sum of the squares of the errors.  It then changes @expr{x}
25119 and @expr{y} to be plain numbers, and makes @expr{z} into an error
25120 form with this combined error.  The @expr{Y(x,y,z)} part of the
25121 linearized model is evaluated, and the result should be an error
25122 form.  The error part of that result is used for 
25123 @texline @math{\sigma_i}
25124 @infoline @expr{sigma_i} 
25125 for the data point.  If for some reason @expr{Y(x,y,z)} does not return 
25126 an error form, the combined error from @expr{z} is used directly for 
25127 @texline @math{\sigma_i}.
25128 @infoline @expr{sigma_i}.  
25129 Finally, @expr{z} is also stripped of its error
25130 for use in computing @expr{F(x,y,z)}, @expr{G(x,y,z)} and so on;
25131 the righthand side of the linearized model is computed in regular
25132 arithmetic with no error forms.
25134 (While these rules may seem complicated, they are designed to do
25135 the most reasonable thing in the typical case that @expr{Y(x,y,z)}
25136 depends only on the dependent variable @expr{z}, and in fact is
25137 often simply equal to @expr{z}.  For common cases like polynomials
25138 and multilinear models, the combined error is simply used as the
25139 @texline @math{\sigma}
25140 @infoline @expr{sigma} 
25141 for the data point with no further ado.)
25143 @tex
25144 \bigskip
25145 @end tex
25147 @vindex FitRules
25148 It may be the case that the model you wish to use is linearizable,
25149 but Calc's built-in rules are unable to figure it out.  Calc uses
25150 its algebraic rewrite mechanism to linearize a model.  The rewrite
25151 rules are kept in the variable @code{FitRules}.  You can edit this
25152 variable using the @kbd{s e FitRules} command; in fact, there is
25153 a special @kbd{s F} command just for editing @code{FitRules}.
25154 @xref{Operations on Variables}.
25156 @xref{Rewrite Rules}, for a discussion of rewrite rules.
25158 @ignore
25159 @starindex
25160 @end ignore
25161 @tindex fitvar
25162 @ignore
25163 @starindex
25164 @end ignore
25165 @ignore
25166 @mindex @idots
25167 @end ignore
25168 @tindex fitparam
25169 @ignore
25170 @starindex
25171 @end ignore
25172 @ignore
25173 @mindex @null
25174 @end ignore
25175 @tindex fitmodel
25176 @ignore
25177 @starindex
25178 @end ignore
25179 @ignore
25180 @mindex @null
25181 @end ignore
25182 @tindex fitsystem
25183 @ignore
25184 @starindex
25185 @end ignore
25186 @ignore
25187 @mindex @null
25188 @end ignore
25189 @tindex fitdummy
25190 Calc uses @code{FitRules} as follows.  First, it converts the model
25191 to an equation if necessary and encloses the model equation in a
25192 call to the function @code{fitmodel} (which is not actually a defined
25193 function in Calc; it is only used as a placeholder by the rewrite rules).
25194 Parameter variables are renamed to function calls @samp{fitparam(1)},
25195 @samp{fitparam(2)}, and so on, and independent variables are renamed
25196 to @samp{fitvar(1)}, @samp{fitvar(2)}, etc.  The dependent variable
25197 is the highest-numbered @code{fitvar}.  For example, the power law
25198 model @expr{a x^b} is converted to @expr{y = a x^b}, then to
25200 @smallexample
25201 @group
25202 fitmodel(fitvar(2) = fitparam(1) fitvar(1)^fitparam(2))
25203 @end group
25204 @end smallexample
25206 Calc 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
25208 changes are possible.)
25210 When rewriting is complete, the @code{fitmodel} call should have
25211 been replaced by a @code{fitsystem} call that looks like this:
25213 @example
25214 fitsystem(@var{Y}, @var{FGH}, @var{abc})
25215 @end example
25217 @noindent
25218 where @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)]},
25220 and @var{abc} is the vector of parameter filters which refer to the
25221 raw parameters as @samp{fitdummy(1)} for @expr{A}, @samp{fitdummy(2)}
25222 for @expr{B}, etc.  While the number of raw parameters (the length of
25223 the @var{FGH} vector) is usually the same as the number of original
25224 parameters (the length of the @var{abc} vector), this is not required.
25226 The power law model eventually boils down to
25228 @smallexample
25229 @group
25230 fitsystem(ln(fitvar(2)),
25231           [1, ln(fitvar(1))],
25232           [exp(fitdummy(1)), fitdummy(2)])
25233 @end group
25234 @end smallexample
25236 The actual implementation of @code{FitRules} is complicated; it
25237 proceeds in four phases.  First, common rearrangements are done
25238 to 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
25240 can be put into @var{Y}) or all the way ``in'' (so that they can
25241 be put into @var{abc} or @var{FGH}).  In particular, all
25242 non-constant powers are converted to logs-and-exponentials form,
25243 and the distributive law is used to expand products of sums.
25244 Quotients are rewritten to use the @samp{fitinv} function, where
25245 @samp{fitinv(x)} represents @expr{1/x} while the @code{FitRules}
25246 are operating.  (The use of @code{fitinv} makes recognition of
25247 linear-looking forms easier.)  If you modify @code{FitRules}, you
25248 will probably only need to modify the rules for this phase.
25250 Phase two, whose rules can actually also apply during phases one
25251 and three, first rewrites @code{fitmodel} to a two-argument
25252 form @samp{fitmodel(@var{Y}, @var{model})}, where @var{Y} is
25253 initially zero and @var{model} has been changed from @expr{a=b}
25254 to @expr{a-b} form.  It then tries to peel off invertible functions
25255 from the outside of @var{model} and put them into @var{Y} instead,
25256 calling the equation solver to invert the functions.  Finally, when
25257 this is no longer possible, the @code{fitmodel} is changed to a
25258 four-argument @code{fitsystem}, where the fourth argument is
25259 @var{model} and the @var{FGH} and @var{abc} vectors are initially
25260 empty.  (The last vector is really @var{ABC}, corresponding to
25261 raw parameters, for now.)
25263 Phase three converts a sum of items in the @var{model} to a sum
25264 of @samp{fitpart(@var{a}, @var{b}, @var{c})} terms which represent
25265 terms @samp{@var{a}*@var{b}*@var{c}} of the sum, where @var{a}
25266 is all factors that do not involve any variables, @var{b} is all
25267 factors that involve only parameters, and @var{c} is the factors
25268 that involve only independent variables.  (If this decomposition
25269 is not possible, the rule set will not complete and Calc will
25270 complain that the model is too complex.)  Then @code{fitpart}s
25271 with equal @var{b} or @var{c} components are merged back together
25272 using the distributive law in order to minimize the number of
25273 raw parameters needed.
25275 Phase four moves the @code{fitpart} terms into the @var{FGH} and
25276 @var{ABC} vectors.  Also, some of the algebraic expansions that
25277 were done in phase 1 are undone now to make the formulas more
25278 computationally efficient.  Finally, it calls the solver one more
25279 time to convert the @var{ABC} vector to an @var{abc} vector, and
25280 removes the fourth @var{model} argument (which by now will be zero)
25281 to obtain the three-argument @code{fitsystem} that the linear
25282 least-squares solver wants to see.
25284 @ignore
25285 @starindex
25286 @end ignore
25287 @ignore
25288 @mindex hasfit@idots
25289 @end ignore
25290 @tindex hasfitparams
25291 @ignore
25292 @starindex
25293 @end ignore
25294 @ignore
25295 @mindex @null
25296 @end ignore
25297 @tindex hasfitvars
25298 Two functions which are useful in connection with @code{FitRules}
25299 are @samp{hasfitparams(x)} and @samp{hasfitvars(x)}, which check
25300 whether @expr{x} refers to any parameters or independent variables,
25301 respectively.  Specifically, these functions return ``true'' if the
25302 argument contains any @code{fitparam} (or @code{fitvar}) function
25303 calls, and ``false'' otherwise.  (Recall that ``true'' means a
25304 nonzero number, and ``false'' means zero.  The actual nonzero number
25305 returned is the largest @var{n} from all the @samp{fitparam(@var{n})}s
25306 or @samp{fitvar(@var{n})}s, respectively, that appear in the formula.)
25308 @tex
25309 \bigskip
25310 @end tex
25312 The @code{fit} function in algebraic notation normally takes four
25313 arguments, @samp{fit(@var{model}, @var{vars}, @var{params}, @var{data})},
25314 where @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
25316 independent variables, @var{params} likewise gives the parameter(s),
25317 and @var{data} is the data matrix.  Note that the length of @var{vars}
25318 must be equal to the number of rows in @var{data} if @var{model} is
25319 an equation, or one less than the number of rows if @var{model} is
25320 a plain formula.  (Actually, a name for the dependent variable is
25321 allowed but will be ignored in the plain-formula case.)
25323 If @var{params} is omitted, the parameters are all variables in
25324 @var{model} except those that appear in @var{vars}.  If @var{vars}
25325 is also omitted, Calc sorts all the variables that appear in
25326 @var{model} alphabetically and uses the higher ones for @var{vars}
25327 and the lower ones for @var{params}.
25329 Alternatively, @samp{fit(@var{modelvec}, @var{data})} is allowed
25330 where @var{modelvec} is a 2- or 3-vector describing the model
25331 and variables, as discussed previously.
25333 If Calc is unable to do the fit, the @code{fit} function is left
25334 in symbolic form, ordinarily with an explanatory message.  The
25335 message will be ``Model expression is too complex'' if the
25336 linearizer was unable to put the model into the required form.
25338 The @code{efit} (corresponding to @kbd{H a F}) and @code{xfit}
25339 (for @kbd{I a F}) functions are completely analogous.
25341 @node Interpolation, ,  Curve Fitting Details, Curve Fitting
25342 @subsection Polynomial Interpolation
25344 @kindex a p
25345 @pindex calc-poly-interp
25346 @tindex polint
25347 The @kbd{a p} (@code{calc-poly-interp}) [@code{polint}] command does
25348 a polynomial interpolation at a particular @expr{x} value.  It takes
25349 two arguments from the stack:  A data matrix of the sort used by
25350 @kbd{a F}, and a single number which represents the desired @expr{x}
25351 value.  Calc effectively does an exact polynomial fit as if by @kbd{a F i},
25352 then substitutes the @expr{x} value into the result in order to get an
25353 approximate @expr{y} value based on the fit.  (Calc does not actually
25354 use @kbd{a F i}, however; it uses a direct method which is both more
25355 efficient and more numerically stable.)
25357 The result of @kbd{a p} is actually a vector of two values:  The @expr{y}
25358 value approximation, and an error measure @expr{dy} that reflects Calc's
25359 estimation of the probable error of the approximation at that value of
25360 @expr{x}.  If the input @expr{x} is equal to any of the @expr{x} values
25361 in the data matrix, the output @expr{y} will be the corresponding @expr{y}
25362 value from the matrix, and the output @expr{dy} will be exactly zero.
25364 A prefix argument of 2 causes @kbd{a p} to take separate x- and
25365 y-vectors from the stack instead of one data matrix.
25367 If @expr{x} is a vector of numbers, @kbd{a p} will return a matrix of
25368 interpolated results for each of those @expr{x} values.  (The matrix will
25369 have two columns, the @expr{y} values and the @expr{dy} values.)
25370 If @expr{x} is a formula instead of a number, the @code{polint} function
25371 remains in symbolic form; use the @kbd{a "} command to expand it out to
25372 a formula that describes the fit in symbolic terms.
25374 In all cases, the @kbd{a p} command leaves the data vectors or matrix
25375 on the stack.  Only the @expr{x} value is replaced by the result.
25377 @kindex H a p
25378 @tindex ratint
25379 The @kbd{H a p} [@code{ratint}] command does a rational function
25380 interpolation.  It is used exactly like @kbd{a p}, except that it
25381 uses as its model the quotient of two polynomials.  If there are
25382 @expr{N} data points, the numerator and denominator polynomials will
25383 each have degree @expr{N/2} (if @expr{N} is odd, the denominator will
25384 have degree one higher than the numerator).
25386 Rational approximations have the advantage that they can accurately
25387 describe functions that have poles (points at which the function's value
25388 goes to infinity, so that the denominator polynomial of the approximation
25389 goes to zero).  If @expr{x} corresponds to a pole of the fitted rational
25390 function, then the result will be a division by zero.  If Infinite mode
25391 is enabled, the result will be @samp{[uinf, uinf]}.
25393 There is no way to get the actual coefficients of the rational function
25394 used by @kbd{H a p}.  (The algorithm never generates these coefficients
25395 explicitly, and quotients of polynomials are beyond @w{@kbd{a F}}'s
25396 capabilities to fit.)
25398 @node Summations, Logical Operations, Curve Fitting, Algebra
25399 @section Summations
25401 @noindent
25402 @cindex Summation of a series
25403 @kindex a +
25404 @pindex calc-summation
25405 @tindex sum
25406 The @kbd{a +} (@code{calc-summation}) [@code{sum}] command computes
25407 the sum of a formula over a certain range of index values.  The formula
25408 is taken from the top of the stack; the command prompts for the
25409 name of the summation index variable, the lower limit of the
25410 sum (any formula), and the upper limit of the sum.  If you
25411 enter a blank line at any of these prompts, that prompt and
25412 any later ones are answered by reading additional elements from
25413 the stack.  Thus, @kbd{' k^2 @key{RET} ' k @key{RET} 1 @key{RET} 5 @key{RET} a + @key{RET}}
25414 produces the result 55.
25415 @tex
25416 \turnoffactive
25417 $$ \sum_{k=1}^5 k^2 = 55 $$
25418 @end tex
25420 The choice of index variable is arbitrary, but it's best not to
25421 use a variable with a stored value.  In particular, while
25422 @code{i} is often a favorite index variable, it should be avoided
25423 in Calc because @code{i} has the imaginary constant @expr{(0, 1)}
25424 as a value.  If you pressed @kbd{=} on a sum over @code{i}, it would
25425 be changed to a nonsensical sum over the ``variable'' @expr{(0, 1)}!
25426 If you really want to use @code{i} as an index variable, use
25427 @w{@kbd{s u i @key{RET}}} first to ``unstore'' this variable.
25428 (@xref{Storing Variables}.)
25430 A numeric prefix argument steps the index by that amount rather
25431 than by one.  Thus @kbd{' a_k @key{RET} C-u -2 a + k @key{RET} 10 @key{RET} 0 @key{RET}}
25432 yields @samp{a_10 + a_8 + a_6 + a_4 + a_2 + a_0}.  A prefix
25433 argument of plain @kbd{C-u} causes @kbd{a +} to prompt for the
25434 step value, in which case you can enter any formula or enter
25435 a 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
25437 the stack:  The formula, the variable, the lower limit, the
25438 upper limit, and (at the top of the stack), the step value.
25440 Calc 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,
25442 this is possible if the formula being summed is polynomial or
25443 exponential in the index variable.  Sums of logarithms are
25444 transformed into logarithms of products.  Sums of trigonometric
25445 and hyperbolic functions are transformed to sums of exponentials
25446 and then done in closed form.  Also, of course, sums in which the
25447 lower and upper limits are both numbers can always be evaluated
25448 just by grinding them out, although Calc will use closed forms
25449 whenever it can for the sake of efficiency.
25451 The notation for sums in algebraic formulas is
25452 @samp{sum(@var{expr}, @var{var}, @var{low}, @var{high}, @var{step})}.
25453 If @var{step} is omitted, it defaults to one.  If @var{high} is
25454 omitted, @var{low} is actually the upper limit and the lower limit
25455 is one.  If @var{low} is also omitted, the limits are @samp{-inf}
25456 and @samp{inf}, respectively.
25458 Infinite sums can sometimes be evaluated:  @samp{sum(.5^k, k, 1, inf)}
25459 returns @expr{1}.  This is done by evaluating the sum in closed
25460 form (to @samp{1. - 0.5^n} in this case), then evaluating this
25461 formula with @code{n} set to @code{inf}.  Calc's usual rules
25462 for ``infinite'' arithmetic can find the answer from there.  If
25463 infinite arithmetic yields a @samp{nan}, or if the sum cannot be
25464 solved in closed form, Calc leaves the @code{sum} function in
25465 symbolic form.  @xref{Infinities}.
25467 As a special feature, if the limits are infinite (or omitted, as
25468 described above) but the formula includes vectors subscripted by
25469 expressions that involve the iteration variable, Calc narrows
25470 the limits to include only the range of integers which result in
25471 valid subscripts for the vector.  For example, the sum
25472 @samp{sum(k [a,b,c,d,e,f,g]_(2k),k)} evaluates to @samp{b + 2 d + 3 f}.
25474 The 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)}.
25476 Calc computes the number of iterations using the formula
25477 @samp{1 + (@var{high} - @var{low}) / @var{step}}, which must,
25478 after simplification as if by @kbd{a s}, evaluate to an integer.
25480 If the number of iterations according to the above formula does
25481 not come out to an integer, the sum is invalid and will be left
25482 in symbolic form.  However, closed forms are still supplied, and
25483 you are on your honor not to misuse the resulting formulas by
25484 substituting mismatched bounds into them.  For example,
25485 @samp{sum(k, k, 1, 10, 2)} is invalid, but Calc will go ahead and
25486 evaluate the closed form solution for the limits 1 and 10 to get
25487 the rather dubious answer, 29.25.
25489 If the lower limit is greater than the upper limit (assuming a
25490 positive step size), the result is generally zero.  However,
25491 Calc only guarantees a zero result when the upper limit is
25492 exactly one step less than the lower limit, i.e., if the number
25493 of iterations is @mathit{-1}.  Thus @samp{sum(f(k), k, n, n-1)} is zero
25494 but the sum from @samp{n} to @samp{n-2} may report a nonzero value
25495 if Calc used a closed form solution.
25497 Calc's logical predicates like @expr{a < b} return 1 for ``true''
25498 and 0 for ``false.''  @xref{Logical Operations}.  This can be
25499 used 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
25501 prime numbers from 1 to 20; the @code{prime} predicate returns 1 if
25502 its argument is prime and 0 otherwise.  You can read this expression
25503 as ``the sum of @expr{k^2}, where @expr{k} is prime.''  Indeed,
25504 @samp{sum(prime(k)*k^2, k)} would represent the sum of @emph{all} primes
25505 squared, since the limits default to plus and minus infinity, but
25506 there are no such sums that Calc's built-in rules can do in
25507 closed form.
25509 As another example, @samp{sum((k != k_0) * f(k), k, 1, n)} is the
25510 sum of @expr{f(k)} for all @expr{k} from 1 to @expr{n}, excluding
25511 one value @expr{k_0}.  Slightly more tricky is the summand
25512 @samp{(k != k_0) / (k - k_0)}, which is an attempt to describe
25513 the sum of all @expr{1/(k-k_0)} except at @expr{k = k_0}, where
25514 this would be a division by zero.  But at @expr{k = k_0}, this
25515 formula works out to the indeterminate form @expr{0 / 0}, which
25516 Calc will not assume is zero.  Better would be to use
25517 @samp{(k != k_0) ? 1/(k-k_0) : 0}; the @samp{? :} operator does
25518 an ``if-then-else'' test:  This expression says, ``if 
25519 @texline @math{k \ne k_0},
25520 @infoline @expr{k != k_0},
25521 then @expr{1/(k-k_0)}, else zero.''  Now the formula @expr{1/(k-k_0)}
25522 will not even be evaluated by Calc when @expr{k = k_0}.
25524 @cindex Alternating sums
25525 @kindex a -
25526 @pindex calc-alt-summation
25527 @tindex asum
25528 The @kbd{a -} (@code{calc-alt-summation}) [@code{asum}] command
25529 computes an alternating sum.  Successive terms of the sequence
25530 are given alternating signs, with the first term (corresponding
25531 to the lower index value) being positive.  Alternating sums
25532 are converted to normal sums with an extra term of the form
25533 @samp{(-1)^(k-@var{low})}.  This formula is adjusted appropriately
25534 if the step value is other than one.  For example, the Taylor
25535 series 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
25537 it if you replace @code{inf} with any particular odd number.)
25538 Calc converts this series to a regular sum with a step of one,
25539 namely @samp{sum((-1)^k x^(2k+1) / (2k+1)!, k, 0, inf)}.
25541 @cindex Product of a sequence
25542 @kindex a *
25543 @pindex calc-product
25544 @tindex prod
25545 The @kbd{a *} (@code{calc-product}) [@code{prod}] command is
25546 the analogous way to take a product of many terms.  Calc also knows
25547 some closed forms for products, such as @samp{prod(k, k, 1, n) = n!}.
25548 Conditional products can be written @samp{prod(k^prime(k), k, 1, n)}
25549 or @samp{prod(prime(k) ? k : 1, k, 1, n)}.
25551 @kindex a T
25552 @pindex calc-tabulate
25553 @tindex table
25554 The @kbd{a T} (@code{calc-tabulate}) [@code{table}] command
25555 evaluates a formula at a series of iterated index values, just
25556 like @code{sum} and @code{prod}, but its result is simply a
25557 vector of the results.  For example, @samp{table(a_i, i, 1, 7, 2)}
25558 produces @samp{[a_1, a_3, a_5, a_7]}.
25560 @node Logical Operations, Rewrite Rules, Summations, Algebra
25561 @section Logical Operations
25563 @noindent
25564 The following commands and algebraic functions return true/false values,
25565 where 1 represents ``true'' and 0 represents ``false.''  In cases where
25566 a truth value is required (such as for the condition part of a rewrite
25567 rule, or as the condition for a @w{@kbd{Z [ Z ]}} control structure), any
25568 nonzero value is accepted to mean ``true.''  (Specifically, anything
25569 for which @code{dnonzero} returns 1 is ``true,'' and anything for
25570 which @code{dnonzero} returns 0 or cannot decide is assumed ``false.''
25571 Note that this means that @w{@kbd{Z [ Z ]}} will execute the ``then''
25572 portion if its condition is provably true, but it will execute the
25573 ``else'' portion for any condition like @expr{a = b} that is not
25574 provably true, even if it might be true.  Algebraic functions that
25575 have conditions as arguments, like @code{? :} and @code{&&}, remain
25576 unevaluated if the condition is neither provably true nor provably
25577 false.  @xref{Declarations}.)
25579 @kindex a =
25580 @pindex calc-equal-to
25581 @tindex eq
25582 @tindex =
25583 @tindex ==
25584 The @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
25586 formula) is true if @expr{a} and @expr{b} are equal, either because they
25587 are identical expressions, or because they are numbers which are
25588 numerically equal.  (Thus the integer 1 is considered equal to the float
25589 1.0.)  If the equality of @expr{a} and @expr{b} cannot be determined,
25590 the comparison is left in symbolic form.  Note that as a command, this
25591 operation pops two values from the stack and pushes back either a 1 or
25592 a 0, or a formula @samp{a = b} if the values' equality cannot be determined.
25594 Many Calc commands use @samp{=} formulas to represent @dfn{equations}.
25595 For example, the @kbd{a S} (@code{calc-solve-for}) command rearranges
25596 an equation to solve for a given variable.  The @kbd{a M}
25597 (@code{calc-map-equation}) command can be used to apply any
25598 function to both sides of an equation; for example, @kbd{2 a M *}
25599 multiplies 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
25602 zero if not.
25604 The @code{eq} function with more than two arguments (e.g., @kbd{C-u 3 a =}
25605 or @samp{a = b = c}) tests if all of its arguments are equal.  In
25606 algebraic notation, the @samp{=} operator is unusual in that it is
25607 neither left- nor right-associative:  @samp{a = b = c} is not the
25608 same as @samp{(a = b) = c} or @samp{a = (b = c)} (which each compare
25609 one variable with the 1 or 0 that results from comparing two other
25610 variables).
25612 @kindex a #
25613 @pindex calc-not-equal-to
25614 @tindex neq
25615 @tindex !=
25616 The @kbd{a #} (@code{calc-not-equal-to}) command, or @samp{neq(a,b)} or
25617 @samp{a != b} function, is true if @expr{a} and @expr{b} are not equal.
25618 This also works with more than two arguments; @samp{a != b != c != d}
25619 tests that all four of @expr{a}, @expr{b}, @expr{c}, and @expr{d} are
25620 distinct numbers.
25622 @kindex a <
25623 @tindex lt
25624 @ignore
25625 @mindex @idots
25626 @end ignore
25627 @kindex a >
25628 @ignore
25629 @mindex @null
25630 @end ignore
25631 @kindex a [
25632 @ignore
25633 @mindex @null
25634 @end ignore
25635 @kindex a ]
25636 @pindex calc-less-than
25637 @pindex calc-greater-than
25638 @pindex calc-less-equal
25639 @pindex calc-greater-equal
25640 @ignore
25641 @mindex @null
25642 @end ignore
25643 @tindex gt
25644 @ignore
25645 @mindex @null
25646 @end ignore
25647 @tindex leq
25648 @ignore
25649 @mindex @null
25650 @end ignore
25651 @tindex geq
25652 @ignore
25653 @mindex @null
25654 @end ignore
25655 @tindex <
25656 @ignore
25657 @mindex @null
25658 @end ignore
25659 @tindex >
25660 @ignore
25661 @mindex @null
25662 @end ignore
25663 @tindex <=
25664 @ignore
25665 @mindex @null
25666 @end ignore
25667 @tindex >=
25668 The @kbd{a <} (@code{calc-less-than}) [@samp{lt(a,b)} or @samp{a < b}]
25669 operation is true if @expr{a} is less than @expr{b}.  Similar functions
25670 are @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}].
25674 While the inequality functions like @code{lt} do not accept more
25675 than two arguments, the syntax @w{@samp{a <= b < c}} is translated to an
25676 equivalent expression involving intervals: @samp{b in [a .. c)}.
25677 (See the description of @code{in} below.)  All four combinations
25678 of @samp{<} and @samp{<=} are allowed, or any of the four combinations
25679 of @samp{>} and @samp{>=}.  Four-argument constructions like
25680 @samp{a < b < c < d}, and mixtures like @w{@samp{a < b = c}} that
25681 involve both equalities and inequalities, are not allowed.
25683 @kindex a .
25684 @pindex calc-remove-equal
25685 @tindex rmeq
25686 The @kbd{a .} (@code{calc-remove-equal}) [@code{rmeq}] command extracts
25687 the righthand side of the equation or inequality on the top of the
25688 stack.  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
25691 variable and the lefthand side is a number (as in @samp{2.34 = x}), then
25692 Calc keeps the lefthand side instead.  Finally, this command works with
25693 assignments @samp{x := 2.34} as well as equations, always taking the
25694 righthand side, and for @samp{=>} (evaluates-to) operators, always
25695 taking the lefthand side.
25697 @kindex a &
25698 @pindex calc-logical-and
25699 @tindex land
25700 @tindex &&
25701 The @kbd{a &} (@code{calc-logical-and}) [@samp{land(a,b)} or @samp{a && b}]
25702 function is true if both of its arguments are true, i.e., are
25703 non-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
25705 zero.  Otherwise, the formula is left in symbolic form.
25707 @kindex a |
25708 @pindex calc-logical-or
25709 @tindex lor
25710 @tindex ||
25711 The @kbd{a |} (@code{calc-logical-or}) [@samp{lor(a,b)} or @samp{a || b}]
25712 function is true if either or both of its arguments are true (nonzero).
25713 The result is whichever argument was nonzero, choosing arbitrarily if both
25714 are nonzero.  If both @expr{a} and @expr{b} are zero, the result is
25715 zero.
25717 @kindex a !
25718 @pindex calc-logical-not
25719 @tindex lnot
25720 @tindex !
25721 The @kbd{a !} (@code{calc-logical-not}) [@samp{lnot(a)} or @samp{!@: a}]
25722 function is true if @expr{a} is false (zero), or false if @expr{a} is
25723 true (nonzero).  It is left in symbolic form if @expr{a} is not a
25724 number.
25726 @kindex a :
25727 @pindex calc-logical-if
25728 @tindex if
25729 @ignore
25730 @mindex ? :
25731 @end ignore
25732 @tindex ?
25733 @ignore
25734 @mindex @null
25735 @end ignore
25736 @tindex :
25737 @cindex Arguments, not evaluated
25738 The @kbd{a :} (@code{calc-logical-if}) [@samp{if(a,b,c)} or @samp{a ? b :@: c}]
25739 function is equal to either @expr{b} or @expr{c} if @expr{a} is a nonzero
25740 number or zero, respectively.  If @expr{a} is not a number, the test is
25741 left in symbolic form and neither @expr{b} nor @expr{c} is evaluated in
25742 any way.  In algebraic formulas, this is one of the few Calc functions
25743 whose arguments are not automatically evaluated when the function itself
25744 is evaluated.  The others are @code{lambda}, @code{quote}, and
25745 @code{condition}.
25747 One minor surprise to watch out for is that the formula @samp{a?3:4}
25748 will not work because the @samp{3:4} is parsed as a fraction instead of
25749 as three separate symbols.  Type something like @samp{a ? 3 : 4} or
25750 @samp{a?(3):4} instead.
25752 As a special case, if @expr{a} evaluates to a vector, then both @expr{b}
25753 and @expr{c} are evaluated; the result is a vector of the same length
25754 as @expr{a} whose elements are chosen from corresponding elements of
25755 @expr{b} and @expr{c} according to whether each element of @expr{a}
25756 is zero or nonzero.  Each of @expr{b} and @expr{c} must be either a
25757 vector of the same length as @expr{a}, or a non-vector which is matched
25758 with all elements of @expr{a}.
25760 @kindex a @{
25761 @pindex calc-in-set
25762 @tindex in
25763 The @kbd{a @{} (@code{calc-in-set}) [@samp{in(a,b)}] function is true if
25764 the number @expr{a} is in the set of numbers represented by @expr{b}.
25765 If @expr{b} is an interval form, @expr{a} must be one of the values
25766 encompassed by the interval.  If @expr{b} is a vector, @expr{a} must be
25767 equal to one of the elements of the vector.  (If any vector elements are
25768 intervals, @expr{a} must be in any of the intervals.)  If @expr{b} is a
25769 plain number, @expr{a} must be numerically equal to @expr{b}.
25770 @xref{Set Operations}, for a group of commands that manipulate sets
25771 of this sort.
25773 @ignore
25774 @starindex
25775 @end ignore
25776 @tindex typeof
25777 The @samp{typeof(a)} function produces an integer or variable which
25778 characterizes @expr{a}.  If @expr{a} is a number, vector, or variable,
25779 the result will be one of the following numbers:
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
25791 10   Date-only form
25792 11   Date/time form
25793 12   Infinity (inf, uinf, or nan)
25794 100  Variable
25795 101  Vector (but not a matrix)
25796 102  Matrix
25797 @end example
25799 Otherwise, @expr{a} is a formula, and the result is a variable which
25800 represents the name of the top-level function call.
25802 @ignore
25803 @starindex
25804 @end ignore
25805 @tindex integer
25806 @ignore
25807 @starindex
25808 @end ignore
25809 @tindex real
25810 @ignore
25811 @starindex
25812 @end ignore
25813 @tindex constant
25814 The @samp{integer(a)} function returns true if @expr{a} is an integer.
25815 The @samp{real(a)} function
25816 is true if @expr{a} is a real number, either integer, fraction, or
25817 float.  The @samp{constant(a)} function returns true if @expr{a} is
25818 any of the objects for which @code{typeof} would produce an integer
25819 code result except for variables, and provided that the components of
25820 an object like a vector or error form are themselves constant.
25821 Note that infinities do not satisfy any of these tests, nor do
25822 special constants like @code{pi} and @code{e}.
25824 @xref{Declarations}, for a set of similar functions that recognize
25825 formulas as well as actual numbers.  For example, @samp{dint(floor(x))}
25826 is true because @samp{floor(x)} is provably integer-valued, but
25827 @samp{integer(floor(x))} does not because @samp{floor(x)} is not
25828 literally an integer constant.
25830 @ignore
25831 @starindex
25832 @end ignore
25833 @tindex refers
25834 The @samp{refers(a,b)} function is true if the variable (or sub-expression)
25835 @expr{b} appears in @expr{a}, or false otherwise.  Unlike the other
25836 tests described here, this function returns a definite ``no'' answer
25837 even if its arguments are still in symbolic form.  The only case where
25838 @code{refers} will be left unevaluated is if @expr{a} is a plain
25839 variable (different from @expr{b}).
25841 @ignore
25842 @starindex
25843 @end ignore
25844 @tindex negative
25845 The @samp{negative(a)} function returns true if @expr{a} ``looks'' negative,
25846 because it is a negative number, because it is of the form @expr{-x},
25847 or because it is a product or quotient with a term that looks negative.
25848 This is most useful in rewrite rules.  Beware that @samp{negative(a)}
25849 evaluates to 1 or 0 for @emph{any} argument @expr{a}, so it can only
25850 be stored in a formula if the default simplifications are turned off
25851 first with @kbd{m O} (or if it appears in an unevaluated context such
25852 as a rewrite rule condition).
25854 @ignore
25855 @starindex
25856 @end ignore
25857 @tindex variable
25858 The @samp{variable(a)} function is true if @expr{a} is a variable,
25859 or false if not.  If @expr{a} is a function call, this test is left
25860 in symbolic form.  Built-in variables like @code{pi} and @code{inf}
25861 are considered variables like any others by this test.
25863 @ignore
25864 @starindex
25865 @end ignore
25866 @tindex nonvar
25867 The @samp{nonvar(a)} function is true if @expr{a} is a non-variable.
25868 If its argument is a variable it is left unsimplified; it never
25869 actually returns zero.  However, since Calc's condition-testing
25870 commands consider ``false'' anything not provably true, this is
25871 often good enough.
25873 @ignore
25874 @starindex
25875 @end ignore
25876 @tindex lin
25877 @ignore
25878 @starindex
25879 @end ignore
25880 @tindex linnt
25881 @ignore
25882 @starindex
25883 @end ignore
25884 @tindex islin
25885 @ignore
25886 @starindex
25887 @end ignore
25888 @tindex islinnt
25889 @cindex Linearity testing
25890 The functions @code{lin}, @code{linnt}, @code{islin}, and @code{islinnt}
25891 check if an expression is ``linear,'' i.e., can be written in the form
25892 @expr{a + b x} for some constants @expr{a} and @expr{b}, and some
25893 variable or subformula @expr{x}.  The function @samp{islin(f,x)} checks
25894 if formula @expr{f} is linear in @expr{x}, returning 1 if so.  For
25895 example, @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
25897 is similar, except that instead of returning 1 it returns the vector
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}
25901 generally remain unevaluated for expressions which are not linear,
25902 e.g., @samp{lin(2 x^2, x)} and @samp{lin(sin(x), x)}.  The second
25903 argument can also be a formula; @samp{islin(2 + 3 sin(x), sin(x))}
25904 returns true.
25906 The @code{linnt} and @code{islinnt} functions perform a similar check,
25907 but require a ``non-trivial'' linear form, which means that the
25908 @expr{b} coefficient must be non-zero.  For example, @samp{lin(2,x)}
25909 returns @expr{[2, 0, x]} and @samp{lin(y,x)} returns @expr{[y, 0, x]},
25910 but @samp{linnt(2,x)} and @samp{linnt(y,x)} are left unevaluated
25911 (in other words, these formulas are considered to be only ``trivially''
25912 linear in @expr{x}).
25914 All four linearity-testing functions allow you to omit the second
25915 argument, in which case the input may be linear in any non-constant
25916 formula.  Here, the @expr{a=0}, @expr{b=1} case is also considered
25917 trivial, and only constant values for @expr{a} and @expr{b} are
25918 recognized.  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)}
25920 returns @expr{[0, 1, x y]}.  The @code{linnt} function would allow the
25921 first two cases but not the third.  Also, neither @code{lin} nor
25922 @code{linnt} accept plain constants as linear in the one-argument
25923 case: @samp{islin(2,x)} is true, but @samp{islin(2)} is false.
25925 @ignore
25926 @starindex
25927 @end ignore
25928 @tindex istrue
25929 The @samp{istrue(a)} function returns 1 if @expr{a} is a nonzero
25930 number or provably nonzero formula, or 0 if @expr{a} is anything else.
25931 Calls to @code{istrue} can only be manipulated if @kbd{m O} mode is
25932 used to make sure they are not evaluated prematurely.  (Note that
25933 declarations are used when deciding whether a formula is true;
25934 @code{istrue} returns 1 when @code{dnonzero} would return 1, and
25935 it returns 0 when @code{dnonzero} would return 0 or leave itself
25936 in symbolic form.)
25938 @node Rewrite Rules, , Logical Operations, Algebra
25939 @section Rewrite Rules
25941 @noindent
25942 @cindex Rewrite rules
25943 @cindex Transformations
25944 @cindex Pattern matching
25945 @kindex a r
25946 @pindex calc-rewrite
25947 @tindex rewrite
25948 The @kbd{a r} (@code{calc-rewrite}) [@code{rewrite}] command makes
25949 substitutions in a formula according to a specified pattern or patterns
25950 known as @dfn{rewrite rules}.  Whereas @kbd{a b} (@code{calc-substitute})
25951 matches literally, so that substituting @samp{sin(x)} with @samp{cos(x)}
25952 matches only the @code{sin} function applied to the variable @code{x},
25953 rewrite rules match general kinds of formulas; rewriting using the rule
25954 @samp{sin(x) := cos(x)} matches @code{sin} of any argument and replaces
25955 it with @code{cos} of that same argument.  The only significance of the
25956 name @code{x} is that the same name is used on both sides of the rule.
25958 Rewrite rules rearrange formulas already in Calc's memory.
25959 @xref{Syntax Tables}, to read about @dfn{syntax rules}, which are
25960 similar to algebraic rewrite rules but operate when new algebraic
25961 entries are being parsed, converting strings of characters into
25962 Calc formulas.
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
25980 @node Entering Rewrite Rules, Basic Rewrite Rules, Rewrite Rules, Rewrite Rules
25981 @subsection Entering Rewrite Rules
25983 @noindent
25984 Rewrite rules normally use the ``assignment'' operator
25985 @samp{@var{old} := @var{new}}.
25986 This operator is equivalent to the function call @samp{assign(old, new)}.
25987 The @code{assign} function is undefined by itself in Calc, so an
25988 assignment formula such as a rewrite rule will be left alone by ordinary
25989 Calc commands.  But certain commands, like the rewrite system, interpret
25990 assignments in special ways.
25992 For example, the rule @samp{sin(x)^2 := 1-cos(x)^2} says to replace
25993 every occurrence of the sine of something, squared, with one minus the
25994 square of the cosine of that same thing.  All by itself as a formula
25995 on the stack it does nothing, but when given to the @kbd{a r} command
25996 it turns that command into a sine-squared-to-cosine-squared converter.
25998 To specify a set of rules to be applied all at once, make a vector of
25999 rules.
26001 When @kbd{a r} prompts you to enter the rewrite rules, you can answer
26002 in several ways:
26004 @enumerate
26005 @item
26006 With a rule:  @kbd{f(x) := g(x) @key{RET}}.
26007 @item
26008 With a vector of rules:  @kbd{[f1(x) := g1(x), f2(x) := g2(x)] @key{RET}}.
26009 (You can omit the enclosing square brackets if you wish.)
26010 @item
26011 With the name of a variable that contains the rule or rules vector:
26012 @kbd{myrules @key{RET}}.
26013 @item
26014 With any formula except a rule, a vector, or a variable name; this
26015 will be interpreted as the @var{old} half of a rewrite rule,
26016 and you will be prompted a second time for the @var{new} half:
26017 @kbd{f(x) @key{RET} g(x) @key{RET}}.
26018 @item
26019 With a blank line, in which case the rule, rules vector, or variable
26020 will be taken from the top of the stack (and the formula to be
26021 rewritten will come from the second-to-top position).
26022 @end enumerate
26024 If you enter the rules directly (as opposed to using rules stored
26025 in a variable), those rules will be put into the Trail so that you
26026 can retrieve them later.  @xref{Trail Commands}.
26028 It is most convenient to store rules you use often in a variable and
26029 invoke 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
26031 rule set stored in a variable.  You may also wish to use @kbd{s p}
26032 (@code{calc-permanent-variable}) to save your rules permanently;
26033 @pxref{Operations on Variables}.
26035 Rewrite rules are compiled into a special internal form for faster
26036 matching.  If you enter a rule set directly it must be recompiled
26037 every time.  If you store the rules in a variable and refer to them
26038 through that variable, they will be compiled once and saved away
26039 along with the variable for later reference.  This is another good
26040 reason to store your rules in a variable.
26042 Calc also accepts an obsolete notation for rules, as vectors
26043 @samp{[@var{old}, @var{new}]}.  But because it is easily confused with a
26044 vector of two rules, the use of this notation is no longer recommended.
26046 @node Basic Rewrite Rules, Conditional Rewrite Rules, Entering Rewrite Rules, Rewrite Rules
26047 @subsection Basic Rewrite Rules
26049 @noindent
26050 To 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
26052 the structure of @var{old}.  Variables that appear in @var{old} are
26053 treated as @dfn{meta-variables}; the corresponding positions in @expr{x}
26054 may contain any sub-formulas.  For example, the pattern @samp{f(x,y)}
26055 would 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
26059 that will make the pattern match these expressions.  Notice that if
26060 the pattern is a single meta-variable, it will match any expression.
26062 If a given meta-variable appears more than once in @var{old}, the
26063 corresponding sub-formulas of @expr{x} must be identical.  Thus
26064 the 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.)
26068 Things other than variables must match exactly between the pattern
26069 and the target formula.  To match a particular variable exactly, use
26070 the pseudo-function @samp{quote(v)} in the pattern.  For example, the
26071 pattern @samp{x+quote(y)} matches @samp{x+y}, @samp{2+y}, or
26072 @samp{sin(a)+y}.
26074 The special variable names @samp{e}, @samp{pi}, @samp{i}, @samp{phi},
26075 @samp{gamma}, @samp{inf}, @samp{uinf}, and @samp{nan} always match
26076 literally.  Thus the pattern @samp{sin(d + e + f)} acts exactly like
26077 @samp{sin(d + quote(e) + f)}.
26079 If the @var{old} pattern is found to match a given formula, that
26080 formula is replaced by @var{new}, where any occurrences in @var{new}
26081 of meta-variables from the pattern are replaced with the sub-formulas
26082 that they matched.  Thus, applying the rule @samp{f(x,y) := g(y+x,x)}
26083 to @samp{f(12, a+1)} would produce @samp{g(a+13, 12)}.
26085 The normal @kbd{a r} command applies rewrite rules over and over
26086 throughout 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
26088 change at a time.
26090 @node Conditional Rewrite Rules, Algebraic Properties of Rewrite Rules, Basic Rewrite Rules, Rewrite Rules
26091 @subsection Conditional Rewrite Rules
26093 @noindent
26094 A rewrite rule can also be @dfn{conditional}, written in the form
26095 @samp{@var{old} := @var{new} :: @var{cond}}.  (There is also the obsolete
26096 form @samp{[@var{old}, @var{new}, @var{cond}]}.)  If a @var{cond} part
26097 is present in the
26098 rule, this is an additional condition that must be satisfied before
26099 the rule is accepted.  Once @var{old} has been successfully matched
26100 to the target expression, @var{cond} is evaluated (with all the
26101 meta-variables substituted for the values they matched) and simplified
26102 with @kbd{a s} (@code{calc-simplify}).  If the result is a nonzero
26103 number or any other object known to be nonzero (@pxref{Declarations}),
26104 the rule is accepted.  If the result is zero or if it is a symbolic
26105 formula that is not known to be nonzero, the rule is rejected.
26106 @xref{Logical Operations}, for a number of functions that return
26107 1 or 0 according to the results of various tests.
26109 For example, the formula @samp{n > 0} simplifies to 1 or 0 if @expr{n}
26110 is replaced by a positive or nonpositive number, respectively (or if
26111 @expr{n} has been declared to be positive or nonpositive).  Thus,
26112 the 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)}
26114 (assuming no outstanding declarations for @expr{a}).  In the case of
26115 @samp{f(-3, 2)}, the condition can be shown not to be satisfied; in
26116 the case of @samp{f(12, a+1)}, the condition merely cannot be shown
26117 to be satisfied, but that is enough to reject the rule.
26119 While Calc will use declarations to reason about variables in the
26120 formula being rewritten, declarations do not apply to meta-variables.
26121 For example, the rule @samp{f(a) := g(a+1)} will match for any values
26122 of @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
26124 meta-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
26126 reals and formulas which are provably real, use @samp{dreal(a)} as
26127 the condition.
26129 The @samp{::} operator is a shorthand for the @code{condition}
26130 function; @samp{@var{old} := @var{new} :: @var{cond}} is equivalent to
26131 the formula @samp{condition(assign(@var{old}, @var{new}), @var{cond})}.
26133 If you have several conditions, you can use @samp{... :: c1 :: c2 :: c3}
26134 or @samp{... :: c1 && c2 && c3}.  The two are entirely equivalent.
26136 It 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
26138 convenience, though; where a condition appears in a rule has no
26139 effect on when it is tested.  The rewrite-rule compiler automatically
26140 decides when it is best to test each condition while a rule is being
26141 matched.
26143 Certain conditions are handled as special cases by the rewrite rule
26144 system and are tested very efficiently:  Where @expr{x} is any
26145 meta-variable, these conditions are @samp{integer(x)}, @samp{real(x)},
26146 @samp{constant(x)}, @samp{negative(x)}, @samp{x >= y} where @expr{y}
26147 is either a constant or another meta-variable and @samp{>=} may be
26148 replaced by any of the six relational operators, and @samp{x % a = b}
26149 where @expr{a} and @expr{b} are constants.  Other conditions, like
26150 @samp{x >= y+1} or @samp{dreal(x)}, will be less efficient to check
26151 since Calc must bring the whole evaluator and simplifier into play.
26153 An interesting property of @samp{::} is that neither of its arguments
26154 will be touched by Calc's default simplifications.  This is important
26155 because conditions often are expressions that cannot safely be
26156 evaluated early.  For example, the @code{typeof} function never
26157 remains in symbolic form; entering @samp{typeof(a)} will put the
26158 number 100 (the type code for variables like @samp{a}) on the stack.
26159 But putting the condition @samp{... :: typeof(a) = 6} on the stack
26160 is safe since @samp{::} prevents the @code{typeof} from being
26161 evaluated until the condition is actually used by the rewrite system.
26163 Since @samp{::} protects its lefthand side, too, you can use a dummy
26164 condition to protect a rule that must itself not evaluate early.
26165 For example, it's not safe to put @samp{a(f,x) := apply(f, [x])} on
26166 the stack because it will immediately evaluate to @samp{a(f,x) := f(x)},
26167 where the meta-variable-ness of @code{f} on the righthand side has been
26168 lost.  But @samp{a(f,x) := apply(f, [x]) :: 1} is safe, and of course
26169 the condition @samp{1} is always true (nonzero) so it has no effect on
26170 the functioning of the rule.  (The rewrite compiler will ensure that
26171 it doesn't even impact the speed of matching the rule.)
26173 @node Algebraic Properties of Rewrite Rules, Other Features of Rewrite Rules, Conditional Rewrite Rules, Rewrite Rules
26174 @subsection Algebraic Properties of Rewrite Rules
26176 @noindent
26177 The rewrite mechanism understands the algebraic properties of functions
26178 like @samp{+} and @samp{*}.  In particular, pattern matching takes
26179 the associativity and commutativity of the following functions into
26180 account:
26182 @smallexample
26183 + - *  = !=  && ||  and or xor  vint vunion vxor  gcd lcm  max min  beta
26184 @end smallexample
26186 For example, the rewrite rule:
26188 @example
26189 a x + b x  :=  (a + b) x
26190 @end example
26192 @noindent
26193 will match formulas of the form,
26195 @example
26196 a x + b x,  x a + x b,  a x + x b,  x a + b x
26197 @end example
26199 Rewrites also understand the relationship between the @samp{+} and @samp{-}
26200 operators.  The above rewrite rule will also match the formulas,
26202 @example
26203 a x - b x,  x a - x b,  a x - x b,  x a - b x
26204 @end example
26206 @noindent
26207 by matching @samp{b} in the pattern to @samp{-b} from the formula.
26209 Applied to a sum of many terms like @samp{r + a x + s + b x + t}, this
26210 pattern will check all pairs of terms for possible matches.  The rewrite
26211 will take whichever suitable pair it discovers first.
26213 In general, a pattern using an associative operator like @samp{a + b}
26214 will try @var{2 n} different ways to match a sum of @var{n} terms
26215 like @samp{x + y + z - w}.  First, @samp{a} is matched against each
26216 of @samp{x}, @samp{y}, @samp{z}, and @samp{-w} in turn, with @samp{b}
26217 being matched to the remainders @samp{y + z - w}, @samp{x + z - w}, etc.
26218 If none of these succeed, then @samp{b} is matched against each of the
26219 four terms with @samp{a} matching the remainder.  Half-and-half matches,
26220 like @samp{(x + y) + (z - w)}, are not tried.
26222 Note that @samp{*} is not commutative when applied to matrices, but
26223 rewrite rules pretend that it is.  If you type @kbd{m v} to enable
26224 Matrix mode (@pxref{Matrix Mode}), rewrite rules will match @samp{*}
26225 literally, ignoring its usual commutativity property.  (In the
26226 current implementation, the associativity also vanishes---it is as
26227 if the pattern had been enclosed in a @code{plain} marker; see below.)
26228 If you are applying rewrites to formulas with matrices, it's best to
26229 enable Matrix mode first to prevent algebraically incorrect rewrites
26230 from occurring.
26232 The pattern @samp{-x} will actually match any expression.  For example,
26233 the rule
26235 @example
26236 f(-x)  :=  -f(x)
26237 @end example
26239 @noindent
26240 will rewrite @samp{f(a)} to @samp{-f(-a)}.  To avoid this, either use
26241 a @code{plain} marker as described below, or add a @samp{negative(x)}
26242 condition.  The @code{negative} function is true if its argument
26243 ``looks'' negative, for example, because it is a negative number or
26244 because it is a formula like @samp{-x}.  The new rule using this
26245 condition is:
26247 @example
26248 f(x)  :=  -f(-x)  :: negative(x)    @r{or, equivalently,}
26249 f(-x)  :=  -f(x)  :: negative(-x)
26250 @end example
26252 In the same way, the pattern @samp{x - y} will match the sum @samp{a + b}
26253 by matching @samp{y} to @samp{-b}.
26255 The 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}
26257 will 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).
26260 Calc 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
26263 though conceivably these patterns could match with @samp{a = b = x}.
26264 Nor will @samp{f(a b)} match @samp{f(x / y)} if @samp{y} is not a
26265 constant, even though it could be considered to match with @samp{a = x}
26266 and @samp{b = 1/y}.  The reasons are partly for efficiency, and partly
26267 because while few mathematical operations are substantively different
26268 for addition and subtraction, often it is preferable to treat the cases
26269 of multiplication, division, and integer powers separately.
26271 Even more subtle is the rule set
26273 @example
26274 [ f(a) + f(b) := f(a + b),  -f(a) := f(-a) ]
26275 @end example
26277 @noindent
26278 attempting to match @samp{f(x) - f(y)}.  You might think that Calc
26279 will view this subtraction as @samp{f(x) + (-f(y))} and then apply
26280 the above two rules in turn, but actually this will not work because
26281 Calc only does this when considering rules for @samp{+} (like the
26282 first rule in this set).  So it will see first that @samp{f(x) + (-f(y))}
26283 does not match @samp{f(a) + f(b)} for any assignments of the
26284 meta-variables, and then it will see that @samp{f(x) - f(y)} does
26285 not match @samp{-f(a)} for any assignment of @samp{a}.  Because Calc
26286 tries 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)}
26288 rule will have to be added.
26290 Another thing patterns will @emph{not} do is break up complex numbers.
26291 The pattern @samp{myconj(a + @w{b i)} := a - b i} will work for formulas
26292 involving the special constant @samp{i} (such as @samp{3 - 4 i}), but
26293 it will not match actual complex numbers like @samp{(3, -4)}.  A version
26294 of the above rule for complex numbers would be
26296 @example
26297 myconj(a)  :=  re(a) - im(a) (0,1)  :: im(a) != 0
26298 @end example
26300 @noindent
26301 (Because the @code{re} and @code{im} functions understand the properties
26302 of 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
26304 without the @samp{im(a) != 0} condition, since if @samp{im(a) = 0} the
26305 righthand side of the rule will still give the correct answer for the
26306 conjugate of a real number.)
26308 It is also possible to specify optional arguments in patterns.  The rule
26310 @example
26311 opt(a) x + opt(b) (x^opt(c) + opt(d))  :=  f(a, b, c, d)
26312 @end example
26314 @noindent
26315 will match the formula
26317 @example
26318 5 (x^2 - 4) + 3 x
26319 @end example
26321 @noindent
26322 in a fairly straightforward manner, but it will also match reduced
26323 formulas like
26325 @example
26326 x + x^2,    2(x + 1) - x,    x + x
26327 @end example
26329 @noindent
26330 producing, respectively,
26332 @example
26333 f(1, 1, 2, 0),   f(-1, 2, 1, 1),   f(1, 1, 1, 0)
26334 @end example
26336 (The latter two formulas can be entered only if default simplifications
26337 have been turned off with @kbd{m O}.)
26339 The default value for a term of a sum is zero.  The default value
26340 for a part of a product, for a power, or for the denominator of a
26341 quotient, is one.  Also, @samp{-x} matches the pattern @samp{opt(a) b}
26342 with @samp{a = -1}.
26344 In particular, the distributive-law rule can be refined to
26346 @example
26347 opt(a) x + opt(b) x  :=  (a + b) x
26348 @end example
26350 @noindent
26351 so that it will convert, e.g., @samp{a x - x}, to @samp{(a - 1) x}.
26353 The pattern @samp{opt(a) + opt(b) x} matches almost any formulas which
26354 are linear in @samp{x}.  You can also use the @code{lin} and @code{islin}
26355 functions with rewrite conditions to test for this; @pxref{Logical
26356 Operations}.  These functions are not as convenient to use in rewrite
26357 rules, but they recognize more kinds of formulas as linear:
26358 @samp{x/z} is considered linear with @expr{b = 1/z} by @code{lin},
26359 but it will not match the above pattern because that pattern calls
26360 for a multiplication, not a division.
26362 As another example, the obvious rule to replace @samp{sin(x)^2 + cos(x)^2}
26363 by 1,
26365 @example
26366 sin(x)^2 + cos(x)^2  :=  1
26367 @end example
26369 @noindent
26370 misses many cases because the sine and cosine may both be multiplied by
26371 an equal factor.  Here's a more successful rule:
26373 @example
26374 opt(a) sin(x)^2 + opt(a) cos(x)^2  :=  a
26375 @end example
26377 Note that this rule will @emph{not} match @samp{sin(x)^2 + 6 cos(x)^2}
26378 because one @expr{a} would have ``matched'' 1 while the other matched 6.
26380 Calc automatically converts a rule like
26382 @example
26383 f(x-1, x)  :=  g(x)
26384 @end example
26386 @noindent
26387 into the form
26389 @example
26390 f(temp, x)  :=  g(x)  :: temp = x-1
26391 @end example
26393 @noindent
26394 (where @code{temp} stands for a new, invented meta-variable that
26395 doesn't actually have a name).  This modified rule will successfully
26396 match @samp{f(6, 7)}, binding @samp{temp} and @samp{x} to 6 and 7,
26397 respectively, then verifying that they differ by one even though
26398 @samp{6} does not superficially look like @samp{x-1}.
26400 However, Calc does not solve equations to interpret a rule.  The
26401 following rule,
26403 @example
26404 f(x-1, x+1)  :=  g(x)
26405 @end example
26407 @noindent
26408 will not work.  That is, it will match @samp{f(a - 1 + b, a + 1 + b)}
26409 but not @samp{f(6, 8)}.  Calc always interprets at least one occurrence
26410 of a variable by literal matching.  If the variable appears ``isolated''
26411 then Calc is smart enough to use it for literal matching.  But in this
26412 last 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
26414 actual ``something-minus-one'' in the target formula.
26416 A successful way to write this would be @samp{f(x, x+2) := g(x+1)}.
26417 You could make this resemble the original form more closely by using
26418 @code{let} notation, which is described in the next section:
26420 @example
26421 f(xm1, x+1)  :=  g(x)  :: let(x := xm1+1)
26422 @end example
26424 Calc does this rewriting or ``conditionalizing'' for any sub-pattern
26425 which involves only the functions in the following list, operating
26426 only on constants and meta-variables which have already been matched
26427 elsewhere in the pattern.  When matching a function call, Calc is
26428 careful to match arguments which are plain variables before arguments
26429 which 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}.
26433 @smallexample
26434 + - * / \ % ^  abs sign  round rounde roundu trunc floor ceil
26435 max min  re im conj arg
26436 @end smallexample
26438 You can suppress all of the special treatments described in this
26439 section by surrounding a function call with a @code{plain} marker.
26440 This marker causes the function call which is its argument to be
26441 matched literally, without regard to commutativity, associativity,
26442 negation, or conditionalization.  When you use @code{plain}, the
26443 ``deep structure'' of the formula being matched can show through.
26444 For example,
26446 @example
26447 plain(a - a b)  :=  f(a, b)
26448 @end example
26450 @noindent
26451 will match only literal subtractions.  However, the @code{plain}
26452 marker does not affect its arguments' arguments.  In this case,
26453 commutativity and associativity is still considered while matching
26454 the @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
26456 further and use
26458 @example
26459 plain(a - plain(a b))  :=  f(a, b)
26460 @end example
26462 @noindent
26463 which would do a completely strict match for the pattern.
26465 By contrast, the @code{quote} marker means that not only the
26466 function name but also the arguments must be literally the same.
26467 The above pattern will match @samp{x - x y} but
26469 @example
26470 quote(a - a b)  :=  f(a, b)
26471 @end example
26473 @noindent
26474 will match only the single formula @samp{a - a b}.  Also,
26476 @example
26477 quote(a - quote(a b))  :=  f(a, b)
26478 @end example
26480 @noindent
26481 will match only @samp{a - quote(a b)}---probably not the desired
26482 effect!
26484 A certain amount of algebra is also done when substituting the
26485 meta-variables on the righthand side of a rule.  For example,
26486 in the rule
26488 @example
26489 a + f(b)  :=  f(a + b)
26490 @end example
26492 @noindent
26493 matching @samp{f(x) - y} would produce @samp{f((-y) + x)} if
26494 taken literally, but the rewrite mechanism will simplify the
26495 righthand side to @samp{f(x - y)} automatically.  (Of course,
26496 the default simplifications would do this anyway, so this
26497 special simplification is only noticeable if you have turned the
26498 default simplifications off.)  This rewriting is done only when
26499 a meta-variable expands to a ``negative-looking'' expression.
26500 If this simplification is not desirable, you can use a @code{plain}
26501 marker on the righthand side:
26503 @example
26504 a + f(b)  :=  f(plain(a + b))
26505 @end example
26507 @noindent
26508 In this example, we are still allowing the pattern-matcher to
26509 use all the algebra it can muster, but the righthand side will
26510 always simplify to a literal addition like @samp{f((-y) + x)}.
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
26515 @noindent
26516 Certain ``function names'' serve as markers in rewrite rules.
26517 Here is a complete list of these markers.  First are listed the
26518 markers that work inside a pattern; then come the markers that
26519 work in the righthand side of a rule.
26521 @ignore
26522 @starindex
26523 @end ignore
26524 @tindex import
26525 One kind of marker, @samp{import(x)}, takes the place of a whole
26526 rule.  Here @expr{x} is the name of a variable containing another
26527 rule set; those rules are ``spliced into'' the rule set that
26528 imports them.  For example, if @samp{[f(a+b) := f(a) + f(b),
26529 f(a b) := a f(b) :: real(a)]} is stored in variable @samp{linearF},
26530 then the rule set @samp{[f(0) := 0, import(linearF)]} will apply
26531 all three rules.  It is possible to modify the imported rules
26532 slightly:  @samp{import(x, v1, x1, v2, x2, @dots{})} imports
26533 the rule set @expr{x} with all occurrences of 
26534 @texline @math{v_1},
26535 @infoline @expr{v1}, 
26536 as either a variable name or a function name, replaced with 
26537 @texline @math{x_1}
26538 @infoline @expr{x1} 
26539 and so on.  (If 
26540 @texline @math{v_1}
26541 @infoline @expr{v1} 
26542 is used as a function name, then 
26543 @texline @math{x_1}
26544 @infoline @expr{x1}
26545 must be either a function name itself or a @w{@samp{< >}} nameless
26546 function; @pxref{Specifying Operators}.)  For example, @samp{[g(0) := 0,
26547 import(linearF, f, g)]} applies the linearity rules to the function
26548 @samp{g} instead of @samp{f}.  Imports can be nested, but the
26549 import-with-renaming feature may fail to rename sub-imports properly.
26551 The special functions allowed in patterns are:
26553 @table @samp
26554 @item quote(x)
26555 @ignore
26556 @starindex
26557 @end ignore
26558 @tindex quote
26559 This pattern matches exactly @expr{x}; variable names in @expr{x} are
26560 not interpreted as meta-variables.  The only flexibility is that
26561 numbers 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:
26564 The rule @samp{f(x,x) := g(x)} will match @samp{f(12, 12.0)}.
26565 The rewrite may produce either @samp{g(12)} or @samp{g(12.0)}
26566 as a result in this case.)
26568 @item plain(x)
26569 @ignore
26570 @starindex
26571 @end ignore
26572 @tindex plain
26573 Here @expr{x} must be a function call @samp{f(x1,x2,@dots{})}.  This
26574 pattern matches a call to function @expr{f} with the specified
26575 argument patterns.  No special knowledge of the properties of the
26576 function @expr{f} is used in this case; @samp{+} is not commutative or
26577 associative.  Unlike @code{quote}, the arguments @samp{x1,x2,@dots{}}
26578 are treated as patterns.  If you wish them to be treated ``plainly''
26579 as well, you must enclose them with more @code{plain} markers:
26580 @samp{plain(plain(@w{-a}) + plain(b c))}.
26582 @item opt(x,def)
26583 @ignore
26584 @starindex
26585 @end ignore
26586 @tindex opt
26587 Here @expr{x} must be a variable name.  This must appear as an
26588 argument to a function or an element of a vector; it specifies that
26589 the argument or element is optional.
26590 As an argument to @samp{+}, @samp{-}, @samp{*}, @samp{&&}, or @samp{||},
26591 or as the second argument to @samp{/} or @samp{^}, the value @var{def}
26592 may be omitted.  The pattern @samp{x + opt(y)} matches a sum by
26593 binding one summand to @expr{x} and the other to @expr{y}, and it
26594 matches anything else by binding the whole expression to @expr{x} and
26595 zero to @expr{y}.  The other operators above work similarly.
26597 For general miscellaneous functions, the default value @code{def}
26598 must be specified.  Optional arguments are dropped starting with
26599 the 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)},
26601 or @samp{f(a,b,c)}.  Default values of zero and @expr{b} are
26602 supplied in this example for the omitted arguments.  Note that
26603 the literal variable @expr{b} will be the default in the latter
26604 case, @emph{not} the value that matched the meta-variable @expr{b}.
26605 In other words, the default @var{def} is effectively quoted.
26607 @item condition(x,c)
26608 @ignore
26609 @starindex
26610 @end ignore
26611 @tindex condition
26612 @tindex ::
26613 This matches the pattern @expr{x}, with the attached condition
26614 @expr{c}.  It is the same as @samp{x :: c}.
26616 @item pand(x,y)
26617 @ignore
26618 @starindex
26619 @end ignore
26620 @tindex pand
26621 @tindex &&&
26622 This matches anything that matches both pattern @expr{x} and
26623 pattern @expr{y}.  It is the same as @samp{x &&& y}.
26624 @pxref{Composing Patterns in Rewrite Rules}.
26626 @item por(x,y)
26627 @ignore
26628 @starindex
26629 @end ignore
26630 @tindex por
26631 @tindex |||
26632 This matches anything that matches either pattern @expr{x} or
26633 pattern @expr{y}.  It is the same as @w{@samp{x ||| y}}.
26635 @item pnot(x)
26636 @ignore
26637 @starindex
26638 @end ignore
26639 @tindex pnot
26640 @tindex !!!
26641 This matches anything that does not match pattern @expr{x}.
26642 It is the same as @samp{!!! x}.
26644 @item cons(h,t)
26645 @ignore
26646 @mindex cons
26647 @end ignore
26648 @tindex cons (rewrites)
26649 This matches any vector of one or more elements.  The first
26650 element is matched to @expr{h}; a vector of the remaining
26651 elements is matched to @expr{t}.  Note that vectors of fixed
26652 length can also be matched as actual vectors:  The rule
26653 @samp{cons(a,cons(b,[])) := cons(a+b,[])} is equivalent
26654 to the rule @samp{[a,b] := [a+b]}.
26656 @item rcons(t,h)
26657 @ignore
26658 @mindex rcons
26659 @end ignore
26660 @tindex rcons (rewrites)
26661 This is like @code{cons}, except that the @emph{last} element
26662 is matched to @expr{h}, with the remaining elements matched
26663 to @expr{t}.
26665 @item apply(f,args)
26666 @ignore
26667 @mindex apply
26668 @end ignore
26669 @tindex apply (rewrites)
26670 This matches any function call.  The name of the function, in
26671 the form of a variable, is matched to @expr{f}.  The arguments
26672 of the function, as a vector of zero or more objects, are
26673 matched to @samp{args}.  Constants, variables, and vectors
26674 do @emph{not} match an @code{apply} pattern.  For example,
26675 @samp{apply(f,x)} matches any function call, @samp{apply(quote(f),x)}
26676 matches any call to the function @samp{f}, @samp{apply(f,[a,b])}
26677 matches any function call with exactly two arguments, and
26678 @samp{apply(quote(f), cons(a,cons(b,x)))} matches any call
26679 to the function @samp{f} with two or more arguments.  Another
26680 way to implement the latter, if the rest of the rule does not
26681 need to refer to the first two arguments of @samp{f} by name,
26682 would be @samp{apply(quote(f), x :: vlen(x) >= 2)}.
26683 Here's a more interesting sample use of @code{apply}:
26685 @example
26686 apply(f,[x+n])  :=  n + apply(f,[x])
26687    :: in(f, [floor,ceil,round,trunc]) :: integer(n)
26688 @end example
26690 Note, however, that this will be slower to match than a rule
26691 set with four separate rules.  The reason is that Calc sorts
26692 the rules of a rule set according to top-level function name;
26693 if the top-level function is @code{apply}, Calc must try the
26694 rule for every single formula and sub-formula.  If the top-level
26695 function in the pattern is, say, @code{floor}, then Calc invokes
26696 the rule only for sub-formulas which are calls to @code{floor}.
26698 Formulas normally written with operators like @code{+} are still
26699 considered function calls:  @code{apply(f,x)} matches @samp{a+b}
26700 with @samp{f = add}, @samp{x = [a,b]}.
26702 You must use @code{apply} for meta-variables with function names
26703 on both sides of a rewrite rule:  @samp{apply(f, [x]) := f(x+1)}
26704 is @emph{not} correct, because it rewrites @samp{spam(6)} into
26705 @samp{f(7)}.  The righthand side should be @samp{apply(f, [x+1])}.
26706 Also note that you will have to use No-Simplify mode (@kbd{m O})
26707 when entering this rule so that the @code{apply} isn't
26708 evaluated immediately to get the new rule @samp{f(x) := f(x+1)}.
26709 Or, use @kbd{s e} to enter the rule without going through the stack,
26710 or enter the rule as @samp{apply(f, [x]) := apply(f, [x+1]) @w{:: 1}}.
26711 @xref{Conditional Rewrite Rules}.
26713 @item select(x)
26714 @ignore
26715 @starindex
26716 @end ignore
26717 @tindex select
26718 This is used for applying rules to formulas with selections;
26719 @pxref{Selections with Rewrite Rules}.
26720 @end table
26722 Special functions for the righthand sides of rules are:
26724 @table @samp
26725 @item quote(x)
26726 The notation @samp{quote(x)} is changed to @samp{x} when the
26727 righthand side is used.  As far as the rewrite rule is concerned,
26728 @code{quote} is invisible.  However, @code{quote} has the special
26729 property in Calc that its argument is not evaluated.  Thus,
26730 while it will not work to put the rule @samp{t(a) := typeof(a)}
26731 on the stack because @samp{typeof(a)} is evaluated immediately
26732 to produce @samp{t(a) := 100}, you can use @code{quote} to
26733 protect the righthand side:  @samp{t(a) := quote(typeof(a))}.
26734 (@xref{Conditional Rewrite Rules}, for another trick for
26735 protecting rules from evaluation.)
26737 @item plain(x)
26738 Special properties of and simplifications for the function call
26739 @expr{x} are not used.  One interesting case where @code{plain}
26740 is useful is the rule, @samp{q(x) := quote(x)}, trying to expand a
26741 shorthand notation for the @code{quote} function.  This rule will
26742 not work as shown; instead of replacing @samp{q(foo)} with
26743 @samp{quote(foo)}, it will replace it with @samp{foo}!  The correct
26744 rule would be @samp{q(x) := plain(quote(x))}.
26746 @item cons(h,t)
26747 Where @expr{t} is a vector, this is converted into an expanded
26748 vector during rewrite processing.  Note that @code{cons} is a regular
26749 Calc function which normally does this anyway; the only way @code{cons}
26750 is treated specially by rewrites is that @code{cons} on the righthand
26751 side of a rule will be evaluated even if default simplifications
26752 have been turned off.
26754 @item rcons(t,h)
26755 Analogous to @code{cons} except putting @expr{h} at the @emph{end} of
26756 the vector @expr{t}.
26758 @item apply(f,args)
26759 Where @expr{f} is a variable and @var{args} is a vector, this
26760 is converted to a function call.  Once again, note that @code{apply}
26761 is also a regular Calc function.
26763 @item eval(x)
26764 @ignore
26765 @starindex
26766 @end ignore
26767 @tindex eval
26768 The formula @expr{x} is handled in the usual way, then the
26769 default simplifications are applied to it even if they have
26770 been turned off normally.  This allows you to treat any function
26771 similarly to the way @code{cons} and @code{apply} are always
26772 treated.  However, there is a slight difference:  @samp{cons(2+3, [])}
26773 with default simplifications off will be converted to @samp{[2+3]},
26774 whereas @samp{eval(cons(2+3, []))} will be converted to @samp{[5]}.
26776 @item evalsimp(x)
26777 @ignore
26778 @starindex
26779 @end ignore
26780 @tindex evalsimp
26781 The formula @expr{x} has meta-variables substituted in the usual
26782 way, then algebraically simplified as if by the @kbd{a s} command.
26784 @item evalextsimp(x)
26785 @ignore
26786 @starindex
26787 @end ignore
26788 @tindex evalextsimp
26789 The formula @expr{x} has meta-variables substituted in the normal
26790 way, then ``extendedly'' simplified as if by the @kbd{a e} command.
26792 @item select(x)
26793 @xref{Selections with Rewrite Rules}.
26794 @end table
26796 There are also some special functions you can use in conditions.
26798 @table @samp
26799 @item let(v := x)
26800 @ignore
26801 @starindex
26802 @end ignore
26803 @tindex let
26804 The expression @expr{x} is evaluated with meta-variables substituted.
26805 The @kbd{a s} command's simplifications are @emph{not} applied by
26806 default, but @expr{x} can include calls to @code{evalsimp} or
26807 @code{evalextsimp} as described above to invoke higher levels
26808 of simplification.  The
26809 result of @expr{x} is then bound to the meta-variable @expr{v}.  As
26810 usual, if this meta-variable has already been matched to something
26811 else the two values must be equal; if the meta-variable is new then
26812 it is bound to the result of the expression.  This variable can then
26813 appear in later conditions, and on the righthand side of the rule.
26814 In fact, @expr{v} may be any pattern in which case the result of
26815 evaluating @expr{x} is matched to that pattern, binding any
26816 meta-variables that appear in that pattern.  Note that @code{let}
26817 can only appear by itself as a condition, or as one term of an
26818 @samp{&&} which is a whole condition:  It cannot be inside
26819 an @samp{||} term or otherwise buried.
26821 The alternate, equivalent form @samp{let(v, x)} is also recognized.
26822 Note that the use of @samp{:=} by @code{let}, while still being
26823 assignment-like in character, is unrelated to the use of @samp{:=}
26824 in the main part of a rewrite rule.
26826 As an example, @samp{f(a) := g(ia) :: let(ia := 1/a) :: constant(ia)}
26827 replaces @samp{f(a)} with @samp{g} of the inverse of @samp{a}, if
26828 that inverse exists and is constant.  For example, if @samp{a} is a
26829 singular matrix the operation @samp{1/a} is left unsimplified and
26830 @samp{constant(ia)} fails, but if @samp{a} is an invertible matrix
26831 then the rule succeeds.  Without @code{let} there would be no way
26832 to express this rule that didn't have to invert the matrix twice.
26833 Note that, because the meta-variable @samp{ia} is otherwise unbound
26834 in this rule, the @code{let} condition itself always ``succeeds''
26835 because no matter what @samp{1/a} evaluates to, it can successfully
26836 be bound to @code{ia}.
26838 Here's another example, for integrating cosines of linear
26839 terms:  @samp{myint(cos(y),x) := sin(y)/b :: let([a,b,x] := lin(y,x))}.
26840 The @code{lin} function returns a 3-vector if its argument is linear,
26841 or leaves itself unevaluated if not.  But an unevaluated @code{lin}
26842 call will not match the 3-vector on the lefthand side of the @code{let},
26843 so this @code{let} both verifies that @code{y} is linear, and binds
26844 the 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
26846 righthand side instead, but using @samp{sin(y)/b} avoids gratuitous
26847 rearrangement of the argument of the sine.)
26849 @ignore
26850 @starindex
26851 @end ignore
26852 @tindex ierf
26853 Similarly, here is a rule that implements an inverse-@code{erf}
26854 function.  It uses @code{root} to search for a solution.  If
26855 @code{root} succeeds, it will return a vector of two numbers
26856 where the first number is the desired solution.  If no solution
26857 is found, @code{root} remains in symbolic form.  So we use
26858 @code{let} to check that the result was indeed a vector.
26860 @example
26861 ierf(x)  :=  y  :: let([y,z] := root(erf(a) = x, a, .5))
26862 @end example
26864 @item matches(v,p)
26865 The meta-variable @var{v}, which must already have been matched
26866 to something elsewhere in the rule, is compared against pattern
26867 @var{p}.  Since @code{matches} is a standard Calc function, it
26868 can appear anywhere in a condition.  But if it appears alone or
26869 as a term of a top-level @samp{&&}, then you get the special
26870 extra feature that meta-variables which are bound to things
26871 inside @var{p} can be used elsewhere in the surrounding rewrite
26872 rule.
26874 The only real difference between @samp{let(p := v)} and
26875 @samp{matches(v, p)} is that the former evaluates @samp{v} using
26876 the default simplifications, while the latter does not.
26878 @item remember
26879 @vindex remember
26880 This is actually a variable, not a function.  If @code{remember}
26881 appears as a condition in a rule, then when that rule succeeds
26882 the original expression and rewritten expression are added to the
26883 front of the rule set that contained the rule.  If the rule set
26884 was not stored in a variable, @code{remember} is ignored.  The
26885 lefthand side is enclosed in @code{quote} in the added rule if it
26886 contains any variables.
26888 For example, the rule @samp{f(n) := n f(n-1) :: remember} applied
26889 to @samp{f(7)} will add the rule @samp{f(7) := 7 f(6)} to the front
26890 of the rule set.  The rule set @code{EvalRules} works slightly
26891 differently:  There, the evaluation of @samp{f(6)} will complete before
26892 the result is added to the rule set, in this case as @samp{f(7) := 5040}.
26893 Thus @code{remember} is most useful inside @code{EvalRules}.
26895 It 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
26898 the function equivalent of the @kbd{=} command); if the variable
26899 @code{eatfoo} ever contains 1, rules like @samp{foo(7) := 7} will
26900 be added to the rule set and will continue to operate even if
26901 @code{eatfoo} is later changed to 0.
26903 @item remember(c)
26904 @ignore
26905 @starindex
26906 @end ignore
26907 @tindex remember
26908 Remember the match as described above, but only if condition @expr{c}
26909 is true.  For example, @samp{remember(n % 4 = 0)} in the above factorial
26910 rule remembers only every fourth result.  Note that @samp{remember(1)}
26911 is equivalent to @samp{remember}, and @samp{remember(0)} has no effect.
26912 @end table
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
26917 @noindent
26918 There are three operators, @samp{&&&}, @samp{|||}, and @samp{!!!},
26919 that combine rewrite patterns to make larger patterns.  The
26920 combinations are ``and,'' ``or,'' and ``not,'' respectively, and
26921 these operators are the pattern equivalents of @samp{&&}, @samp{||}
26922 and @samp{!} (which operate on zero-or-nonzero logical values).
26924 Note that @samp{&&&}, @samp{|||}, and @samp{!!!} are left in symbolic
26925 form by all regular Calc features; they have special meaning only in
26926 the context of rewrite rule patterns.
26928 The pattern @samp{@var{p1} &&& @var{p2}} matches anything that
26929 matches both @var{p1} and @var{p2}.  One especially useful case is
26930 when one of @var{p1} or @var{p2} is a meta-variable.  For example,
26931 here is a rule that operates on error forms:
26933 @example
26934 f(x &&& a +/- b, x)  :=  g(x)
26935 @end example
26937 This does the same thing, but is arguably simpler than, the rule
26939 @example
26940 f(a +/- b, a +/- b)  :=  g(a +/- b)
26941 @end example
26943 @ignore
26944 @starindex
26945 @end ignore
26946 @tindex ends
26947 Here's another interesting example:
26949 @example
26950 ends(cons(a, x) &&& rcons(y, b))  :=  [a, b]
26951 @end example
26953 @noindent
26954 which effectively clips out the middle of a vector leaving just
26955 the first and last elements.  This rule will change a one-element
26956 vector @samp{[a]} to @samp{[a, a]}.  The similar rule
26958 @example
26959 ends(cons(a, rcons(y, b)))  :=  [a, b]
26960 @end example
26962 @noindent
26963 would do the same thing except that it would fail to match a
26964 one-element vector.
26966 @tex
26967 \bigskip
26968 @end tex
26970 The pattern @samp{@var{p1} ||| @var{p2}} matches anything that
26971 matches either @var{p1} or @var{p2}.  Calc first tries matching
26972 against @var{p1}; if that fails, it goes on to try @var{p2}.
26974 @ignore
26975 @starindex
26976 @end ignore
26977 @tindex curve
26978 A simple example of @samp{|||} is
26980 @example
26981 curve(inf ||| -inf)  :=  0
26982 @end example
26984 @noindent
26985 which converts both @samp{curve(inf)} and @samp{curve(-inf)} to zero.
26987 Here is a larger example:
26989 @example
26990 log(a, b) ||| (ln(a) :: let(b := e))  :=  mylog(a, b)
26991 @end example
26993 This matches both generalized and natural logarithms in a single rule.
26994 Note that the @samp{::} term must be enclosed in parentheses because
26995 that operator has lower precedence than @samp{|||} or @samp{:=}.
26997 (In practice this rule would probably include a third alternative,
26998 omitted here for brevity, to take care of @code{log10}.)
27000 While Calc generally treats interior conditions exactly the same as
27001 conditions on the outside of a rule, it does guarantee that if all the
27002 variables in the condition are special names like @code{e}, or already
27003 bound in the pattern to which the condition is attached (say, if
27004 @samp{a} had appeared in this condition), then Calc will process this
27005 condition right after matching the pattern to the left of the @samp{::}.
27006 Thus, we know that @samp{b} will be bound to @samp{e} only if the
27007 @code{ln} branch of the @samp{|||} was taken.
27009 Note that this rule was careful to bind the same set of meta-variables
27010 on both sides of the @samp{|||}.  Calc does not check this, but if
27011 you bind a certain meta-variable only in one branch and then use that
27012 meta-variable elsewhere in the rule, results are unpredictable:
27014 @example
27015 f(a,b) ||| g(b)  :=  h(a,b)
27016 @end example
27018 Here if the pattern matches @samp{g(17)}, Calc makes no promises about
27019 the value that will be substituted for @samp{a} on the righthand side.
27021 @tex
27022 \bigskip
27023 @end tex
27025 The pattern @samp{!!! @var{pat}} matches anything that does not
27026 match @var{pat}.  Any meta-variables that are bound while matching
27027 @var{pat} remain unbound outside of @var{pat}.
27029 For example,
27031 @example
27032 f(x &&& !!! a +/- b, !!![])  :=  g(x)
27033 @end example
27035 @noindent
27036 converts @code{f} whose first argument is anything @emph{except} an
27037 error form, and whose second argument is not the empty vector, into
27038 a similar call to @code{g} (but without the second argument).
27040 If we know that the second argument will be a vector (empty or not),
27041 then an equivalent rule would be:
27043 @example
27044 f(x, y)  :=  g(x)  :: typeof(x) != 7 :: vlen(y) > 0
27045 @end example
27047 @noindent
27048 where of course 7 is the @code{typeof} code for error forms.
27049 Another final condition, that works for any kind of @samp{y},
27050 would be @samp{!istrue(y == [])}.  (The @code{istrue} function
27051 returns an explicit 0 if its argument was left in symbolic form;
27052 plain @samp{!(y == [])} or @samp{y != []} would not work to replace
27053 @samp{!!![]} since these would be left unsimplified, and thus cause
27054 the rule to fail, if @samp{y} was something like a variable name.)
27056 It is possible for a @samp{!!!} to refer to meta-variables bound
27057 elsewhere in the pattern.  For example,
27059 @example
27060 f(a, !!!a)  :=  g(a)
27061 @end example
27063 @noindent
27064 matches any call to @code{f} with different arguments, changing
27065 this to @code{g} with only the first argument.
27067 If a function call is to be matched and one of the argument patterns
27068 contains a @samp{!!!} somewhere inside it, that argument will be
27069 matched last.  Thus
27071 @example
27072 f(!!!a, a)  :=  g(a)
27073 @end example
27075 @noindent
27076 will be careful to bind @samp{a} to the second argument of @code{f}
27077 before testing the first argument.  If Calc had tried to match the
27078 first argument of @code{f} first, the results would have been
27079 disastrous: since @code{a} was unbound so far, the pattern @samp{a}
27080 would have matched anything at all, and the pattern @samp{!!!a}
27081 therefore would @emph{not} have matched anything at all!
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
27086 @noindent
27087 When @kbd{a r} (@code{calc-rewrite}) is used, it takes an expression from
27088 the top of the stack and attempts to match any of the specified rules
27089 to any part of the expression, starting with the whole expression
27090 and then, if that fails, trying deeper and deeper sub-expressions.
27091 For each part of the expression, the rules are tried in the order
27092 they appear in the rules vector.  The first rule to match the first
27093 sub-expression wins; it replaces the matched sub-expression according
27094 to the @var{new} part of the rule.
27096 Often, the rule set will match and change the formula several times.
27097 The top-level formula is first matched and substituted repeatedly until
27098 it no longer matches the pattern; then, sub-formulas are tried, and
27099 so on.  Once every part of the formula has gotten its chance, the
27100 rewrite mechanism starts over again with the top-level formula
27101 (in case a substitution of one of its arguments has caused it again
27102 to match).  This continues until no further matches can be made
27103 anywhere in the formula.
27105 It is possible for a rule set to get into an infinite loop.  The
27106 most obvious case, replacing a formula with itself, is not a problem
27107 because a rule is not considered to ``succeed'' unless the righthand
27108 side actually comes out to something different than the original
27109 formula or sub-formula that was matched.  But if you accidentally
27110 had 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
27112 run forever switching a formula back and forth between the two
27113 forms.
27115 To avoid disaster, Calc normally stops after 100 changes have been
27116 made to the formula.  This will be enough for most multiple rewrites,
27117 but it will keep an endless loop of rewrites from locking up the
27118 computer forever.  (On most systems, you can also type @kbd{C-g} to
27119 halt any Emacs command prematurely.)
27121 To change this limit, give a positive numeric prefix argument.
27122 In particular, @kbd{M-1 a r} applies only one rewrite at a time,
27123 useful when you are first testing your rule (or just if repeated
27124 rewriting is not what is called for by your application).
27126 @ignore
27127 @starindex
27128 @end ignore
27129 @ignore
27130 @mindex iter@idots
27131 @end ignore
27132 @tindex iterations
27133 You can also put a ``function call'' @samp{iterations(@var{n})}
27134 in place of a rule anywhere in your rules vector (but usually at
27135 the top).  Then, @var{n} will be used instead of 100 as the default
27136 number of iterations for this rule set.  You can use
27137 @samp{iterations(inf)} if you want no iteration limit by default.
27138 A prefix argument will override the @code{iterations} limit in the
27139 rule set.
27141 @example
27142 [ iterations(1),
27143   f(x) := f(x+1) ]
27144 @end example
27146 More precisely, the limit controls the number of ``iterations,''
27147 where each iteration is a successful matching of a rule pattern whose
27148 righthand side, after substituting meta-variables and applying the
27149 default simplifications, is different from the original sub-formula
27150 that was matched.
27152 A prefix argument of zero sets the limit to infinity.  Use with caution!
27154 Given a negative numeric prefix argument, @kbd{a r} will match and
27155 substitute the top-level expression up to that many times, but
27156 will not attempt to match the rules to any sub-expressions.
27158 In a formula, @code{rewrite(@var{expr}, @var{rules}, @var{n})}
27159 does a rewriting operation.  Here @var{expr} is the expression
27160 being rewritten, @var{rules} is the rule, vector of rules, or
27161 variable containing the rules, and @var{n} is the optional
27162 iteration limit, which may be a positive integer, a negative
27163 integer, or @samp{inf} or @samp{-inf}.  If @var{n} is omitted
27164 the @code{iterations} value from the rule set is used; if both
27165 are omitted, 100 is used.
27167 @node Multi-Phase Rewrite Rules, Selections with Rewrite Rules, Nested Formulas with Rewrite Rules, Rewrite Rules
27168 @subsection Multi-Phase Rewrite Rules
27170 @noindent
27171 It is possible to separate a rewrite rule set into several @dfn{phases}.
27172 During each phase, certain rules will be enabled while certain others
27173 will be disabled.  A @dfn{phase schedule} controls the order in which
27174 phases occur during the rewriting process.
27176 @ignore
27177 @starindex
27178 @end ignore
27179 @tindex phase
27180 @vindex all
27181 If a call to the marker function @code{phase} appears in the rules
27182 vector in place of a rule, all rules following that point will be
27183 members of the phase(s) identified in the arguments to @code{phase}.
27184 Phases are given integer numbers.  The markers @samp{phase()} and
27185 @samp{phase(all)} both mean the following rules belong to all phases;
27186 this is the default at the start of the rule set.
27188 If you do not explicitly schedule the phases, Calc sorts all phase
27189 numbers that appear in the rule set and executes the phases in
27190 ascending order.  For example, the rule set
27192 @example
27193 @group
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) ]
27203 @end group
27204 @end example
27206 @noindent
27207 has 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}
27210 and @code{f3}.
27212 When Calc rewrites a formula using this rule set, it first rewrites
27213 the formula using only the phase 1 rules until no further changes are
27214 possible.  Then it switches to the phase 2 rule set and continues
27215 until no further changes occur, then finally rewrites with phase 3.
27216 When no more phase 3 rules apply, rewriting finishes.  (This is
27217 assuming @kbd{a r} with a large enough prefix argument to allow the
27218 rewriting to run to completion; the sequence just described stops
27219 early if the number of iterations specified in the prefix argument,
27220 100 by default, is reached.)
27222 During each phase, Calc descends through the nested levels of the
27223 formula as described previously.  (@xref{Nested Formulas with Rewrite
27224 Rules}.)  Rewriting starts at the top of the formula, then works its
27225 way down to the parts, then goes back to the top and works down again.
27226 The phase 2 rules do not begin until no phase 1 rules apply anywhere
27227 in the formula.
27229 @ignore
27230 @starindex
27231 @end ignore
27232 @tindex schedule
27233 A @code{schedule} marker appearing in the rule set (anywhere, but
27234 conventionally at the top) changes the default schedule of phases.
27235 In the simplest case, @code{schedule} has a sequence of phase numbers
27236 for arguments; each phase number is invoked in turn until the
27237 arguments to @code{schedule} are exhausted.  Thus adding
27238 @samp{schedule(3,2,1)} at the top of the above rule set would
27239 reverse the order of the phases; @samp{schedule(1,2,3)} would have
27240 no effect since this is the default schedule; and @samp{schedule(1,2,1,3)}
27241 would give phase 1 a second chance after phase 2 has completed, before
27242 moving on to phase 3.
27244 Any argument to @code{schedule} can instead be a vector of phase
27245 numbers (or even of sub-vectors).  Then the sub-sequence of phases
27246 described by the vector are tried repeatedly until no change occurs
27247 in any phase in the sequence.  For example, @samp{schedule([1, 2], 3)}
27248 tries phase 1, then phase 2, then, if either phase made any changes
27249 to the formula, repeats these two phases until they can make no
27250 further progress.  Finally, it goes on to phase 3 for finishing
27251 touches.
27253 Also, items in @code{schedule} can be variable names as well as
27254 numbers.  A variable name is interpreted as the name of a function
27255 to call on the whole formula.  For example, @samp{schedule(1, simplify)}
27256 says to apply the phase-1 rules (presumably, all of them), then to
27257 call @code{simplify} which is the function name equivalent of @kbd{a s}.
27258 Likewise, @samp{schedule([1, simplify])} says to alternate between
27259 phase 1 and @kbd{a s} until no further changes occur.
27261 Phases can be used purely to improve efficiency; if it is known that
27262 a certain group of rules will apply only at the beginning of rewriting,
27263 and a certain other group will apply only at the end, then rewriting
27264 will be faster if these groups are identified as separate phases.
27265 Once the phase 1 rules are done, Calc can put them aside and no longer
27266 spend any time on them while it works on phase 2.
27268 There are also some problems that can only be solved with several
27269 rewrite phases.  For a real-world example of a multi-phase rule set,
27270 examine the set @code{FitRules}, which is used by the curve-fitting
27271 command to convert a model expression to linear form.
27272 @xref{Curve Fitting Details}.  This set is divided into four phases.
27273 The first phase rewrites certain kinds of expressions to be more
27274 easily linearizable, but less computationally efficient.  After the
27275 linear components have been picked out, the final phase includes the
27276 opposite rewrites to put each component back into an efficient form.
27277 If both sets of rules were included in one big phase, Calc could get
27278 into an infinite loop going back and forth between the two forms.
27280 Elsewhere in @code{FitRules}, the components are first isolated,
27281 then recombined where possible to reduce the complexity of the linear
27282 fit, then finally packaged one component at a time into vectors.
27283 If the packaging rules were allowed to begin before the recombining
27284 rules were finished, some components might be put away into vectors
27285 before they had a chance to recombine.  By putting these rules in
27286 two separate phases, this problem is neatly avoided.
27288 @node Selections with Rewrite Rules, Matching Commands, Multi-Phase Rewrite Rules, Rewrite Rules
27289 @subsection Selections with Rewrite Rules
27291 @noindent
27292 If 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})
27294 command applies only to that sub-formula.  Together with a negative
27295 prefix argument, you can use this fact to apply a rewrite to one
27296 specific part of a formula without affecting any other parts.
27298 @kindex j r
27299 @pindex calc-rewrite-selection
27300 The @kbd{j r} (@code{calc-rewrite-selection}) command allows more
27301 sophisticated operations on selections.  This command prompts for
27302 the rules in the same way as @kbd{a r}, but it then applies those
27303 rules to the whole formula in question even though a sub-formula
27304 of it has been selected.  However, the selected sub-formula will
27305 first have been surrounded by a @samp{select( )} function call.
27306 (Calc's evaluator does not understand the function name @code{select};
27307 this is only a tag used by the @kbd{j r} command.)
27309 For example, suppose the formula on the stack is @samp{2 (a + b)^2}
27310 and the sub-formula @samp{a + b} is selected.  This formula will
27311 be rewritten to @samp{2 select(a + b)^2} and then the rewrite
27312 rules will be applied in the usual way.  The rewrite rules can
27313 include references to @code{select} to tell where in the pattern
27314 the selected sub-formula should appear.
27316 If there is still exactly one @samp{select( )} function call in
27317 the formula after rewriting is done, it indicates which part of
27318 the formula should be selected afterwards.  Otherwise, the
27319 formula will be unselected.
27321 You can make @kbd{j r} act much like @kbd{a r} by enclosing both parts
27322 of the rewrite rule with @samp{select()}.  However, @kbd{j r}
27323 allows you to use the current selection in more flexible ways.
27324 Suppose you wished to make a rule which removed the exponent from
27325 the selected term; the rule @samp{select(a)^x := select(a)} would
27326 work.  In the above example, it would rewrite @samp{2 select(a + b)^2}
27327 to @samp{2 select(a + b)}.  This would then be returned to the
27328 stack as @samp{2 (a + b)} with the @samp{a + b} selected.
27330 The @kbd{j r} command uses one iteration by default, unlike
27331 @kbd{a r} which defaults to 100 iterations.  A numeric prefix
27332 argument affects @kbd{j r} in the same way as @kbd{a r}.
27333 @xref{Nested Formulas with Rewrite Rules}.
27335 As with other selection commands, @kbd{j r} operates on the stack
27336 entry 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
27338 at stack level 1.)
27340 If you don't specify a set of rules, the rules are taken from the
27341 top of the stack, just as with @kbd{a r}.  In this case, the
27342 cursor must indicate stack entry 2 or above as the formula to be
27343 rewritten (otherwise the same formula would be used as both the
27344 target and the rewrite rules).
27346 If the indicated formula has no selection, the cursor position within
27347 the formula temporarily selects a sub-formula for the purposes of this
27348 command.  If the cursor is not on any sub-formula (e.g., it is in
27349 the line-number area to the left of the formula), the @samp{select( )}
27350 markers are ignored by the rewrite mechanism and the rules are allowed
27351 to apply anywhere in the formula.
27353 As a special feature, the normal @kbd{a r} command also ignores
27354 @samp{select( )} calls in rewrite rules.  For example, if you used the
27355 above rule @samp{select(a)^x := select(a)} with @kbd{a r}, it would apply
27356 the rule as if it were @samp{a^x := a}.  Thus, you can write general
27357 purpose rules with @samp{select( )} hints inside them so that they
27358 will ``do the right thing'' in both @kbd{a r} and @kbd{j r},
27359 both with and without selections.
27361 @node Matching Commands, Automatic Rewrites, Selections with Rewrite Rules, Rewrite Rules
27362 @subsection Matching Commands
27364 @noindent
27365 @kindex a m
27366 @pindex calc-match
27367 @tindex match
27368 The @kbd{a m} (@code{calc-match}) [@code{match}] function takes a
27369 vector of formulas and a rewrite-rule-style pattern, and produces
27370 a vector of all formulas which match the pattern.  The command
27371 prompts you to enter the pattern; as for @kbd{a r}, you can enter
27372 a single pattern (i.e., a formula with meta-variables), or a
27373 vector of patterns, or a variable which contains patterns, or
27374 you can give a blank response in which case the patterns are taken
27375 from the top of the stack.  The pattern set will be compiled once
27376 and saved if it is stored in a variable.  If there are several
27377 patterns in the set, vector elements are kept if they match any
27378 of the patterns.
27380 For example, @samp{match(a+b, [x, x+y, x-y, 7, x+y+z])}
27381 will return @samp{[x+y, x-y, x+y+z]}.
27383 The @code{import} mechanism is not available for pattern sets.
27385 The @kbd{a m} command can also be used to extract all vector elements
27386 which satisfy any condition:  The pattern @samp{x :: x>0} will select
27387 all the positive vector elements.
27389 @kindex I a m
27390 @tindex matchnot
27391 With the Inverse flag [@code{matchnot}], this command extracts all
27392 vector elements which do @emph{not} match the given pattern.
27394 @ignore
27395 @starindex
27396 @end ignore
27397 @tindex matches
27398 There is also a function @samp{matches(@var{x}, @var{p})} which
27399 evaluates to 1 if expression @var{x} matches pattern @var{p}, or
27400 to 0 otherwise.  This is sometimes useful for including into the
27401 conditional clauses of other rewrite rules.
27403 @ignore
27404 @starindex
27405 @end ignore
27406 @tindex vmatches
27407 The function @code{vmatches} is just like @code{matches}, except
27408 that if the match succeeds it returns a vector of assignments to
27409 the meta-variables instead of the number 1.  For example,
27410 @samp{vmatches(f(1,2), f(a,b))} returns @samp{[a := 1, b := 2]}.
27411 If the match fails, the function returns the number 0.
27413 @node Automatic Rewrites, Debugging Rewrites, Matching Commands, Rewrite Rules
27414 @subsection Automatic Rewrites
27416 @noindent
27417 @cindex @code{EvalRules} variable
27418 @vindex EvalRules
27419 It is possible to get Calc to apply a set of rewrite rules on all
27420 results, effectively adding to the built-in set of default
27421 simplifications.  To do this, simply store your rule set in the
27422 variable @code{EvalRules}.  There is a convenient @kbd{s E} command
27423 for editing @code{EvalRules}; @pxref{Operations on Variables}.
27425 For example, suppose you want @samp{sin(a + b)} to be expanded out
27426 to @samp{sin(b) cos(a) + cos(b) sin(a)} wherever it appears, and
27427 similarly for @samp{cos(a + b)}.  The corresponding rewrite rule
27428 set would be,
27430 @smallexample
27431 @group
27432 [ sin(a + b)  :=  cos(a) sin(b) + sin(a) cos(b),
27433   cos(a + b)  :=  cos(a) cos(b) - sin(a) sin(b) ]
27434 @end group
27435 @end smallexample
27437 To 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
27439 to expand trig functions.  But if instead you store them in the
27440 variable @code{EvalRules}, they will automatically be applied to all
27441 sines and cosines of sums.  Then, with @samp{2 x} and @samp{45} on
27442 the stack, typing @kbd{+ S} will (assuming Degrees mode) result in
27443 @samp{0.7071 sin(2 x) + 0.7071 cos(2 x)} automatically.
27445 As each level of a formula is evaluated, the rules from
27446 @code{EvalRules} are applied before the default simplifications.
27447 Rewriting continues until no further @code{EvalRules} apply.
27448 Note that this is different from the usual order of application of
27449 rewrite rules:  @code{EvalRules} works from the bottom up, simplifying
27450 the arguments to a function before the function itself, while @kbd{a r}
27451 applies rules from the top down.
27453 Because the @code{EvalRules} are tried first, you can use them to
27454 override the normal behavior of any built-in Calc function.
27456 It is important not to write a rule that will get into an infinite
27457 loop.  For example, the rule set @samp{[f(0) := 1, f(n) := n f(n-1)]}
27458 appears to be a good definition of a factorial function, but it is
27459 unsafe.  Imagine what happens if @samp{f(2.5)} is simplified.  Calc
27460 will continue to subtract 1 from this argument forever without reaching
27461 zero.  A safer second rule would be @samp{f(n) := n f(n-1) :: n>0}.
27462 Another 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}
27465 occurs, Emacs will eventually stop with a ``Computation got stuck
27466 or ran too long'' message.
27468 Another subtle difference between @code{EvalRules} and regular rewrites
27469 concerns rules that rewrite a formula into an identical formula.  For
27470 example, @samp{f(n) := f(floor(n))} ``fails to match'' when @expr{n} is
27471 already an integer.  But in @code{EvalRules} this case is detected only
27472 if the righthand side literally becomes the original formula before any
27473 further simplification.  This means that @samp{f(n) := f(floor(n))} will
27474 get into an infinite loop if it occurs in @code{EvalRules}.  Calc will
27475 replace @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
27477 continue simplifying that formula; first the argument is simplified
27478 to get @samp{f(6)}, then the rule matches again to get @samp{f(floor(6))}
27479 again, ad infinitum.  A much safer rule would check its argument first,
27480 say, with @samp{f(n) := f(floor(n)) :: !dint(n)}.
27482 (What really happens is that the rewrite mechanism substitutes the
27483 meta-variables in the righthand side of a rule, compares to see if the
27484 result is the same as the original formula and fails if so, then uses
27485 the default simplifications to simplify the result and compares again
27486 (and again fails if the formula has simplified back to its original
27487 form).  The only special wrinkle for the @code{EvalRules} is that the
27488 same rules will come back into play when the default simplifications
27489 are used.  What Calc wants to do is build @samp{f(floor(6))}, see that
27490 this is different from the original formula, simplify to @samp{f(6)},
27491 see that this is the same as the original formula, and thus halt the
27492 rewriting.  But while simplifying, @samp{f(6)} will again trigger
27493 the same @code{EvalRules} rule and Calc will get into a loop inside
27494 the rewrite mechanism itself.)
27496 The @code{phase}, @code{schedule}, and @code{iterations} markers do
27497 not work in @code{EvalRules}.  If the rule set is divided into phases,
27498 only the phase 1 rules are applied, and the schedule is ignored.
27499 The rules are always repeated as many times as possible.
27501 The @code{EvalRules} are applied to all function calls in a formula,
27502 but not to numbers (and other number-like objects like error forms),
27503 nor to vectors or individual variable names.  (Though they will apply
27504 to @emph{components} of vectors and error forms when appropriate.)  You
27505 might try to make a variable @code{phihat} which automatically expands
27506 to its definition without the need to press @kbd{=} by writing the
27507 rule @samp{quote(phihat) := (1-sqrt(5))/2}, but unfortunately this rule
27508 will not work as part of @code{EvalRules}.
27510 Finally, another limitation is that Calc sometimes calls its built-in
27511 functions directly rather than going through the default simplifications.
27512 When it does this, @code{EvalRules} will not be able to override those
27513 functions.  For example, when you take the absolute value of the complex
27514 number @expr{(2, 3)}, Calc computes @samp{sqrt(2*2 + 3*3)} by calling
27515 the multiplication, addition, and square root functions directly rather
27516 than applying the default simplifications to this formula.  So an
27517 @code{EvalRules} rule that (perversely) rewrites @samp{sqrt(13) := 6}
27518 would not apply.  (However, if you put Calc into Symbolic mode so that
27519 @samp{sqrt(13)} will be left in symbolic form by the built-in square
27520 root function, your rule will be able to apply.  But if the complex
27521 number were @expr{(3,4)}, so that @samp{sqrt(25)} must be calculated,
27522 then Symbolic mode will not help because @samp{sqrt(25)} can be
27523 evaluated exactly to 5.)
27525 One subtle restriction that normally only manifests itself with
27526 @code{EvalRules} is that while a given rewrite rule is in the process
27527 of being checked, that same rule cannot be recursively applied.  Calc
27528 effectively removes the rule from its rule set while checking the rule,
27529 then puts it back once the match succeeds or fails.  (The technical
27530 reason for this is that compiled pattern programs are not reentrant.)
27531 For example, consider the rule @samp{foo(x) := x :: foo(x/2) > 0}
27532 attempting to match @samp{foo(8)}.  This rule will be inactive while
27533 the condition @samp{foo(4) > 0} is checked, even though it might be
27534 an integral part of evaluating that condition.  Note that this is not
27535 a 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
27537 been reactivated by the time the righthand side is evaluated.
27539 If @code{EvalRules} has no stored value (its default state), or if
27540 anything but a vector is stored in it, then it is ignored.
27542 Even though Calc's rewrite mechanism is designed to compare rewrite
27543 rules to formulas as quickly as possible, storing rules in
27544 @code{EvalRules} may make Calc run substantially slower.  This is
27545 particularly true of rules where the top-level call is a commonly used
27546 function, or is not fixed.  The rule @samp{f(n) := n f(n-1) :: n>0} will
27547 only activate the rewrite mechanism for calls to the function @code{f},
27548 but @samp{lg(n) + lg(m) := lg(n m)} will check every @samp{+} operator.
27550 @smallexample
27551 apply(f, [a*b]) := apply(f, [a]) + apply(f, [b]) :: in(f, [ln, log10])
27552 @end smallexample
27554 @noindent
27555 may seem more ``efficient'' than two separate rules for @code{ln} and
27556 @code{log10}, but actually it is vastly less efficient because rules
27557 with @code{apply} as the top-level pattern must be tested against
27558 @emph{every} function call that is simplified.
27560 @cindex @code{AlgSimpRules} variable
27561 @vindex AlgSimpRules
27562 Suppose you want @samp{sin(a + b)} to be expanded out not all the time,
27563 but 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
27565 will apply @code{EvalRules} and @code{AlgSimpRules} to the formula, as
27566 well as all of its built-in simplifications.
27568 Most of the special limitations for @code{EvalRules} don't apply to
27569 @code{AlgSimpRules}.  Calc simply does an @kbd{a r AlgSimpRules}
27570 command with an infinite repeat count as the first step of @kbd{a s}.
27571 It then applies its own built-in simplifications throughout the
27572 formula, and then repeats these two steps (along with applying the
27573 default simplifications) until no further changes are possible.
27575 @cindex @code{ExtSimpRules} variable
27576 @cindex @code{UnitSimpRules} variable
27577 @vindex ExtSimpRules
27578 @vindex UnitSimpRules
27579 There are also @code{ExtSimpRules} and @code{UnitSimpRules} variables
27580 that are used by @kbd{a e} and @kbd{u s}, respectively; these commands
27581 also apply @code{EvalRules} and @code{AlgSimpRules}.  The variable
27582 @code{IntegSimpRules} contains simplification rules that are used
27583 only during integration by @kbd{a i}.
27585 @node Debugging Rewrites, Examples of Rewrite Rules, Automatic Rewrites, Rewrite Rules
27586 @subsection Debugging Rewrites
27588 @noindent
27589 If a buffer named @samp{*Trace*} exists, the rewrite mechanism will
27590 record some useful information there as it operates.  The original
27591 formula is written there, as is the result of each successful rewrite,
27592 and the final result of the rewriting.  All phase changes are also
27593 noted.
27595 Calc always appends to @samp{*Trace*}.  You must empty this buffer
27596 yourself periodically if it is in danger of growing unwieldy.
27598 Note that the rewriting mechanism is substantially slower when the
27599 @samp{*Trace*} buffer exists, even if the buffer is not visible on
27600 the screen.  Once you are done, you will probably want to kill this
27601 buffer (with @kbd{C-x k *Trace* @key{RET}}).  If you leave it in
27602 existence and forget about it, all your future rewrite commands will
27603 be needlessly slow.
27605 @node Examples of Rewrite Rules, , Debugging Rewrites, Rewrite Rules
27606 @subsection Examples of Rewrite Rules
27608 @noindent
27609 Returning 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
27612 finding suitable cases.  Another solution would be to use the rule
27613 @samp{cos(x)^2 := 1 - sin(x)^2}, followed by algebraic simplification
27614 if necessary.  This rule will be the most effective way to do the job,
27615 but at the expense of making some changes that you might not desire.
27617 Another algebraic rewrite rule is @samp{exp(x+y) := exp(x) exp(y)}.
27618 To make this work with the @w{@kbd{j r}} command so that it can be
27619 easily targeted to a particular exponential in a large formula,
27620 you might wish to write the rule as @samp{select(exp(x+y)) :=
27621 select(exp(x) exp(y))}.  The @samp{select} markers will be
27622 ignored by the regular @kbd{a r} command
27623 (@pxref{Selections with Rewrite Rules}).
27625 A surprisingly useful rewrite rule is @samp{a/(b-c) := a*(b+c)/(b^2-c^2)}.
27626 This will simplify the formula whenever @expr{b} and/or @expr{c} can
27627 be 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
27629 Symbolic mode has been enabled to keep the square root from being
27630 evaluated to a floating-point approximation).  This rule is also
27631 useful when working with symbolic complex numbers, e.g.,
27632 @samp{(a + b i) / (c + d i)}.
27634 As another example, we could define our own ``triangular numbers'' function
27635 with the rules @samp{[tri(0) := 0, tri(n) := n + tri(n-1) :: n>0]}.  Enter
27636 this vector and store it in a variable:  @kbd{@w{s t} trirules}.  Now, given
27637 a suitable formula like @samp{tri(5)} on the stack, type @samp{a r trirules}
27638 to apply these rules repeatedly.  After six applications, @kbd{a r} will
27639 stop with 15 on the stack.  Once these rules are debugged, it would probably
27640 be most useful to add them to @code{EvalRules} so that Calc will evaluate
27641 the new @code{tri} function automatically.  We could then use @kbd{Z K} on
27642 the keyboard macro @kbd{' tri($) @key{RET}} to make a command that applies
27643 @code{tri} to the value on the top of the stack.  @xref{Programming}.
27645 @cindex Quaternions
27646 The following rule set, contributed by 
27647 @texline Fran\c cois
27648 @infoline Francois
27649 Pinard, implements @dfn{quaternions}, a generalization of the concept of
27650 complex numbers.  Quaternions have four components, and are here
27651 represented by function calls @samp{quat(@var{w}, [@var{x}, @var{y},
27652 @var{z}])} with ``real part'' @var{w} and the three ``imaginary'' parts
27653 collected into a vector.  Various arithmetical operations on quaternions
27654 are supported.  To use these rules, either add them to @code{EvalRules},
27655 or create a command based on @kbd{a r} for simplifying quaternion
27656 formulas.  A convenient way to enter quaternions would be a command
27657 defined by a keyboard macro containing: @kbd{' quat($$$$, [$$$, $$, $])
27658 @key{RET}}.
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
27682 Quaternions, like matrices, have non-commutative multiplication.
27683 In 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}
27685 rule above uses @code{plain} to prevent Calc from rearranging the
27686 product.  It may also be wise to add the line @samp{[quat(), matrix]}
27687 to the @code{Decls} matrix, to ensure that Calc's other algebraic
27688 operations will not rearrange a quaternion product.  @xref{Declarations}.
27690 These rules also accept a four-argument @code{quat} form, converting
27691 it to the preferred form in the first rule.  If you would rather see
27692 results 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
27694 of the rule set.  (But remember that multi-phase rule sets don't work
27695 in @code{EvalRules}.)
27697 @node Units, Store and Recall, Algebra, Top
27698 @chapter Operating on Units
27700 @noindent
27701 One special interpretation of algebraic formulas is as numbers with units.
27702 For example, the formula @samp{5 m / s^2} can be read ``five meters
27703 per second squared.''  The commands in this chapter help you
27704 manipulate units expressions in this form.  Units-related commands
27705 begin with the @kbd{u} prefix key.
27707 @menu
27708 * Basic Operations on Units::
27709 * The Units Table::
27710 * Predefined Units::
27711 * User-Defined Units::
27712 @end menu
27714 @node Basic Operations on Units, The Units Table, Units, Units
27715 @section Basic Operations on Units
27717 @noindent
27718 A @dfn{units expression} is a formula which is basically a number
27719 multiplied and/or divided by one or more @dfn{unit names}, which may
27720 optionally be raised to integer powers.  Actually, the value part need not
27721 be a number; any product or quotient involving unit names is a units
27722 expression.  Many of the units commands will also accept any formula,
27723 where the command applies to all units expressions which appear in the
27724 formula.
27726 A unit name is a variable whose name appears in the @dfn{unit table},
27727 or a variable whose name is a prefix character like @samp{k} (for ``kilo'')
27728 or @samp{u} (for ``micro'') followed by a name in the unit table.
27729 A substantial table of built-in units is provided with Calc;
27730 @pxref{Predefined Units}.  You can also define your own unit names;
27731 @pxref{User-Defined Units}.
27733 Note that if the value part of a units expression is exactly @samp{1},
27734 it will be removed by the Calculator's automatic algebra routines:  The
27735 formula @samp{1 mm} is ``simplified'' to @samp{mm}.  This is only a
27736 display anomaly, however; @samp{mm} will work just fine as a
27737 representation of one millimeter.
27739 You may find that Algebraic mode (@pxref{Algebraic Entry}) makes working
27740 with units expressions easier.  Otherwise, you will have to remember
27741 to hit the apostrophe key every time you wish to enter units.
27743 @kindex u s
27744 @pindex calc-simplify-units
27745 @ignore
27746 @mindex usimpl@idots
27747 @end ignore
27748 @tindex usimplify
27749 The @kbd{u s} (@code{calc-simplify-units}) [@code{usimplify}] command
27750 simplifies a units
27751 expression.  It uses @kbd{a s} (@code{calc-simplify}) to simplify the
27752 expression first as a regular algebraic formula; it then looks for
27753 features that can be further simplified by converting one object's units
27754 to be compatible with another's.  For example, @samp{5 m + 23 mm} will
27755 simplify to @samp{5.023 m}.  When different but compatible units are
27756 added, the righthand term's units are converted to match those of the
27757 lefthand term.  @xref{Simplification Modes}, for a way to have this done
27758 automatically at all times.
27760 Units simplification also handles quotients of two units with the same
27761 dimensionality, as in @w{@samp{2 in s/L cm}} to @samp{5.08 s/L}; fractional
27762 powers 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}
27766 applied to units expressions, in which case
27767 the operation in question is applied only to the numeric part of the
27768 expression.  Finally, trigonometric functions of quantities with units
27769 of angle are evaluated, regardless of the current angular mode.
27771 @kindex u c
27772 @pindex calc-convert-units
27773 The @kbd{u c} (@code{calc-convert-units}) command converts a units
27774 expression to new, compatible units.  For example, given the units
27775 expression @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
27777 the original units, the number will be converted into your units
27778 times whatever ``remainder'' units are left over.  For example,
27779 converting @samp{55 mph} into acres produces @samp{6.08e-3 acre / m s}.
27780 (Recall that multiplication binds more strongly than division in Calc
27781 formulas, so the units here are acres per meter-second.)  Remainder
27782 units are expressed in terms of ``fundamental'' units like @samp{m} and
27783 @samp{s}, regardless of the input units.
27785 One special exception is that if you specify a single unit name, and
27786 a compatible unit appears somewhere in the units expression, then
27787 that compatible unit will be converted to the new unit and the
27788 remaining units in the expression will be left alone.  For example,
27789 given the input @samp{980 cm/s^2}, the command @kbd{u c ms} will
27790 change the @samp{s} to @samp{ms} to get @samp{9.8e-4 cm/ms^2}.
27791 The ``remainder unit'' @samp{cm} is left alone rather than being
27792 changed to the base unit @samp{m}.
27794 You can use explicit unit conversion instead of the @kbd{u s} command
27795 to gain more control over the units of the result of an expression.
27796 For 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
27799 in fathoms, if you preferred!)
27801 In place of a specific set of units, you can also enter one of the
27802 units system names @code{si}, @code{mks} (equivalent), or @code{cgs}.
27803 For example, @kbd{u c si @key{RET}} converts the expression into
27804 International System of Units (SI) base units.  Also, @kbd{u c base}
27805 converts to Calc's base units, which are the same as @code{si} units
27806 except that @code{base} uses @samp{g} as the fundamental unit of mass
27807 whereas @code{si} uses @samp{kg}.
27809 @cindex Composite units
27810 The @kbd{u c} command also accepts @dfn{composite units}, which
27811 are expressed as the sum of several compatible unit names.  For
27812 example, converting @samp{30.5 in} to units @samp{mi+ft+in} (miles,
27813 feet, and inches) produces @samp{2 ft + 6.5 in}.  Calc first
27814 sorts the unit names into order of decreasing relative size.
27815 It then accounts for as much of the input quantity as it can
27816 using an integer number times the largest unit, then moves on
27817 to the next smaller unit, and so on.  Only the smallest unit
27818 may have a non-integer amount attached in the result.  A few
27819 standard unit names exist for common combinations, such as
27820 @code{mfi} for @samp{mi+ft+in}, and @code{tpo} for @samp{ton+lb+oz}.
27821 Composite 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}.
27824 If the value on the stack does not contain any units, @kbd{u c} will
27825 prompt first for the old units which this value should be considered
27826 to have, then for the new units.  Assuming the old and new units you
27827 give are consistent with each other, the result also will not contain
27828 any units.  For example, @kbd{@w{u c} cm @key{RET} in @key{RET}} converts the number
27829 2 on the stack to 5.08.
27831 @kindex u b
27832 @pindex calc-base-units
27833 The @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
27835 stack into @code{base} units.  If @kbd{u s} does not simplify a
27836 units expression as far as you would like, try @kbd{u b}.
27838 The @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
27841 degrees Celsius corresponds to a change of 18 degrees Fahrenheit.
27843 @kindex u t
27844 @pindex calc-convert-temperature
27845 @cindex Temperature conversion
27846 The @kbd{u t} (@code{calc-convert-temperature}) command converts
27847 absolute temperatures.  The value on the stack must be a simple units
27848 expression with units of temperature only.  This command would convert
27849 @samp{10 degC} to @samp{50 degF}, the equivalent temperature on the
27850 Fahrenheit scale.
27852 @kindex u r
27853 @pindex calc-remove-units
27854 @kindex u x
27855 @pindex calc-extract-units
27856 The @kbd{u r} (@code{calc-remove-units}) command removes units from the
27857 formula at the top of the stack.  The @kbd{u x}
27858 (@code{calc-extract-units}) command extracts only the units portion of a
27859 formula.  These commands essentially replace every term of the formula
27860 that does or doesn't (respectively) look like a unit name by the
27861 constant 1, then resimplify the formula.
27863 @kindex u a
27864 @pindex calc-autorange-units
27865 The @kbd{u a} (@code{calc-autorange-units}) command turns on and off a
27866 mode in which unit prefixes like @code{k} (``kilo'') are automatically
27867 applied to keep the numeric part of a units expression in a reasonable
27868 range.  This mode affects @kbd{u s} and all units conversion commands
27869 except @kbd{u b}.  For example, with autoranging on, @samp{12345 Hz}
27870 will be simplified to @samp{12.345 kHz}.  Autoranging is useful for
27871 some kinds of units (like @code{Hz} and @code{m}), but is probably
27872 undesirable for non-metric units like @code{ft} and @code{tbsp}.
27873 (Composite units are more appropriate for those; see above.)
27875 Autoranging always applies the prefix to the leftmost unit name.
27876 Calc chooses the largest prefix that causes the number to be greater
27877 than or equal to 1.0.  Thus an increasing sequence of adjusted times
27878 would be @samp{1 ms, 10 ms, 100 ms, 1 s, 10 s, 100 s, 1 ks}.
27879 Generally the rule of thumb is that the number will be adjusted
27880 to be in the interval @samp{[1 .. 1000)}, although there are several
27881 exceptions to this rule.  First, if the unit has a power then this
27882 is not possible; @samp{0.1 s^2} simplifies to @samp{100000 ms^2}.
27883 Second, the ``centi-'' prefix is allowed to form @code{cm} (centimeters),
27884 but 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.
27887 Finally, a prefix will not be added to a unit if the resulting name
27888 is also the actual name of another unit; @samp{1e-15 t} would normally
27889 be 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.
27892 @node The Units Table, Predefined Units, Basic Operations on Units, Units
27893 @section The Units Table
27895 @noindent
27896 @kindex u v
27897 @pindex calc-enter-units-table
27898 The @kbd{u v} (@code{calc-enter-units-table}) command displays the units table
27899 in another buffer called @code{*Units Table*}.  Each entry in this table
27900 gives the unit name as it would appear in an expression, the definition
27901 of the unit in terms of simpler units, and a full name or description of
27902 the unit.  Fundamental units are defined as themselves; these are the
27903 units produced by the @kbd{u b} command.  The fundamental units are
27904 meters, seconds, grams, kelvins, amperes, candelas, moles, radians,
27905 and steradians.
27907 The Units Table buffer also displays the Unit Prefix Table.  Note that
27908 two prefixes, ``kilo'' and ``hecto,'' accept either upper- or lower-case
27909 prefix letters.  @samp{Meg} is also accepted as a synonym for the @samp{M}
27910 prefix.  Whenever a unit name can be interpreted as either a built-in name
27911 or a prefix followed by another built-in name, the former interpretation
27912 wins.  For example, @samp{2 pt} means two pints, not two pico-tons.
27914 The Units Table buffer, once created, is not rebuilt unless you define
27915 new units.  To force the buffer to be rebuilt, give any numeric prefix
27916 argument to @kbd{u v}.
27918 @kindex u V
27919 @pindex calc-view-units-table
27920 The @kbd{u V} (@code{calc-view-units-table}) command is like @kbd{u v} except
27921 that the cursor is not moved into the Units Table buffer.  You can
27922 type @kbd{u V} again to remove the Units Table from the display.  To
27923 return from the Units Table buffer after a @kbd{u v}, type @kbd{M-# c}
27924 again or use the regular Emacs @w{@kbd{C-x o}} (@code{other-window})
27925 command.  You can also kill the buffer with @kbd{C-x k} if you wish;
27926 the actual units table is safely stored inside the Calculator.
27928 @kindex u g
27929 @pindex calc-get-unit-definition
27930 The @kbd{u g} (@code{calc-get-unit-definition}) command retrieves a unit's
27931 defining 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
27933 same definition for the unit that would appear in the Units Table buffer.
27934 Note that this command works only for actual unit names; @kbd{u g km}
27935 will report that no such unit exists, for example, because @code{km} is
27936 really the unit @code{m} with a @code{k} (``kilo'') prefix.  To see a
27937 definition of a unit in terms of base units, it is easier to push the
27938 unit name on the stack and then reduce it to base units with @kbd{u b}.
27940 @kindex u e
27941 @pindex calc-explain-units
27942 The @kbd{u e} (@code{calc-explain-units}) command displays an English
27943 description of the units of the expression on the stack.  For example,
27944 for 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
27946 command uses the English descriptions that appear in the righthand
27947 column of the Units Table.
27949 @node Predefined Units, User-Defined Units, The Units Table, Units
27950 @section Predefined Units
27952 @noindent
27953 Since the exact definitions of many kinds of units have evolved over the
27954 years, and since certain countries sometimes have local differences in
27955 their definitions, it is a good idea to examine Calc's definition of a
27956 unit before depending on its exact value.  For example, there are three
27957 different units for gallons, corresponding to the US (@code{gal}),
27958 Canadian (@code{galC}), and British (@code{galUK}) definitions.  Also,
27959 note that @code{oz} is a standard ounce of mass, @code{ozt} is a Troy
27960 ounce, and @code{ozfl} is a fluid ounce.
27962 The temperature units corresponding to degrees Kelvin and Centigrade
27963 (Celsius) are the same in this table, since most units commands treat
27964 temperatures as being relative.  The @code{calc-convert-temperature}
27965 command has special rules for handling the different absolute magnitudes
27966 of the various temperature scales.
27968 The unit of volume ``liters'' can be referred to by either the lower-case
27969 @code{l} or the upper-case @code{L}.
27971 The unit @code{A} stands for Amperes; the name @code{Ang} is used
27972 @tex
27973 for \AA ngstroms.
27974 @end tex
27975 @ifinfo
27976 for Angstroms.
27977 @end ifinfo
27979 The unit @code{pt} stands for pints; the name @code{point} stands for
27980 a typographical point, defined by @samp{72 point = 1 in}.  There is
27981 also @code{tpt}, which stands for a printer's point as defined by the
27982 @TeX{} typesetting system:  @samp{72.27 tpt = 1 in}.
27984 The unit @code{e} stands for the elementary (electron) unit of charge;
27985 because algebra command could mistake this for the special constant
27986 @expr{e}, Calc provides the alternate unit name @code{ech} which is
27987 preferable to @code{e}.
27989 The name @code{g} stands for one gram of mass; there is also @code{gf},
27990 one gram of force.  (Likewise for @kbd{lb}, pounds, and @kbd{lbf}.)
27991 Meanwhile, one ``@expr{g}'' of acceleration is denoted @code{ga}.
27993 The unit @code{ton} is a U.S. ton of @samp{2000 lb}, and @code{t} is
27994 a metric ton of @samp{1000 kg}.
27996 The names @code{s} (or @code{sec}) and @code{min} refer to units of
27997 time; @code{arcsec} and @code{arcmin} are units of angle.
27999 Some ``units'' are really physical constants; for example, @code{c}
28000 represents the speed of light, and @code{h} represents Planck's
28001 constant.  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
28003 meters per second.  You can also use this merely as a handy reference;
28004 the @kbd{u g} command gets the definition of one of these constants
28005 in its normal terms, and @kbd{u b} expresses the definition in base
28006 units.
28008 Two units, @code{pi} and @code{fsc} (the fine structure constant,
28009 approximately @mathit{1/137}) are dimensionless.  The units simplification
28010 commands simply treat these names as equivalent to their corresponding
28011 values.  However you can, for example, use @kbd{u c} to convert a pure
28012 number into multiples of the fine structure constant, or @kbd{u b} to
28013 convert 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
28015 really is unitless.)
28017 @c Describe angular units, luminosity vs. steradians problem.
28019 @node User-Defined Units, , Predefined Units, Units
28020 @section User-Defined Units
28022 @noindent
28023 Calc provides ways to get quick access to your selected ``favorite''
28024 units, as well as ways to define your own new units.
28026 @kindex u 0-9
28027 @pindex calc-quick-units
28028 @vindex Units
28029 @cindex @code{Units} variable
28030 @cindex Quick units
28031 To select your favorite units, store a vector of unit names or
28032 expressions in the Calc variable @code{Units}.  The @kbd{u 1}
28033 through @kbd{u 9} commands (@code{calc-quick-units}) provide access
28034 to these units.  If the value on the top of the stack is a plain
28035 number (with no units attached), then @kbd{u 1} gives it the
28036 specified units.  (Basically, it multiplies the number by the
28037 first item in the @code{Units} vector.)  If the number on the
28038 stack @emph{does} have units, then @kbd{u 1} converts that number
28039 to the new units.  For example, suppose the vector @samp{[in, ft]}
28040 is stored in @code{Units}.  Then @kbd{30 u 1} will create the
28041 expression @samp{30 in}, and @kbd{u 2} will convert that expression
28042 to @samp{2.5 ft}.
28044 The @kbd{u 0} command accesses the tenth element of @code{Units}.
28045 Only ten quick units may be defined at a time.  If the @code{Units}
28046 variable has no stored value (the default), or if its value is not
28047 a vector, then the quick-units commands will not function.  The
28048 @kbd{s U} command is a convenient way to edit the @code{Units}
28049 variable; @pxref{Operations on Variables}.
28051 @kindex u d
28052 @pindex calc-define-unit
28053 @cindex User-defined units
28054 The @kbd{u d} (@code{calc-define-unit}) command records the units
28055 expression on the top of the stack as the definition for a new,
28056 user-defined unit.  For example, putting @samp{16.5 ft} on the stack and
28057 typing @kbd{u d rod} defines the new unit @samp{rod} to be equivalent to
28058 16.5 feet.  The unit conversion and simplification commands will now
28059 treat @code{rod} just like any other unit of length.  You will also be
28060 prompted for an optional English description of the unit, which will
28061 appear in the Units Table.
28063 @kindex u u
28064 @pindex calc-undefine-unit
28065 The @kbd{u u} (@code{calc-undefine-unit}) command removes a user-defined
28066 unit.  It is not possible to remove one of the predefined units,
28067 however.
28069 If you define a unit with an existing unit name, your new definition
28070 will replace the original definition of that unit.  If the unit was a
28071 predefined 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.
28075 To create a new fundamental unit, use either 1 or the unit name itself
28076 as the defining expression.  Otherwise the expression can involve any
28077 other units that you like (except for composite units like @samp{mfi}).
28078 You can create a new composite unit with a sum of other units as the
28079 defining expression.  The next unit operation like @kbd{u c} or @kbd{u v}
28080 will rebuild the internal unit table incorporating your modifications.
28081 Note that erroneous definitions (such as two units defined in terms of
28082 each 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.
28085 Temperature units are treated specially inside the Calculator; it is not
28086 possible to create user-defined temperature units.
28088 @kindex u p
28089 @pindex calc-permanent-units
28090 @cindex Calc init file, user-defined units
28091 The @kbd{u p} (@code{calc-permanent-units}) command stores the user-defined
28092 units in your Calc init file (the file given by the variable
28093 @code{calc-settings-file}, typically @file{~/.calc.el}), so that the
28094 units will still be available in subsequent Emacs sessions.  If there
28095 was already a set of user-defined units in your Calc init file, it
28096 is replaced by the new set.  (@xref{General Mode Commands}, for a way to
28097 tell Calc to use a different file for the Calc init file.)
28099 @node Store and Recall, Graphics, Units, Top
28100 @chapter Storing and Recalling
28102 @noindent
28103 Calculator variables are really just Lisp variables that contain numbers
28104 or formulas in a form that Calc can understand.  The commands in this
28105 section allow you to manipulate variables conveniently.  Commands related
28106 to variables use the @kbd{s} prefix key.
28108 @menu
28109 * Storing Variables::
28110 * Recalling Variables::
28111 * Operations on Variables::
28112 * Let Command::
28113 * Evaluates-To Operator::
28114 @end menu
28116 @node Storing Variables, Recalling Variables, Store and Recall, Store and Recall
28117 @section Storing Variables
28119 @noindent
28120 @kindex s s
28121 @pindex calc-store
28122 @cindex Storing variables
28123 @cindex Quick variables
28124 @vindex q0
28125 @vindex q9
28126 The @kbd{s s} (@code{calc-store}) command stores the value at the top of
28127 the stack into a specified variable.  It prompts you to enter the
28128 name of the variable.  If you press a single digit, the value is stored
28129 immediately in one of the ``quick'' variables @code{q0} through
28130 @code{q9}.  Or you can enter any variable name.  
28132 @kindex s t
28133 @pindex calc-store-into
28134 The @kbd{s s} command leaves the stored value on the stack.  There is
28135 also an @kbd{s t} (@code{calc-store-into}) command, which removes a
28136 value from the stack and stores it in a variable.
28138 If 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
28140 assign 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
28142 value 7 would be stored in the variable @samp{a}.  (If you do type
28143 a variable name at the prompt, the top-of-stack value is stored in
28144 its entirety, even if it is an equation:  @samp{s s b @key{RET}}
28145 with @samp{a := 7} on the stack stores @samp{a := 7} in @code{b}.)
28147 In fact, the top of stack value can be a vector of equations or
28148 assignments with different variables on their lefthand sides; the
28149 default will be to store all the variables with their corresponding
28150 righthand sides simultaneously.
28152 It is also possible to type an equation or assignment directly at
28153 the prompt for the @kbd{s s} or @kbd{s t} command:  @kbd{s s foo = 7}.
28154 In this case the expression to the right of the @kbd{=} or @kbd{:=}
28155 symbol is evaluated as if by the @kbd{=} command, and that value is
28156 stored in the variable.  No value is taken from the stack; @kbd{s s}
28157 and @kbd{s t} are equivalent when used in this way.
28159 @kindex s 0-9
28160 @kindex t 0-9
28161 The prefix keys @kbd{s} and @kbd{t} may be followed immediately by a
28162 digit; @kbd{s 9} is equivalent to @kbd{s s 9}, and @kbd{t 9} is
28163 equivalent to @kbd{s t 9}.  (The @kbd{t} prefix is otherwise used
28164 for trail and time/date commands.)
28166 @kindex s +
28167 @kindex s -
28168 @ignore
28169 @mindex @idots
28170 @end ignore
28171 @kindex s *
28172 @ignore
28173 @mindex @null
28174 @end ignore
28175 @kindex s /
28176 @ignore
28177 @mindex @null
28178 @end ignore
28179 @kindex s ^
28180 @ignore
28181 @mindex @null
28182 @end ignore
28183 @kindex s |
28184 @ignore
28185 @mindex @null
28186 @end ignore
28187 @kindex s n
28188 @ignore
28189 @mindex @null
28190 @end ignore
28191 @kindex s &
28192 @ignore
28193 @mindex @null
28194 @end ignore
28195 @kindex s [
28196 @ignore
28197 @mindex @null
28198 @end ignore
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
28210 There are also several ``arithmetic store'' commands.  For example,
28211 @kbd{s +} removes a value from the stack and adds it to the specified
28212 variable.  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 [}}
28215 and @kbd{s ]} which decrease or increase a variable by one.
28217 All the arithmetic stores accept the Inverse prefix to reverse the
28218 order of the operands.  If @expr{v} represents the contents of the
28219 variable, and @expr{a} is the value drawn from the stack, then regular
28220 @w{@kbd{s -}} assigns 
28221 @texline @math{v \coloneq v - a},
28222 @infoline @expr{v := v - a}, 
28223 but @kbd{I s -} assigns
28224 @texline @math{v \coloneq a - v}.
28225 @infoline @expr{v := a - v}.  
28226 While @kbd{I s *} might seem pointless, it is
28227 useful if matrix multiplication is involved.  Actually, all the
28228 arithmetic stores use formulas designed to behave usefully both
28229 forwards and backwards:
28231 @example
28232 @group
28233 s +        v := v + a          v := a + v
28234 s -        v := v - a          v := a - v
28235 s *        v := v * a          v := a * v
28236 s /        v := v / a          v := a / v
28237 s ^        v := v ^ a          v := a ^ v
28238 s |        v := v | a          v := a | v
28239 s n        v := v / (-1)       v := (-1) / v
28240 s &        v := v ^ (-1)       v := (-1) ^ v
28241 s [        v := v - 1          v := 1 - v
28242 s ]        v := v - (-1)       v := (-1) - v
28243 @end group
28244 @end example
28246 In the last four cases, a numeric prefix argument will be used in
28247 place of the number one.  (For example, @kbd{M-2 s ]} increases
28248 a variable by 2, and @kbd{M-2 I s ]} replaces a variable by
28249 minus-two minus the variable.
28251 The first six arithmetic stores can also be typed @kbd{s t +}, @kbd{s t -},
28252 etc.  The commands @kbd{s s +}, @kbd{s s -}, and so on are analogous
28253 arithmetic stores that don't remove the value @expr{a} from the stack.
28255 All arithmetic stores report the new value of the variable in the
28256 Trail for your information.  They signal an error if the variable
28257 previously had no stored value.  If default simplifications have been
28258 turned off, the arithmetic stores temporarily turn them on for numeric
28259 arguments only (i.e., they temporarily do an @kbd{m N} command).
28260 @xref{Simplification Modes}.  Large vectors put in the trail by
28261 these commands always use abbreviated (@kbd{t .}) mode.
28263 @kindex s m
28264 @pindex calc-store-map
28265 The @kbd{s m} command is a general way to adjust a variable's value
28266 using any Calc function.  It is a ``mapping'' command analogous to
28267 @kbd{V M}, @kbd{V R}, etc.  @xref{Reducing and Mapping}, to see
28268 how to specify a function for a mapping command.  Basically,
28269 all you do is type the Calc command key that would invoke that
28270 function normally.  For example, @kbd{s m n} applies the @kbd{n}
28271 key to negate the contents of the variable, so @kbd{s m n} is
28272 equivalent to @kbd{s n}.  Also, @kbd{s m Q} takes the square root
28273 of the value stored in a variable, @kbd{s m v v} uses @kbd{v v} to
28274 reverse the vector stored in the variable, and @kbd{s m H I S}
28275 takes the hyperbolic arcsine of the variable contents.
28277 If the mapping function takes two or more arguments, the additional
28278 arguments are taken from the stack; the old value of the variable
28279 is provided as the first argument.  Thus @kbd{s m -} with @expr{a}
28280 on the stack computes @expr{v - a}, just like @kbd{s -}.  With the
28281 Inverse prefix, the variable's original value becomes the @emph{last}
28282 argument instead of the first.  Thus @kbd{I s m -} is also
28283 equivalent to @kbd{I s -}.
28285 @kindex s x
28286 @pindex calc-store-exchange
28287 The @kbd{s x} (@code{calc-store-exchange}) command exchanges the value
28288 of a variable with the value on the top of the stack.  Naturally, the
28289 variable must already have a stored value for this to work.
28291 You can type an equation or assignment at the @kbd{s x} prompt.  The
28292 command @kbd{s x a=6} takes no values from the stack; instead, it
28293 pushes the old value of @samp{a} on the stack and stores @samp{a = 6}.
28295 @kindex s u
28296 @pindex calc-unstore
28297 @cindex Void variables
28298 @cindex Un-storing variables
28299 Until you store something in them, most variables are ``void,'' that is,
28300 they contain no value at all.  If they appear in an algebraic formula
28301 they will be left alone even if you press @kbd{=} (@code{calc-evaluate}).
28302 The @kbd{s u} (@code{calc-unstore}) command returns a variable to the
28303 void state.
28305 @kindex s c
28306 @pindex calc-copy-variable
28307 The @kbd{s c} (@code{calc-copy-variable}) command copies the stored
28308 value 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
28310 that the value never goes on the stack and thus is never rounded,
28311 evaluated, or simplified in any way; it is not even rounded down to the
28312 current precision.
28314 The only variables with predefined values are the ``special constants''
28315 @code{pi}, @code{e}, @code{i}, @code{phi}, and @code{gamma}.  You are free
28316 to unstore these variables or to store new values into them if you like,
28317 although some of the algebraic-manipulation functions may assume these
28318 variables represent their standard values.  Calc displays a warning if
28319 you change the value of one of these variables, or of one of the other
28320 special variables @code{inf}, @code{uinf}, and @code{nan} (which are
28321 normally void).
28323 Note that @code{pi} doesn't actually have 3.14159265359 stored in it,
28324 but rather a special magic value that evaluates to @cpi{} at the current
28325 precision.  Likewise @code{e}, @code{i}, and @code{phi} evaluate
28326 according to the current precision or polar mode.  If you recall a value
28327 from @code{pi} and store it back, this magic property will be lost.  The
28328 magic property is preserved, however, when a variable is copied with
28329 @kbd{s c}.
28331 @kindex s k
28332 @pindex calc-copy-special-constant
28333 If one of the ``special constants'' is redefined (or undefined) so that
28334 it 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
28336 for a special constant and a variable to store it in, and so a special
28337 constant can be stored in any variable.  Here, the special constant that
28338 you enter doesn't depend on the value of the corresponding variable;
28339 @code{pi} will represent 3.14159@dots{} regardless of what is currently
28340 stored in the Calc variable @code{pi}.  If one of the other special
28341 variables, @code{inf}, @code{uinf} or @code{nan}, is given a value, its
28342 original behavior can be restored by voiding it with @kbd{s u}.
28344 @node Recalling Variables, Operations on Variables, Storing Variables, Store and Recall
28345 @section Recalling Variables
28347 @noindent
28348 @kindex s r
28349 @pindex calc-recall
28350 @cindex Recalling variables
28351 The most straightforward way to extract the stored value from a variable
28352 is to use the @kbd{s r} (@code{calc-recall}) command.  This command prompts
28353 for a variable name (similarly to @code{calc-store}), looks up the value
28354 of the specified variable, and pushes that value onto the stack.  It is
28355 an error to try to recall a void variable.
28357 It is also possible to recall the value from a variable by evaluating a
28358 formula containing that variable.  For example, @kbd{' a @key{RET} =} is
28359 the same as @kbd{s r a @key{RET}} except that if the variable is void, the
28360 former will simply leave the formula @samp{a} on the stack whereas the
28361 latter will produce an error message.
28363 @kindex r 0-9
28364 The @kbd{r} prefix may be followed by a digit, so that @kbd{r 9} is
28365 equivalent to @kbd{s r 9}.  (The @kbd{r} prefix is otherwise unused
28366 in the current version of Calc.)
28368 @node Operations on Variables, Let Command, Recalling Variables, Store and Recall
28369 @section Other Operations on Variables
28371 @noindent
28372 @kindex s e
28373 @pindex calc-edit-variable
28374 The @kbd{s e} (@code{calc-edit-variable}) command edits the stored
28375 value of a variable without ever putting that value on the stack
28376 or simplifying or evaluating the value.  It prompts for the name of
28377 the variable to edit.  If the variable has no stored value, the
28378 editing buffer will start out empty.  If the editing buffer is
28379 empty when you press @kbd{C-c C-c} to finish, the variable will
28380 be made void.  @xref{Editing Stack Entries}, for a general
28381 description of editing.
28383 The @kbd{s e} command is especially useful for creating and editing
28384 rewrite rules which are stored in variables.  Sometimes these rules
28385 contain formulas which must not be evaluated until the rules are
28386 actually used.  (For example, they may refer to @samp{deriv(x,y)},
28387 where @code{x} will someday become some expression involving @code{y};
28388 if you let Calc evaluate the rule while you are defining it, Calc will
28389 replace @samp{deriv(x,y)} with 0 because the formula @code{x} does
28390 not itself refer to @code{y}.)  By contrast, recalling the variable,
28391 editing with @kbd{`}, and storing will evaluate the variable's value
28392 as a side effect of putting the value on the stack.
28394 @kindex s A
28395 @kindex s D
28396 @ignore
28397 @mindex @idots
28398 @end ignore
28399 @kindex s E
28400 @ignore
28401 @mindex @null
28402 @end ignore
28403 @kindex s F
28404 @ignore
28405 @mindex @null
28406 @end ignore
28407 @kindex s G
28408 @ignore
28409 @mindex @null
28410 @end ignore
28411 @kindex s H
28412 @ignore
28413 @mindex @null
28414 @end ignore
28415 @kindex s I
28416 @ignore
28417 @mindex @null
28418 @end ignore
28419 @kindex s L
28420 @ignore
28421 @mindex @null
28422 @end ignore
28423 @kindex s P
28424 @ignore
28425 @mindex @null
28426 @end ignore
28427 @kindex s R
28428 @ignore
28429 @mindex @null
28430 @end ignore
28431 @kindex s T
28432 @ignore
28433 @mindex @null
28434 @end ignore
28435 @kindex s U
28436 @ignore
28437 @mindex @null
28438 @end ignore
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
28453 There are several special-purpose variable-editing commands that
28454 use the @kbd{s} prefix followed by a shifted letter:
28456 @table @kbd
28457 @item s A
28458 Edit @code{AlgSimpRules}.  @xref{Algebraic Simplifications}.
28459 @item s D
28460 Edit @code{Decls}.  @xref{Declarations}.
28461 @item s E
28462 Edit @code{EvalRules}.  @xref{Default Simplifications}.
28463 @item s F
28464 Edit @code{FitRules}.  @xref{Curve Fitting}.
28465 @item s G
28466 Edit @code{GenCount}.  @xref{Solving Equations}.
28467 @item s H
28468 Edit @code{Holidays}.  @xref{Business Days}.
28469 @item s I
28470 Edit @code{IntegLimit}.  @xref{Calculus}.
28471 @item s L
28472 Edit @code{LineStyles}.  @xref{Graphics}.
28473 @item s P
28474 Edit @code{PointStyles}.  @xref{Graphics}.
28475 @item s R
28476 Edit @code{PlotRejects}.  @xref{Graphics}.
28477 @item s T
28478 Edit @code{TimeZone}.  @xref{Time Zones}.
28479 @item s U
28480 Edit @code{Units}.  @xref{User-Defined Units}.
28481 @item s X
28482 Edit @code{ExtSimpRules}.  @xref{Unsafe Simplifications}.
28483 @end table
28485 These commands are just versions of @kbd{s e} that use fixed variable
28486 names rather than prompting for the variable name.
28488 @kindex s p
28489 @pindex calc-permanent-variable
28490 @cindex Storing variables
28491 @cindex Permanent variables
28492 @cindex Calc init file, variables
28493 The @kbd{s p} (@code{calc-permanent-variable}) command saves a
28494 variable's value permanently in your Calc init file (the file given by
28495 the variable @code{calc-settings-file}, typically @file{~/.calc.el}), so
28496 that its value will still be available in future Emacs sessions.  You
28497 can re-execute @w{@kbd{s p}} later on to update the saved value, but the
28498 only way to remove a saved variable is to edit your calc init file
28499 by hand.  (@xref{General Mode Commands}, for a way to tell Calc to
28500 use a different file for the Calc init file.)
28502 If you do not specify the name of a variable to save (i.e.,
28503 @kbd{s p @key{RET}}), all Calc variables with defined values
28504 are saved except for the special constants @code{pi}, @code{e},
28505 @code{i}, @code{phi}, and @code{gamma}; the variables @code{TimeZone}
28506 and @code{PlotRejects};
28507 @code{FitRules}, @code{DistribRules}, and other built-in rewrite
28508 rules; and @code{PlotData@var{n}} variables generated
28509 by the graphics commands.  (You can still save these variables by
28510 explicitly naming them in an @kbd{s p} command.)
28512 @kindex s i
28513 @pindex calc-insert-variables
28514 The @kbd{s i} (@code{calc-insert-variables}) command writes
28515 the values of all Calc variables into a specified buffer.
28516 The variables are written with the prefix @code{var-} in the form of
28517 Lisp @code{setq} commands 
28518 which store the values in string form.  You can place these commands
28519 in your Calc init file (or @file{.emacs}) if you wish, though in this case it
28520 would be easier to use @kbd{s p @key{RET}}.  (Note that @kbd{s i}
28521 omits the same set of variables as @w{@kbd{s p @key{RET}}}; the difference
28522 is that @kbd{s i} will store the variables in any buffer, and it also
28523 stores in a more human-readable format.)
28525 @node Let Command, Evaluates-To Operator, Operations on Variables, Store and Recall
28526 @section The Let Command
28528 @noindent
28529 @kindex s l
28530 @pindex calc-let
28531 @cindex Variables, temporary assignment
28532 @cindex Temporary assignment to variables
28533 If you have an expression like @samp{a+b^2} on the stack and you wish to
28534 compute its value where @expr{b=3}, you can simply store 3 in @expr{b} and
28535 then press @kbd{=} to reevaluate the formula.  This has the side-effect
28536 of leaving the stored value of 3 in @expr{b} for future operations.
28538 The @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
28540 top of the stack into the specified variable, then evaluates the
28541 second-to-top stack entry, then restores the original value (or lack of one)
28542 in the variable.  Thus after @kbd{'@w{ }a+b^2 @key{RET} 3 s l b @key{RET}},
28543 the 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.
28545 The variables @samp{a} and @samp{b} are not permanently affected in any way
28546 by these commands.
28548 The value on the top of the stack may be an equation or assignment, or
28549 a vector of equations or assignments, in which case the default will be
28550 analogous to the case of @kbd{s t @key{RET}}.  @xref{Storing Variables}.
28552 Also, you can answer the variable-name prompt with an equation or
28553 assignment:  @kbd{s l b=3 @key{RET}} is the same as storing 3 on the stack
28554 and typing @kbd{s l b @key{RET}}.
28556 The @kbd{a b} (@code{calc-substitute}) command is another way to substitute
28557 a variable with a value in a formula.  It does an actual substitution
28558 rather than temporarily assigning the variable and evaluating.  For
28559 example, letting @expr{n=2} in @samp{f(n pi)} with @kbd{a b} will
28560 produce @samp{f(2 pi)}, whereas @kbd{s l} would give @samp{f(6.28)}
28561 since the evaluation step will also evaluate @code{pi}.
28563 @node Evaluates-To Operator, , Let Command, Store and Recall
28564 @section The Evaluates-To Operator
28566 @noindent
28567 @tindex evalto
28568 @tindex =>
28569 @cindex Evaluates-to operator
28570 @cindex @samp{=>} operator
28571 The special algebraic symbol @samp{=>} is known as the @dfn{evaluates-to
28572 operator}.  (It will show up as an @code{evalto} function call in
28573 other language modes like Pascal and La@TeX{}.)  This is a binary
28574 operator, that is, it has a lefthand and a righthand argument,
28575 although it can be entered with the righthand argument omitted.
28577 A formula like @samp{@var{a} => @var{b}} is evaluated by Calc as
28578 follows:  First, @var{a} is not simplified or modified in any
28579 way.  The previous value of argument @var{b} is thrown away; the
28580 formula @var{a} is then copied and evaluated as if by the @kbd{=}
28581 command according to all current modes and stored variable values,
28582 and the result is installed as the new value of @var{b}.
28584 For example, suppose you enter the algebraic formula @samp{2 + 3 => 17}.
28585 The number 17 is ignored, and the lefthand argument is left in its
28586 unevaluated form; the result is the formula @samp{2 + 3 => 5}.
28588 @kindex s =
28589 @pindex calc-evalto
28590 You can enter an @samp{=>} formula either directly using algebraic
28591 entry (in which case the righthand side may be omitted since it is
28592 going to be replaced right away anyhow), or by using the @kbd{s =}
28593 (@code{calc-evalto}) command, which takes @var{a} from the stack
28594 and replaces it with @samp{@var{a} => @var{b}}.
28596 Calc keeps track of all @samp{=>} operators on the stack, and
28597 recomputes them whenever anything changes that might affect their
28598 values, i.e., a mode setting or variable value.  This occurs only
28599 if the @samp{=>} operator is at the top level of the formula, or
28600 if 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
28603 dynamically updated when @samp{a} is changed later because the
28604 @samp{=>} operator is buried inside a sum.  However, a vector
28605 of @samp{=>} operators will be recomputed, since it is convenient
28606 to push a vector like @samp{[a =>, b =>, c =>]} on the stack to
28607 make a concise display of all the variables in your problem.
28608 (Another way to do this would be to use @samp{[a, b, c] =>},
28609 which provides a slightly different format of display.  You
28610 can use whichever you find easiest to read.)
28612 @kindex m C
28613 @pindex calc-auto-recompute
28614 The @kbd{m C} (@code{calc-auto-recompute}) command allows you to
28615 turn this automatic recomputation on or off.  If you turn
28616 recomputation off, you must explicitly recompute an @samp{=>}
28617 operator on the stack in one of the usual ways, such as by
28618 pressing @kbd{=}.  Turning recomputation off temporarily can save
28619 a lot of time if you will be changing several modes or variables
28620 before you look at the @samp{=>} entries again.
28622 Most commands are not especially useful with @samp{=>} operators
28623 as arguments.  For example, given @samp{x + 2 => 17}, it won't
28624 work to type @kbd{1 +} to get @samp{x + 3 => 18}.  If you want
28625 to operate on the lefthand side of the @samp{=>} operator on
28626 the top of the stack, type @kbd{j 1} (that's the digit ``one'')
28627 to select the lefthand side, execute your commands, then type
28628 @kbd{j u} to unselect.
28630 All current modes apply when an @samp{=>} operator is computed,
28631 including the current simplification mode.  Recall that the
28632 formula @samp{x + y + x} is not handled by Calc's default
28633 simplifications, but the @kbd{a s} command will reduce it to
28634 the simpler form @samp{y + 2 x}.  You can also type @kbd{m A}
28635 to enable an Algebraic Simplification mode in which the
28636 equivalent of @kbd{a s} is used on all of Calc's results.
28637 If you enter @samp{x + y + x =>} normally, the result will
28638 be @samp{x + y + x => x + y + x}.  If you change to
28639 Algebraic Simplification mode, the result will be
28640 @samp{x + y + x => y + 2 x}.  However, just pressing @kbd{a s}
28641 once will have no effect on @samp{x + y + x => x + y + x},
28642 because the righthand side depends only on the lefthand side
28643 and the current mode settings, and the lefthand side is not
28644 affected by commands like @kbd{a s}.
28646 The ``let'' command (@kbd{s l}) has an interesting interaction
28647 with the @samp{=>} operator.  The @kbd{s l} command evaluates the
28648 second-to-top stack entry with the top stack entry supplying
28649 a temporary value for a given variable.  As you might expect,
28650 if that stack entry is an @samp{=>} operator its righthand
28651 side will temporarily show this value for the variable.  In
28652 fact, all @samp{=>}s on the stack will be updated if they refer
28653 to that variable.  But this change is temporary in the sense
28654 that the next command that causes Calc to look at those stack
28655 entries will make them revert to the old variable value.
28657 @smallexample
28658 @group
28659 2:  a => a             2:  a => 17         2:  a => a
28660 1:  a + 1 => a + 1     1:  a + 1 => 18     1:  a + 1 => a + 1
28661     .                      .                   .
28663                            17 s l a @key{RET}        p 8 @key{RET}
28664 @end group
28665 @end smallexample
28667 Here the @kbd{p 8} command changes the current precision,
28668 thus causing the @samp{=>} forms to be recomputed after the
28669 influence of the ``let'' is gone.  The @kbd{d @key{SPC}} command
28670 (@code{calc-refresh}) is a handy way to force the @samp{=>}
28671 operators on the stack to be recomputed without any other
28672 side effects.
28674 @kindex s :
28675 @pindex calc-assign
28676 @tindex assign
28677 @tindex :=
28678 Embedded mode also uses @samp{=>} operators.  In Embedded mode,
28679 the lefthand side of an @samp{=>} operator can refer to variables
28680 assigned elsewhere in the file by @samp{:=} operators.  The
28681 assignment operator @samp{a := 17} does not actually do anything
28682 by itself.  But Embedded mode recognizes it and marks it as a sort
28683 of file-local definition of the variable.  You can enter @samp{:=}
28684 operators in Algebraic mode, or by using the @kbd{s :}
28685 (@code{calc-assign}) [@code{assign}] command which takes a variable
28686 and value from the stack and replaces them with an assignment.
28688 @xref{TeX and LaTeX Language Modes}, for the way @samp{=>} appears in
28689 @TeX{} language output.  The @dfn{eqn} mode gives similar
28690 treatment to @samp{=>}.
28692 @node Graphics, Kill and Yank, Store and Recall, Top
28693 @chapter Graphics
28695 @noindent
28696 The commands for graphing data begin with the @kbd{g} prefix key.  Calc
28697 uses GNUPLOT 2.0 or later to do graphics.  These commands will only work
28698 if GNUPLOT is available on your system.  (While GNUPLOT sounds like
28699 a relative of GNU Emacs, it is actually completely unrelated.
28700 However, it is free software.   It can be obtained from
28701 @samp{http://www.gnuplot.info}.)
28703 @vindex calc-gnuplot-name
28704 If you have GNUPLOT installed on your system but Calc is unable to
28705 find it, you may need to set the @code{calc-gnuplot-name} variable
28706 in your Calc init file or @file{.emacs}.  You may also need to set some Lisp
28707 variables to show Calc how to run GNUPLOT on your system; these
28708 are described under @kbd{g D} and @kbd{g O} below.  If you are
28709 using the X window system, Calc will configure GNUPLOT for you
28710 automatically.  If you have GNUPLOT 3.0 or later and you are not using X,
28711 Calc will configure GNUPLOT to display graphs using simple character
28712 graphics that will work on any terminal.
28714 @menu
28715 * Basic Graphics::
28716 * Three Dimensional Graphics::
28717 * Managing Curves::
28718 * Graphics Options::
28719 * Devices::
28720 @end menu
28722 @node Basic Graphics, Three Dimensional Graphics, Graphics, Graphics
28723 @section Basic Graphics
28725 @noindent
28726 @kindex g f
28727 @pindex calc-graph-fast
28728 The easiest graphics command is @kbd{g f} (@code{calc-graph-fast}).
28729 This command takes two vectors of equal length from the stack.
28730 The vector at the top of the stack represents the ``y'' values of
28731 the various data points.  The vector in the second-to-top position
28732 represents the corresponding ``x'' values.  This command runs
28733 GNUPLOT (if it has not already been started by previous graphing
28734 commands) and displays the set of data points.  The points will
28735 be connected by lines, and there will also be some kind of symbol
28736 to indicate the points themselves.
28738 The ``x'' entry may instead be an interval form, in which case suitable
28739 ``x'' values are interpolated between the minimum and maximum values of
28740 the interval (whether the interval is open or closed is ignored).
28742 The ``x'' entry may also be a number, in which case Calc uses the
28743 sequence 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.)
28746 The ``y'' entry may be any formula instead of a vector.  Calc effectively
28747 uses @kbd{N} (@code{calc-eval-num}) to evaluate variables in the formula;
28748 the result of this must be a formula in a single (unassigned) variable.
28749 The formula is plotted with this variable taking on the various ``x''
28750 values.  Graphs of formulas by default use lines without symbols at the
28751 computed data points.  Note that if neither ``x'' nor ``y'' is a vector,
28752 Calc 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
28754 or an interval if ``y'' is a formula.)
28756 @ignore
28757 @starindex
28758 @end ignore
28759 @tindex xy
28760 If ``y'' is (or evaluates to) a formula of the form
28761 @samp{xy(@var{x}, @var{y})} then the result is a
28762 parametric plot.  The two arguments of the fictitious @code{xy} function
28763 are used as the ``x'' and ``y'' coordinates of the curve, respectively.
28764 In this case the ``x'' vector or interval you specified is not directly
28765 visible in the graph.  For example, if ``x'' is the interval @samp{[0..360]}
28766 and ``y'' is the formula @samp{xy(sin(t), cos(t))}, the resulting graph
28767 will be a circle.
28769 Also, ``x'' and ``y'' may each be variable names, in which case Calc
28770 looks for suitable vectors, intervals, or formulas stored in those
28771 variables.
28773 The ``x'' and ``y'' values for the data points (as pulled from the vectors,
28774 calculated from the formulas, or interpolated from the intervals) should
28775 be real numbers (integers, fractions, or floats).  If either the ``x''
28776 value or the ``y'' value of a given data point is not a real number, that
28777 data point will be omitted from the graph.  The points on either side
28778 of the invalid point will @emph{not} be connected by a line.
28780 See the documentation for @kbd{g a} below for a description of the way
28781 numeric prefix arguments affect @kbd{g f}.
28783 @cindex @code{PlotRejects} variable
28784 @vindex PlotRejects
28785 If you store an empty vector in the variable @code{PlotRejects}
28786 (i.e., @kbd{[ ] s t PlotRejects}), Calc will append information to
28787 this vector for every data point which was rejected because its
28788 ``x'' or ``y'' values were not real numbers.  The result will be
28789 a 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
28792 current value of @code{PlotRejects}.  @xref{Operations on Variables},
28793 for the @kbd{s R} command which is another easy way to examine
28794 @code{PlotRejects}.
28796 @kindex g c
28797 @pindex calc-graph-clear
28798 To clear the graphics display, type @kbd{g c} (@code{calc-graph-clear}).
28799 If the GNUPLOT output device is an X window, the window will go away.
28800 Effects on other kinds of output devices will vary.  You don't need
28801 to use @kbd{g c} if you don't want to---if you give another @kbd{g f}
28802 or @kbd{g p} command later on, it will reuse the existing graphics
28803 window if there is one.
28805 @node Three Dimensional Graphics, Managing Curves, Basic Graphics, Graphics
28806 @section Three-Dimensional Graphics
28808 @kindex g F
28809 @pindex calc-graph-fast-3d
28810 The @kbd{g F} (@code{calc-graph-fast-3d}) command makes a three-dimensional
28811 graph.  It works only if you have GNUPLOT 3.0 or later; with GNUPLOT 2.0,
28812 you will see a GNUPLOT error message if you try this command.
28814 The @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
28816 are several options for these values.
28818 In the first case, ``x'' and ``y'' are each vectors (not necessarily of
28819 the 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
28821 in ``x'', and the same number of columns as elements in ``y''.  The
28822 result is a surface plot where 
28823 @texline @math{z_{ij}}
28824 @infoline @expr{z_ij} 
28825 is the height of the point
28826 at coordinate @expr{(x_i, y_j)} on the surface.  The 3D graph will
28827 be displayed from a certain default viewpoint; you can change this
28828 viewpoint by adding a @samp{set view} to the @samp{*Gnuplot Commands*}
28829 buffer as described later.  See the GNUPLOT documentation for a
28830 description of the @samp{set view} command.
28832 Each point in the matrix will be displayed as a dot in the graph,
28833 and these points will be connected by a grid of lines (@dfn{isolines}).
28835 In the second case, ``x'', ``y'', and ``z'' are all vectors of equal
28836 length.  The resulting graph displays a 3D line instead of a surface,
28837 where the coordinates of points along the line are successive triplets
28838 of values from the input vectors.
28840 In the third case, ``x'' and ``y'' are vectors or interval forms, and
28841 ``z'' is any formula involving two variables (not counting variables
28842 with assigned values).  These variables are sorted into alphabetical
28843 order; the first takes on values from ``x'' and the second takes on
28844 values from ``y'' to form a matrix of results that are graphed as a
28845 3D surface.
28847 @ignore
28848 @starindex
28849 @end ignore
28850 @tindex xyz
28851 If 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
28854 taken 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
28856 to 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))}
28858 will draw a sphere.  (Since the default resolution for 3D plots is
28859 5 steps in each of ``x'' and ``y'', this will draw a very crude
28860 sphere.  You could use the @kbd{g N} command, described below, to
28861 increase this resolution, or specify the ``x'' and ``y'' values as
28862 vectors with more than 5 elements.
28864 It is also possible to have a function in a regular @kbd{g f} plot
28865 evaluate to an @code{xyz} call.  Since @kbd{g f} plots a line, not
28866 a 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
28868 helix (a three-dimensional spiral).
28870 As for @kbd{g f}, each of ``x'', ``y'', and ``z'' may instead be
28871 variables containing the relevant data.
28873 @node Managing Curves, Graphics Options, Three Dimensional Graphics, Graphics
28874 @section Managing Curves
28876 @noindent
28877 The @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
28880 by using these commands directly.
28882 @kindex g a
28883 @pindex calc-graph-add
28884 The @kbd{g a} (@code{calc-graph-add}) command adds the ``curve''
28885 represented by the two values on the top of the stack to the current
28886 graph.  You can have any number of curves in the same graph.  When
28887 you give the @kbd{g p} command, all the curves will be drawn superimposed
28888 on the same axes.
28890 The @kbd{g a} command (and many others that affect the current graph)
28891 will cause a special buffer, @samp{*Gnuplot Commands*}, to be displayed
28892 in another window.  This buffer is a template of the commands that will
28893 be 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.
28896 Other graph-related commands put other GNUPLOT commands into this
28897 buffer.  In normal usage you never need to work with this buffer
28898 directly, but you can if you wish.  The only constraint is that there
28899 must be only one @code{plot} command, and it must be the last command
28900 in the buffer.  If you want to save and later restore a complete graph
28901 configuration, you can use regular Emacs commands to save and restore
28902 the contents of the @samp{*Gnuplot Commands*} buffer.
28904 @vindex PlotData1
28905 @vindex PlotData2
28906 If the values on the stack are not variable names, @kbd{g a} will invent
28907 variable names for them (of the form @samp{PlotData@var{n}}) and store
28908 the values in those variables.  The ``x'' and ``y'' variables are what
28909 go into the @code{plot} command in the template.  If you add a curve
28910 that uses a certain variable and then later change that variable, you
28911 can replot the graph without having to delete and re-add the curve.
28912 That's because the variable name, not the vector, interval or formula
28913 itself, is what was added by @kbd{g a}.
28915 A numeric prefix argument on @kbd{g a} or @kbd{g f} changes the way
28916 stack entries are interpreted as curves.  With a positive prefix
28917 argument @expr{n}, the top @expr{n} stack entries are ``y'' values
28918 for @expr{n} different curves which share a common ``x'' value in
28919 the @expr{n+1}st stack entry.  (Thus @kbd{g a} with no prefix
28920 argument is equivalent to @kbd{C-u 1 g a}.)
28922 A 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''.
28926 A negative prefix argument tells Calc to read @expr{n} vectors from
28927 the stack; each vector @expr{[x, y]} describes an independent curve.
28928 This is the only form of @kbd{g a} that creates several curves at once
28929 that don't have common ``x'' values.  (Of course, the range of ``x''
28930 values covered by all the curves ought to be roughly the same if
28931 they are to look nice on the same graph.)
28933 For example, to plot 
28934 @texline @math{\sin n x}
28935 @infoline @expr{sin(n x)} 
28936 for integers @expr{n}
28937 from 1 to 5, you could use @kbd{v x} to create a vector of integers
28938 (@expr{n}), then @kbd{V M '} or @kbd{V M $} to map @samp{sin(n x)}
28939 across this vector.  The resulting vector of formulas is suitable
28940 for use as the ``y'' argument to a @kbd{C-u g a} or @kbd{C-u g f}
28941 command.
28943 @kindex g A
28944 @pindex calc-graph-add-3d
28945 The @kbd{g A} (@code{calc-graph-add-3d}) command adds a 3D curve
28946 to the graph.  It is not valid to intermix 2D and 3D curves in a
28947 single graph.  This command takes three arguments, ``x'', ``y'',
28948 and ``z'', from the stack.  With a positive prefix @expr{n}, it
28949 takes @expr{n+2} arguments (common ``x'' and ``y'', plus @expr{n}
28950 separate ``z''s).  With a zero prefix, it takes three stack entries
28951 but the ``z'' entry is a vector of curve values.  With a negative
28952 prefix @expr{-n}, it takes @expr{n} vectors of the form @expr{[x, y, z]}.
28953 The @kbd{g A} command works by adding a @code{splot} (surface-plot)
28954 command to the @samp{*Gnuplot Commands*} buffer.
28956 (Although @kbd{g a} adds a 2D @code{plot} command to the
28957 @samp{*Gnuplot Commands*} buffer, Calc changes this to @code{splot}
28958 before sending it to GNUPLOT if it notices that the data points are
28959 evaluating 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
28961 check for this.)
28963 @kindex g d
28964 @pindex calc-graph-delete
28965 The @kbd{g d} (@code{calc-graph-delete}) command deletes the most
28966 recently added curve from the graph.  It has no effect if there are
28967 no curves in the graph.  With a numeric prefix argument of any kind,
28968 it deletes all of the curves from the graph.
28970 @kindex g H
28971 @pindex calc-graph-hide
28972 The @kbd{g H} (@code{calc-graph-hide}) command ``hides'' or ``unhides''
28973 the most recently added curve.  A hidden curve will not appear in
28974 the actual plot, but information about it such as its name and line and
28975 point styles will be retained.
28977 @kindex g j
28978 @pindex calc-graph-juggle
28979 The @kbd{g j} (@code{calc-graph-juggle}) command moves the curve
28980 at the end of the list (the ``most recently added curve'') to the
28981 front 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
28983 with any curve in the graph even though curve-related commands only
28984 affect the last curve in the list.
28986 @kindex g p
28987 @pindex calc-graph-plot
28988 The @kbd{g p} (@code{calc-graph-plot}) command uses GNUPLOT to draw
28989 the graph described in the @samp{*Gnuplot Commands*} buffer.  Any
28990 GNUPLOT parameters which are not defined by commands in this buffer
28991 are reset to their default values.  The variables named in the @code{plot}
28992 command are written to a temporary data file and the variable names
28993 are then replaced by the file name in the template.  The resulting
28994 plotting commands are fed to the GNUPLOT program.  See the documentation
28995 for the GNUPLOT program for more specific information.  All temporary
28996 files are removed when Emacs or GNUPLOT exits.
28998 If you give a formula for ``y'', Calc will remember all the values that
28999 it calculates for the formula so that later plots can reuse these values.
29000 Calc throws out these saved values when you change any circumstances
29001 that may affect the data, such as switching from Degrees to Radians
29002 mode, or changing the value of a parameter in the formula.  You can
29003 force Calc to recompute the data from scratch by giving a negative
29004 numeric prefix argument to @kbd{g p}.
29006 Calc uses a fairly rough step size when graphing formulas over intervals.
29007 This is to ensure quick response.  You can ``refine'' a plot by giving
29008 a positive numeric prefix argument to @kbd{g p}.  Calc goes through
29009 the data points it has computed and saved from previous plots of the
29010 function, and computes and inserts a new data point midway between
29011 each of the existing points.  You can refine a plot any number of times,
29012 but beware that the amount of calculation involved doubles each time.
29014 Calc does not remember computed values for 3D graphs.  This means the
29015 numerix prefix argument, if any, to @kbd{g p} is effectively ignored if
29016 the current graph is three-dimensional.
29018 @kindex g P
29019 @pindex calc-graph-print
29020 The @kbd{g P} (@code{calc-graph-print}) command is like @kbd{g p},
29021 except that it sends the output to a printer instead of to the
29022 screen.  More precisely, @kbd{g p} looks for @samp{set terminal}
29023 or @samp{set output} commands in the @samp{*Gnuplot Commands*} buffer;
29024 lacking these it uses the default settings.  However, @kbd{g P}
29025 ignores @samp{set terminal} and @samp{set output} commands and
29026 uses a different set of default values.  All of these values are
29027 controlled by the @kbd{g D} and @kbd{g O} commands discussed below.
29028 Provided everything is set up properly, @kbd{g p} will plot to
29029 the screen unless you have specified otherwise and @kbd{g P} will
29030 always plot to the printer.
29032 @node Graphics Options, Devices, Managing Curves, Graphics
29033 @section Graphics Options
29035 @noindent
29036 @kindex g g
29037 @pindex calc-graph-grid
29038 The @kbd{g g} (@code{calc-graph-grid}) command turns the ``grid''
29039 on and off.  It is off by default; tick marks appear only at the
29040 edges of the graph.  With the grid turned on, dotted lines appear
29041 across the graph at each tick mark.  Note that this command only
29042 changes the setting in @samp{*Gnuplot Commands*}; to see the effects
29043 of the change you must give another @kbd{g p} command.
29045 @kindex g b
29046 @pindex calc-graph-border
29047 The @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.
29049 This command will only work with GNUPLOT 3.0 and later versions.
29051 @kindex g k
29052 @pindex calc-graph-key
29053 The @kbd{g k} (@code{calc-graph-key}) command turns the ``key''
29054 on and off.  The key is a chart in the corner of the graph that
29055 shows the correspondence between curves and line styles.  It is
29056 off by default, and is only really useful if you have several
29057 curves on the same graph.
29059 @kindex g N
29060 @pindex calc-graph-num-points
29061 The @kbd{g N} (@code{calc-graph-num-points}) command allows you
29062 to select the number of data points in the graph.  This only affects
29063 curves where neither ``x'' nor ``y'' is specified as a vector.
29064 Enter a blank line to revert to the default value (initially 15).
29065 With no prefix argument, this command affects only the current graph.
29066 With a positive prefix argument this command changes or, if you enter
29067 a blank line, displays the default number of points used for all
29068 graphs created by @kbd{g a} that don't specify the resolution explicitly.
29069 With a negative prefix argument, this command changes or displays
29070 the default value (initially 5) used for 3D graphs created by @kbd{g A}.
29071 Note that a 3D setting of 5 means that a total of @expr{5^2 = 25} points
29072 will be computed for the surface.
29074 Data values in the graph of a function are normally computed to a
29075 precision of five digits, regardless of the current precision at the
29076 time. This is usually more than adequate, but there are cases where
29077 it will not be.  For example, plotting @expr{1 + x} with @expr{x} in the
29078 interval @samp{[0 ..@: 1e-6]} will round all the data points down
29079 to 1.0!  Putting the command @samp{set precision @var{n}} in the
29080 @samp{*Gnuplot Commands*} buffer will cause the data to be computed
29081 at precision @var{n} instead of 5.  Since this is such a rare case,
29082 there is no keystroke-based command to set the precision.
29084 @kindex g h
29085 @pindex calc-graph-header
29086 The @kbd{g h} (@code{calc-graph-header}) command sets the title
29087 for the graph.  This will show up centered above the graph.
29088 The default title is blank (no title).
29090 @kindex g n
29091 @pindex calc-graph-name
29092 The @kbd{g n} (@code{calc-graph-name}) command sets the title of an
29093 individual curve.  Like the other curve-manipulating commands, it
29094 affects the most recently added curve, i.e., the last curve on the
29095 list in the @samp{*Gnuplot Commands*} buffer.  To set the title of
29096 the other curves you must first juggle them to the end of the list
29097 with @kbd{g j}, or edit the @samp{*Gnuplot Commands*} buffer by hand.
29098 Curve titles appear in the key; if the key is turned off they are
29099 not used.
29101 @kindex g t
29102 @kindex g T
29103 @pindex calc-graph-title-x
29104 @pindex calc-graph-title-y
29105 The @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''
29107 and ``y'' axes, respectively.  These titles appear next to the
29108 tick marks on the left and bottom edges of the graph, respectively.
29109 Calc does not have commands to control the tick marks themselves,
29110 but you can edit them into the @samp{*Gnuplot Commands*} buffer if
29111 you wish.  See the GNUPLOT documentation for details.
29113 @kindex g r
29114 @kindex g R
29115 @pindex calc-graph-range-x
29116 @pindex calc-graph-range-y
29117 The @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
29120 suitable range.  This should be either a pair of numbers of the
29121 form, @samp{@var{min}:@var{max}}, or a blank line to revert to the
29122 default behavior of setting the range based on the range of values
29123 in the data, or @samp{$} to take the range from the top of the stack.
29124 Ranges on the stack can be represented as either interval forms or
29125 vectors:  @samp{[@var{min} ..@: @var{max}]} or @samp{[@var{min}, @var{max}]}.
29127 @kindex g l
29128 @kindex g L
29129 @pindex calc-graph-log-x
29130 @pindex calc-graph-log-y
29131 The @kbd{g l} (@code{calc-graph-log-x}) and @kbd{g L} (@code{calc-graph-log-y})
29132 commands allow you to set either or both of the axes of the graph to
29133 be logarithmic instead of linear.
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
29141 For 3D plots, @kbd{g C-t}, @kbd{g C-r}, and @kbd{g C-l} (those are
29142 letters with the Control key held down) are the corresponding commands
29143 for the ``z'' axis.
29145 @kindex g z
29146 @kindex g Z
29147 @pindex calc-graph-zero-x
29148 @pindex calc-graph-zero-y
29149 The @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
29151 drawn to indicate the ``x'' and/or ``y'' zero axes.  (These are the same
29152 dotted lines that would be drawn there anyway if you used @kbd{g g} to
29153 turn the ``grid'' feature on.)  Zero-axis lines are on by default, and
29154 may be turned off only in GNUPLOT 3.0 and later versions.  They are
29155 not available for 3D plots.
29157 @kindex g s
29158 @pindex calc-graph-line-style
29159 The @kbd{g s} (@code{calc-graph-line-style}) command turns the connecting
29160 lines on or off for the most recently added curve, and optionally selects
29161 the style of lines to be used for that curve.  Plain @kbd{g s} simply
29162 toggles the lines on and off.  With a numeric prefix argument, @kbd{g s}
29163 turns lines on and sets a particular line style.  Line style numbers
29164 start at one and their meanings vary depending on the output device.
29165 GNUPLOT guarantees that there will be at least six different line styles
29166 available for any device.
29168 @kindex g S
29169 @pindex calc-graph-point-style
29170 The @kbd{g S} (@code{calc-graph-point-style}) command similarly turns
29171 the symbols at the data points on or off, or sets the point style.
29172 If you turn both lines and points off, the data points will show as
29173 tiny dots.
29175 @cindex @code{LineStyles} variable
29176 @cindex @code{PointStyles} variable
29177 @vindex LineStyles
29178 @vindex PointStyles
29179 Another way to specify curve styles is with the @code{LineStyles} and
29180 @code{PointStyles} variables.  These variables initially have no stored
29181 values, but if you store a vector of integers in one of these variables,
29182 the @kbd{g a} and @kbd{g f} commands will use those style numbers
29183 instead of the defaults for new curves that are added to the graph.
29184 An entry should be a positive integer for a specific style, or 0 to let
29185 the style be chosen automatically, or @mathit{-1} to turn off lines or points
29186 altogether.  If there are more curves than elements in the vector, the
29187 last few curves will continue to have the default styles.  Of course,
29188 you can later use @kbd{g s} and @kbd{g S} to change any of these styles.
29190 For example, @kbd{'[2 -1 3] @key{RET} s t LineStyles} causes the first curve
29191 to have lines in style number 2, the second curve to have no connecting
29192 lines, and the third curve to have lines in style 3.  Point styles will
29193 still be assigned automatically, but you could store another vector in
29194 @code{PointStyles} to define them, too.
29196 @node Devices, , Graphics Options, Graphics
29197 @section Graphical Devices
29199 @noindent
29200 @kindex g D
29201 @pindex calc-graph-device
29202 The @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
29204 on this graph.  It does not affect the permanent default device name.
29205 If you enter a blank name, the device name reverts to the default.
29206 Enter @samp{?} to see a list of supported devices.
29208 With a positive numeric prefix argument, @kbd{g D} instead sets
29209 the default device name, used by all plots in the future which do
29210 not override it with a plain @kbd{g D} command.  If you enter a
29211 blank line this command shows you the current default.  The special
29212 name @code{default} signifies that Calc should choose @code{x11} if
29213 the X window system is in use (as indicated by the presence of a
29214 @code{DISPLAY} environment variable), or otherwise @code{dumb} under
29215 GNUPLOT 3.0 and later, or @code{postscript} under GNUPLOT 2.0.
29216 This is the initial default value.
29218 The @code{dumb} device is an interface to ``dumb terminals,'' i.e.,
29219 terminals with no special graphics facilities.  It writes a crude
29220 picture of the graph composed of characters like @code{-} and @code{|}
29221 to a buffer called @samp{*Gnuplot Trail*}, which Calc then displays.
29222 The graph is made the same size as the Emacs screen, which on most
29223 dumb terminals will be 
29224 @texline @math{80\times24}
29225 @infoline 80x24
29226 characters.  The graph is displayed in
29227 an Emacs ``recursive edit''; type @kbd{q} or @kbd{C-c C-c} to exit
29228 the recursive edit and return to Calc.  Note that the @code{dumb}
29229 device is present only in GNUPLOT 3.0 and later versions.
29231 The word @code{dumb} may be followed by two numbers separated by
29232 spaces.  These are the desired width and height of the graph in
29233 characters.  Also, the device name @code{big} is like @code{dumb}
29234 but creates a graph four times the width and height of the Emacs
29235 screen.  You will then have to scroll around to view the entire
29236 graph.  In the @samp{*Gnuplot Trail*} buffer, @key{SPC}, @key{DEL},
29237 @kbd{<}, and @kbd{>} are defined to scroll by one screenful in each
29238 of the four directions.
29240 With a negative numeric prefix argument, @kbd{g D} sets or displays
29241 the device name used by @kbd{g P} (@code{calc-graph-print}).  This
29242 is initially @code{postscript}.  If you don't have a PostScript
29243 printer, you may decide once again to use @code{dumb} to create a
29244 plot on any text-only printer.
29246 @kindex g O
29247 @pindex calc-graph-output
29248 The @kbd{g O} (@code{calc-graph-output}) command sets the name of
29249 the output file used by GNUPLOT.  For some devices, notably @code{x11},
29250 there is no output file and this information is not used.  Many other
29251 ``devices'' are really file formats like @code{postscript}; in these
29252 cases the output in the desired format goes into the file you name
29253 with @kbd{g O}.  Type @kbd{g O stdout @key{RET}} to set GNUPLOT to write
29254 to its standard output stream, i.e., to @samp{*Gnuplot Trail*}.
29255 This is the default setting.
29257 Another special output name is @code{tty}, which means that GNUPLOT
29258 is going to write graphics commands directly to its standard output,
29259 which you wish Emacs to pass through to your terminal.  Tektronix
29260 graphics terminals, among other devices, operate this way.  Calc does
29261 this by telling GNUPLOT to write to a temporary file, then running a
29262 sub-shell executing the command @samp{cat tempfile >/dev/tty}.  On
29263 typical Unix systems, this will copy the temporary file directly to
29264 the terminal, bypassing Emacs entirely.  You will have to type @kbd{C-l}
29265 to Emacs afterwards to refresh the screen.
29267 Once again, @kbd{g O} with a positive or negative prefix argument
29268 sets the default or printer output file names, respectively.  In each
29269 case you can specify @code{auto}, which causes Calc to invent a temporary
29270 file name for each @kbd{g p} (or @kbd{g P}) command.  This temporary file
29271 will be deleted once it has been displayed or printed.  If the output file
29272 name is not @code{auto}, the file is not automatically deleted.
29274 The default and printer devices and output files can be saved
29275 permanently by the @kbd{m m} (@code{calc-save-modes}) command.  The
29276 default 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}
29278 saved; you can save a graph's configuration simply by saving the contents
29279 of the @samp{*Gnuplot Commands*} buffer.
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
29287 You may wish to configure the default and
29288 printer devices and output files for the whole system.  The relevant
29289 Lisp variables are @code{calc-gnuplot-default-device} and @code{-output},
29290 and @code{calc-gnuplot-print-device} and @code{-output}.  The output
29291 file names must be either strings as described above, or Lisp
29292 expressions which are evaluated on the fly to get the output file names.
29294 Other important Lisp variables are @code{calc-gnuplot-plot-command} and
29295 @code{calc-gnuplot-print-command}, which give the system commands to
29296 display 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.
29299 Or, these variables may contain Lisp expressions which are evaluated
29300 to display or print the output.  These variables are customizable
29301 (@pxref{Customizable Variables}).
29303 @kindex g x
29304 @pindex calc-graph-display
29305 The @kbd{g x} (@code{calc-graph-display}) command lets you specify
29306 on which X window system display your graphs should be drawn.  Enter
29307 a blank line to see the current display name.  This command has no
29308 effect unless the current device is @code{x11}.
29310 @kindex g X
29311 @pindex calc-graph-geometry
29312 The @kbd{g X} (@code{calc-graph-geometry}) command is a similar
29313 command for specifying the position and size of the X window.
29314 The normal value is @code{default}, which generally means your
29315 window manager will let you place the window interactively.
29316 Entering @samp{800x500+0+0} would create an 800-by-500 pixel
29317 window in the upper-left corner of the screen.
29319 The buffer called @samp{*Gnuplot Trail*} holds a transcript of the
29320 session with GNUPLOT.  This shows the commands Calc has ``typed'' to
29321 GNUPLOT and the responses it has received.  Calc tries to notice when an
29322 error message has appeared here and display the buffer for you when
29323 this happens.  You can check this buffer yourself if you suspect
29324 something has gone wrong.
29326 @kindex g C
29327 @pindex calc-graph-command
29328 The @kbd{g C} (@code{calc-graph-command}) command prompts you to
29329 enter any line of text, then simply sends that line to the current
29330 GNUPLOT process.  The @samp{*Gnuplot Trail*} buffer looks deceptively
29331 like a Shell buffer but you can't type commands in it yourself.
29332 Instead, you must use @kbd{g C} for this purpose.
29334 @kindex g v
29335 @kindex g V
29336 @pindex calc-graph-view-commands
29337 @pindex calc-graph-view-trail
29338 The @kbd{g v} (@code{calc-graph-view-commands}) and @kbd{g V}
29339 (@code{calc-graph-view-trail}) commands display the @samp{*Gnuplot Commands*}
29340 and @samp{*Gnuplot Trail*} buffers, respectively, in another window.
29341 This happens automatically when Calc thinks there is something you
29342 will want to see in either of these buffers.  If you type @kbd{g v}
29343 or @kbd{g V} when the relevant buffer is already displayed, the
29344 buffer is hidden again.
29346 One 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
29350 annotate your plots.  Since Calc doesn't understand these commands,
29351 you have to add them to the @samp{*Gnuplot Commands*} buffer
29352 yourself, then use @w{@kbd{g p}} to replot using these new commands.  Note
29353 that your commands must appear @emph{before} the @code{plot} command.
29354 To get help on any GNUPLOT feature, type, e.g., @kbd{g C help set label}.
29355 You may have to type @kbd{g C @key{RET}} a few times to clear the
29356 ``press return for more'' or ``subtopic of @dots{}'' requests.
29357 Note that Calc always sends commands (like @samp{set nolabel}) to
29358 reset all plotting parameters to the defaults before each plot, so
29359 to delete a label all you need to do is delete the @samp{set label}
29360 line you added (or comment it out with @samp{#}) and then replot
29361 with @kbd{g p}.
29363 @kindex g q
29364 @pindex calc-graph-quit
29365 You can use @kbd{g q} (@code{calc-graph-quit}) to kill the GNUPLOT
29366 process that is running.  The next graphing command you give will
29367 start a fresh GNUPLOT process.  The word @samp{Graph} appears in
29368 the Calc window's mode line whenever a GNUPLOT process is currently
29369 running.  The GNUPLOT process is automatically killed when you
29370 exit Emacs if you haven't killed it manually by then.
29372 @kindex g K
29373 @pindex calc-graph-kill
29374 The @kbd{g K} (@code{calc-graph-kill}) command is like @kbd{g q}
29375 except that it also views the @samp{*Gnuplot Trail*} buffer so that
29376 you can see the process being killed.  This is better if you are
29377 killing GNUPLOT because you think it has gotten stuck.
29379 @node Kill and Yank, Keypad Mode, Graphics, Top
29380 @chapter Kill and Yank Functions
29382 @noindent
29383 The commands in this chapter move information between the Calculator and
29384 other Emacs editing buffers.
29386 In many cases Embedded mode is an easier and more natural way to
29387 work with Calc from a regular editing buffer.  @xref{Embedded Mode}.
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
29397 @node Killing From Stack, Yanking Into Stack, Kill and Yank, Kill and Yank
29398 @section Killing from the Stack
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}
29412 command.  Three common kill commands in normal Emacs are @kbd{C-k}, which
29413 kills one line, @kbd{C-w}, which kills the region between mark and point,
29414 and @kbd{M-w}, which puts the region into the kill ring without actually
29415 deleting 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
29417 into the kill ring without deleting anything.
29419 The kill commands are unusual in that they pay attention to the location
29420 of the cursor in the Calculator buffer.  If the cursor is on or below the
29421 bottom line, the kill commands operate on the top of the stack.  Otherwise,
29422 they operate on whatever stack element the cursor is on.  Calc's kill
29423 commands always operate on whole stack entries.  (They act the same as their
29424 standard Emacs cousins except they ``round up'' the specified region to
29425 encompass full lines.)  The text is copied into the kill ring exactly as
29426 it appears on the screen, including line numbers if they are enabled.
29428 A numeric prefix argument to @kbd{C-k} or @kbd{M-k} affects the number
29429 of lines killed.  A positive argument kills the current line and @expr{n-1}
29430 lines below it.  A negative argument kills the @expr{-n} lines above the
29431 current 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}
29433 with 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
29435 newline.
29437 @node Yanking Into Stack, Grabbing From Buffers, Killing From Stack, Kill and Yank
29438 @section Yanking into the Stack
29440 @noindent
29441 @kindex C-y
29442 @pindex calc-yank
29443 The @kbd{C-y} command yanks the most recently killed text back into the
29444 Calculator.  It pushes this value onto the top of the stack regardless of
29445 the cursor position.  In general it re-parses the killed text as a number
29446 or formula (or a list of these separated by commas or newlines).  However if
29447 the thing being yanked is something that was just killed from the Calculator
29448 itself, its full internal structure is yanked.  For example, if you have
29449 set the floating-point display mode to show only four significant digits,
29450 then killing and re-yanking 3.14159 (which displays as 3.142) will yank the
29451 full 3.14159, even though yanking it into any other buffer would yank the
29452 number in its displayed form, 3.142.  (Since the default display modes
29453 show all objects to their full precision, this feature normally makes no
29454 difference.)
29456 @node Grabbing From Buffers, Yanking Into Buffers, Yanking Into Stack, Kill and Yank
29457 @section Grabbing from Other Buffers
29459 @noindent
29460 @kindex M-# g
29461 @pindex calc-grab-region
29462 The @kbd{M-# g} (@code{calc-grab-region}) command takes the text between
29463 point and mark in the current buffer and attempts to parse it as a
29464 vector of values.  Basically, it wraps the text in vector brackets
29465 @samp{[ ]} unless the text already is enclosed in vector brackets,
29466 then reads the text as if it were an algebraic entry.  The contents
29467 of the vector may be numbers, formulas, or any other Calc objects.
29468 If the @kbd{M-# g} command works successfully, it does an automatic
29469 @kbd{M-# c} to enter the Calculator buffer.
29471 A numeric prefix argument grabs the specified number of lines around
29472 point, ignoring the mark.  A positive prefix grabs from point to the
29473 @expr{n}th following newline (so that @kbd{M-1 M-# g} grabs from point
29474 to the end of the current line); a negative prefix grabs from point
29475 back to the @expr{n+1}st preceding newline.  In these cases the text
29476 that is grabbed is exactly the same as the text that @kbd{C-k} would
29477 delete given that prefix argument.
29479 A prefix of zero grabs the current line; point may be anywhere on the
29480 line.
29482 A plain @kbd{C-u} prefix interprets the region between point and mark
29483 as 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
29485 values @samp{[2, a, b]}, but @kbd{C-u M-# g} on the same region
29486 reads 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
29488 vector of one element by plain @kbd{M-# g} because the interpretation
29489 @samp{[a, +, b]} would be a syntax error.)
29491 If a different language has been specified (@pxref{Language Modes}),
29492 the grabbed text will be interpreted according to that language.
29494 @kindex M-# r
29495 @pindex calc-grab-rectangle
29496 The @kbd{M-# r} (@code{calc-grab-rectangle}) command takes the text between
29497 point and mark and attempts to parse it as a matrix.  If point and mark
29498 are both in the leftmost column, the lines in between are parsed in their
29499 entirety.  Otherwise, point and mark define the corners of a rectangle
29500 whose contents are parsed.
29502 Each line of the grabbed area becomes a row of the matrix.  The result
29503 will actually be a vector of vectors, which Calc will treat as a matrix
29504 only if every row contains the same number of values.
29506 If a line contains a portion surrounded by square brackets (or curly
29507 braces), that portion is interpreted as a vector which becomes a row
29508 of the matrix.  Any text surrounding the bracketed portion on the line
29509 is ignored.
29511 Otherwise, the entire line is interpreted as a row vector as if it
29512 were surrounded by square brackets.  Leading line numbers (in the
29513 format used in the Calc stack buffer) are ignored.  If you wish to
29514 force this interpretation (even if the line contains bracketed
29515 portions), give a negative numeric prefix argument to the
29516 @kbd{M-# r} command.
29518 If you give a numeric prefix argument of zero or plain @kbd{C-u}, each
29519 line is instead interpreted as a single formula which is converted into
29520 a one-element vector.  Thus the result of @kbd{C-u M-# r} will be a
29521 one-column matrix.  For example, suppose one line of the data is the
29522 expression @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
29524 one row of the matrix.  But a @kbd{C-u M-# r} will interpret this row
29525 as @samp{[2*a]}.
29527 If you give a positive numeric prefix argument @var{n}, then each line
29528 will be split up into columns of width @var{n}; each column is parsed
29529 separately as a matrix element.  If a line contained
29530 @w{@samp{2 +/- 3 4 +/- 5}}, then grabbing with a prefix argument of 8
29531 would correctly split the line into two error forms.
29533 @xref{Matrix Functions}, to see how to pull the matrix apart into its
29534 constituent rows and columns.  (If it is a 
29535 @texline @math{1\times1}
29536 @infoline 1x1
29537 matrix, just hit @kbd{v u} (@code{calc-unpack}) twice.)
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
29544 The @kbd{M-# :} (@code{calc-grab-sum-down}) command is a handy way to
29545 grab a rectangle of data and sum its columns.  It is equivalent to
29546 typing @kbd{M-# r}, followed by @kbd{V R : +} (the vector reduction
29547 command that sums the columns of a matrix; @pxref{Reducing}).  The
29548 result of the command will be a vector of numbers, one for each column
29549 in the input data.  The @kbd{M-# _} (@code{calc-grab-sum-across}) command
29550 similarly grabs a rectangle and sums its rows by executing @w{@kbd{V R _ +}}.
29552 As well as being more convenient, @kbd{M-# :} and @kbd{M-# _} are also
29553 much faster because they don't actually place the grabbed vector on
29554 the stack.  In a @kbd{M-# r V R : +} sequence, formatting the vector
29555 for 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).
29558 For example, suppose we have a column of numbers in a file which we
29559 wish to sum.  Go to one corner of the column and press @kbd{C-@@} to
29560 set the mark; go to the other corner and type @kbd{M-# :}.  Since there
29561 is 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
29563 you want to do further arithmetic with it.)
29565 To compute the product of the column of numbers, we would have to do
29566 it ``by hand'' since there's no special grab-and-multiply command.
29567 Use @kbd{M-# r} to grab the column of numbers into the calculator in
29568 the form of a column matrix.  The statistics command @kbd{u *} is a
29569 handy way to find the product of a vector or matrix of numbers.
29570 @xref{Statistical Operations}.  Another approach would be to use
29571 an explicit column reduction command, @kbd{V R : *}.
29573 @node Yanking Into Buffers, X Cut and Paste, Grabbing From Buffers, Kill and Yank
29574 @section Yanking into Other Buffers
29576 @noindent
29577 @kindex y
29578 @pindex calc-copy-to-buffer
29579 The plain @kbd{y} (@code{calc-copy-to-buffer}) command inserts the number
29580 at 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
29582 in a window and whose name does not begin with @samp{*}.  If there is no
29583 such buffer, this is the most recently used buffer except for Calculator
29584 and Calc Trail buffers.)  The number is inserted exactly as it appears and
29585 without a newline.  (If line-numbering is enabled, the line number is
29586 normally not included.)  The number is @emph{not} removed from the stack.
29588 With a prefix argument, @kbd{y} inserts several numbers, one per line.
29589 A positive argument inserts the specified number of values from the top
29590 of the stack.  A negative argument inserts the @expr{n}th value from the
29591 top of the stack.  An argument of zero inserts the entire stack.  Note
29592 that @kbd{y} with an argument of 1 is slightly different from @kbd{y}
29593 with no argument; the former always copies full lines, whereas the
29594 latter strips off the trailing newline.
29596 With a lone @kbd{C-u} as a prefix argument, @kbd{y} @emph{replaces} the
29597 region in the other buffer with the yanked text, then quits the
29598 Calculator, 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
29600 data to produce a new matrix, then type @kbd{C-u y} to replace the
29601 original data with the new data.  One might wish to alter the matrix
29602 display style (@pxref{Vector and Matrix Formats}) or change the current
29603 display language (@pxref{Language Modes}) before doing this.  Also, note
29604 that this command replaces a linear region of text (as grabbed by
29605 @kbd{M-# g}), not a rectangle (as grabbed by @kbd{M-# r}).
29607 If the editing buffer is in overwrite (as opposed to insert) mode,
29608 and the @kbd{C-u} prefix was not used, then the yanked number will
29609 overwrite the characters following point rather than being inserted
29610 before those characters.  The usual conventions of overwrite mode
29611 are observed; for example, characters will be inserted at the end of
29612 a line rather than overflowing onto the next line.  Yanking a multi-line
29613 object such as a matrix in overwrite mode overwrites the next @var{n}
29614 lines in the buffer, lengthening or shortening each line as necessary.
29615 Finally, if the thing being yanked is a simple integer or floating-point
29616 number (like @samp{-1.2345e-3}) and the characters following point also
29617 make up such a number, then Calc will replace that number with the new
29618 number, lengthening or shortening as necessary.  The concept of
29619 ``overwrite mode'' has thus been generalized from overwriting characters
29620 to overwriting one complete number with another.
29622 @kindex M-# y
29623 The @kbd{M-# y} key sequence is equivalent to @kbd{y} except that
29624 it can be typed anywhere, not just in Calc.  This provides an easy
29625 way to guarantee that Calc knows which editing buffer you want to use!
29627 @node X Cut and Paste, , Yanking Into Buffers, Kill and Yank
29628 @section X Cut and Paste
29630 @noindent
29631 If you are using Emacs with the X window system, there is an easier
29632 way to move small amounts of data into and out of the calculator:
29633 Use the mouse-oriented cut and paste facilities of X.
29635 The default bindings for a three-button mouse cause the left button
29636 to move the Emacs cursor to the given place, the right button to
29637 select the text between the cursor and the clicked location, and
29638 the middle button to yank the selection into the buffer at the
29639 clicked location.  So, if you have a Calc window and an editing
29640 window on your Emacs screen, you can use left-click/right-click
29641 to select a number, vector, or formula from one window, then
29642 middle-click to paste that value into the other window.  When you
29643 paste text into the Calc window, Calc interprets it as an algebraic
29644 entry.  It doesn't matter where you click in the Calc window; the
29645 new value is always pushed onto the top of the stack.
29647 The @code{xterm} program that is typically used for general-purpose
29648 shell windows in X interprets the mouse buttons in the same way.
29649 So you can use the mouse to move data between Calc and any other
29650 Unix program.  One nice feature of @code{xterm} is that a double
29651 left-click selects one word, and a triple left-click selects a
29652 whole line.  So you can usually transfer a single number into Calc
29653 just by double-clicking on it in the shell, then middle-clicking
29654 in the Calc window.
29656 @node Keypad Mode, Embedded Mode, Kill and Yank, Top
29657 @chapter Keypad Mode
29659 @noindent
29660 @kindex M-# k
29661 @pindex calc-keypad
29662 The @kbd{M-# k} (@code{calc-keypad}) command starts the Calculator
29663 and displays a picture of a calculator-style keypad.  If you are using
29664 the X window system, you can click on any of the ``keys'' in the
29665 keypad using the left mouse button to operate the calculator.
29666 The original window remains the selected window; in Keypad mode
29667 you can type in your file while simultaneously performing
29668 calculations with the mouse.
29670 @pindex full-calc-keypad
29671 If you have used @kbd{M-# b} first, @kbd{M-# k} instead invokes
29672 the @code{full-calc-keypad} command, which takes over the whole
29673 Emacs screen and displays the keypad, the Calc stack, and the Calc
29674 trail all at once.  This mode would normally be used when running
29675 Calc standalone (@pxref{Standalone Operation}).
29677 If you aren't using the X window system, you must switch into
29678 the @samp{*Calc Keypad*} window, place the cursor on the desired
29679 ``key,'' and type @key{SPC} or @key{RET}.  If you think this
29680 is easier than using Calc normally, go right ahead.
29682 Calc commands are more or less the same in Keypad mode.  Certain
29683 keypad keys differ slightly from the corresponding normal Calc
29684 keystrokes; all such deviations are described below.
29686 Keypad mode includes many more commands than will fit on the keypad
29687 at once.  Click the right mouse button [@code{calc-keypad-menu}]
29688 to switch to the next menu.  The bottom five rows of the keypad
29689 stay the same; the top three rows change to a new set of commands.
29690 To return to earlier menus, click the middle mouse button
29691 [@code{calc-keypad-menu-back}] or simply advance through the menus
29692 until you wrap around.  Typing @key{TAB} inside the keypad window
29693 is equivalent to clicking the right mouse button there.
29695 You can always click the @key{EXEC} button and type any normal
29696 Calc key sequence.  This is equivalent to switching into the
29697 Calc buffer, typing the keys, then switching back to your
29698 original buffer.
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
29708 @node Keypad Main Menu, Keypad Functions Menu, Keypad Mode, Keypad Mode
29709 @section Main Menu
29711 @smallexample
29712 @group
29713 |----+-----Calc 2.1------+----1
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 |-----+-----+-----+-----+-----+
29730 @end group
29731 @end smallexample
29733 @noindent
29734 This is the menu that appears the first time you start Keypad mode.
29735 It will show up in a vertical window on the right side of your screen.
29736 Above this menu is the traditional Calc stack display.  On a 24-line
29737 screen you will be able to see the top three stack entries.
29739 The ten digit keys, decimal point, and @key{EEX} key are used for
29740 entering numbers in the obvious way.  @key{EEX} begins entry of an
29741 exponent in scientific notation.  Just as with regular Calc, the
29742 number is pushed onto the stack as soon as you press @key{ENTER}
29743 or any other function key.
29745 The @key{+/-} key corresponds to normal Calc's @kbd{n} key.  During
29746 numeric entry it changes the sign of the number or of the exponent.
29747 At other times it changes the sign of the number on the top of the
29748 stack.
29750 The @key{INV} and @key{HYP} keys modify other keys.  As well as
29751 having the effects described elsewhere in this manual, Keypad mode
29752 defines several other ``inverse'' operations.  These are described
29753 below and in the following sections.
29755 The @key{ENTER} key finishes the current numeric entry, or otherwise
29756 duplicates the top entry on the stack.
29758 The @key{UNDO} key undoes the most recent Calc operation.
29759 @kbd{INV UNDO} is the ``redo'' command, and @kbd{HYP UNDO} is
29760 ``last arguments'' (@kbd{M-@key{RET}}).
29762 The @key{<-} key acts as a ``backspace'' during numeric entry.
29763 At other times it removes the top stack entry.  @kbd{INV <-}
29764 clears the entire stack.  @kbd{HYP <-} takes an integer from
29765 the stack, then removes that many additional stack elements.
29767 The @key{EXEC} key prompts you to enter any keystroke sequence
29768 that would normally work in Calc mode.  This can include a
29769 numeric prefix if you wish.  It is also possible simply to
29770 switch into the Calc window and type commands in it; there is
29771 nothing ``magic'' about this window when Keypad mode is active.
29773 The other keys in this display perform their obvious calculator
29774 functions.  @key{CLN2} rounds the top-of-stack by temporarily
29775 reducing the precision by 2 digits.  @key{FLT} converts an
29776 integer or fraction on the top of the stack to floating-point.
29778 The @key{INV} and @key{HYP} keys combined with several of these keys
29779 give you access to some common functions even if the appropriate menu
29780 is not displayed.  Obviously you don't need to learn these keys
29781 unless you find yourself wasting time switching among the menus.
29783 @table @kbd
29784 @item INV +/-
29785 is the same as @key{1/x}.
29786 @item INV +
29787 is the same as @key{SQRT}.
29788 @item INV -
29789 is the same as @key{CONJ}.
29790 @item INV *
29791 is the same as @key{y^x}.
29792 @item INV /
29793 is the same as @key{INV y^x} (the @expr{x}th root of @expr{y}).
29794 @item HYP/INV 1
29795 are the same as @key{SIN} / @kbd{INV SIN}.
29796 @item HYP/INV 2
29797 are the same as @key{COS} / @kbd{INV COS}.
29798 @item HYP/INV 3
29799 are the same as @key{TAN} / @kbd{INV TAN}.
29800 @item INV/HYP 4
29801 are the same as @key{LN} / @kbd{HYP LN}.
29802 @item INV/HYP 5
29803 are the same as @key{EXP} / @kbd{HYP EXP}.
29804 @item INV 6
29805 is the same as @key{ABS}.
29806 @item INV 7
29807 is the same as @key{RND} (@code{calc-round}).
29808 @item INV 8
29809 is the same as @key{CLN2}.
29810 @item INV 9
29811 is the same as @key{FLT} (@code{calc-float}).
29812 @item INV 0
29813 is the same as @key{IMAG}.
29814 @item INV .
29815 is the same as @key{PREC}.
29816 @item INV ENTER
29817 is the same as @key{SWAP}.
29818 @item HYP ENTER
29819 is the same as @key{RLL3}.
29820 @item INV HYP ENTER
29821 is the same as @key{OVER}.
29822 @item HYP +/-
29823 packs the top two stack entries as an error form.
29824 @item HYP EEX
29825 packs the top two stack entries as a modulo form.
29826 @item INV EEX
29827 creates an interval form; this removes an integer which is one
29828 of 0 @samp{[]}, 1 @samp{[)}, 2 @samp{(]} or 3 @samp{()}, followed
29829 by the two limits of the interval.
29830 @end table
29832 The @kbd{OFF} key turns Calc off; typing @kbd{M-# k} or @kbd{M-# M-#}
29833 again has the same effect.  This is analogous to typing @kbd{q} or
29834 hitting @kbd{M-# c} again in the normal calculator.  If Calc is
29835 running standalone (the @code{full-calc-keypad} command appeared in the
29836 command line that started Emacs), then @kbd{OFF} is replaced with
29837 @kbd{EXIT}; clicking on this actually exits Emacs itself.
29839 @node Keypad Functions Menu, Keypad Binary Menu, Keypad Main Menu, Keypad Mode
29840 @section Functions Menu
29842 @smallexample
29843 @group
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 |----+----+----+----+----+----|
29851 @end group
29852 @end smallexample
29854 @noindent
29855 This menu provides various operations from the @kbd{f} and @kbd{k}
29856 prefix keys.
29858 @key{IMAG} multiplies the number on the stack by the imaginary
29859 number @expr{i = (0, 1)}.
29861 @key{RE} extracts the real part a complex number.  @kbd{INV RE}
29862 extracts the imaginary part.
29864 @key{RAND} takes a number from the top of the stack and computes
29865 a random number greater than or equal to zero but less than that
29866 number.  (@xref{Random Numbers}.)  @key{RAGN} is the ``random
29867 again'' command; it computes another random number using the
29868 same limit as last time.
29870 @key{INV GCD} computes the LCM (least common multiple) function.
29872 @key{INV FACT} is the gamma function.  
29873 @texline @math{\Gamma(x) = (x-1)!}.
29874 @infoline @expr{gamma(x) = (x-1)!}.
29876 @key{PERM} is the number-of-permutations function, which is on the
29877 @kbd{H k c} key in normal Calc.
29879 @key{NXTP} finds the next prime after a number.  @kbd{INV NXTP}
29880 finds the previous prime.
29882 @node Keypad Binary Menu, Keypad Vectors Menu, Keypad Functions Menu, Keypad Mode
29883 @section Binary Menu
29885 @smallexample
29886 @group
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 |----+----+----+----+----+----|
29894 @end group
29895 @end smallexample
29897 @noindent
29898 The keys in this menu perform operations on binary integers.
29899 Note that both logical and arithmetic right-shifts are provided.
29900 @key{INV LSH} rotates one bit to the left.
29902 The ``difference'' function (normally on @kbd{b d}) is on @key{INV AND}.
29903 The ``clip'' function (normally on @w{@kbd{b c}}) is on @key{INV NOT}.
29905 The @key{DEC}, @key{HEX}, @key{OCT}, and @key{BIN} keys select the
29906 current radix for display and entry of numbers:  Decimal, hexadecimal,
29907 octal, or binary.  The six letter keys @key{A} through @key{F} are used
29908 for entering hexadecimal numbers.
29910 The @key{WSIZ} key displays the current word size for binary operations
29911 and allows you to enter a new word size.  You can respond to the prompt
29912 using either the keyboard or the digits and @key{ENTER} from the keypad.
29913 The initial word size is 32 bits.
29915 @node Keypad Vectors Menu, Keypad Modes Menu, Keypad Binary Menu, Keypad Mode
29916 @section Vectors Menu
29918 @smallexample
29919 @group
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 |----+----+----+----+----+----|
29927 @end group
29928 @end smallexample
29930 @noindent
29931 The keys in this menu operate on vectors and matrices.
29933 @key{PACK} removes an integer @var{n} from the top of the stack;
29934 the next @var{n} stack elements are removed and packed into a vector,
29935 which 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
29938 on the stack as a vector, then use a final @key{PACK} to collect the
29939 rows into a matrix.
29941 @key{UNPK} unpacks the vector on the stack, pushing each of its
29942 components separately.
29944 @key{INDX} removes an integer @var{n}, then builds a vector of
29945 integers from 1 to @var{n}.  @kbd{INV INDX} takes three numbers
29946 from the stack:  The vector size @var{n}, the starting number,
29947 and the increment.  @kbd{BLD} takes an integer @var{n} and any
29948 value @var{x} and builds a vector of @var{n} copies of @var{x}.
29950 @key{IDNT} removes an integer @var{n}, then builds an @var{n}-by-@var{n}
29951 identity matrix.
29953 @key{LEN} replaces a vector by its length, an integer.
29955 @key{...} turns on or off ``abbreviated'' display mode for large vectors.
29957 @key{MINV}, @key{MDET}, @key{MTRN}, and @key{CROSS} are the matrix
29958 inverse, determinant, and transpose, and vector cross product.
29960 @key{SUM} replaces a vector by the sum of its elements.  It is
29961 equivalent 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.
29965 @key{INV SUM} computes the alternating sum of the first element
29966 minus the second, plus the third, minus the fourth, and so on.
29967 @key{INV MAX} computes the minimum of the vector elements.
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.
29973 @key{MAP*} multiplies two vectors elementwise.  It is equivalent
29974 to the @kbd{V M *} command.  @key{MAP^} computes powers elementwise.
29975 The arguments must be vectors of equal length, or one must be a vector
29976 and the other must be a plain number.  For example, @kbd{2 MAP^} squares
29977 all the elements of a vector.
29979 @key{MAP$} maps the formula on the top of the stack across the
29980 vector in the second-to-top position.  If the formula contains
29981 several variables, Calc takes that many vectors starting at the
29982 second-to-top position and matches them to the variables in
29983 alphabetical order.  The result is a vector of the same size as
29984 the input vectors, whose elements are the formula evaluated with
29985 the variables set to the various sets of numbers in those vectors.
29986 For example, you could simulate @key{MAP^} using @key{MAP$} with
29987 the formula @samp{x^y}.
29989 The @kbd{"x"} key pushes the variable name @expr{x} onto the
29990 stack.  To build the formula @expr{x^2 + 6}, you would use the
29991 key sequence @kbd{"x" 2 y^x 6 +}.  This formula would then be
29992 suitable for use with the @key{MAP$} key described above.
29993 With @key{INV}, @key{HYP}, or @key{INV} and @key{HYP}, the
29994 @kbd{"x"} key pushes the variable names @expr{y}, @expr{z}, and
29995 @expr{t}, respectively.
29997 @node Keypad Modes Menu, , Keypad Vectors Menu, Keypad Mode
29998 @section Modes Menu
30000 @smallexample
30001 @group
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 |----+----+----+----+----+----|
30009 @end group
30010 @end smallexample
30012 @noindent
30013 The keys in this menu manipulate modes, variables, and the stack.
30015 The @key{FLT}, @key{FIX}, @key{SCI}, and @key{ENG} keys select
30016 floating-point, fixed-point, scientific, or engineering notation.
30017 @key{FIX} displays two digits after the decimal by default; the
30018 others display full precision.  With the @key{INV} prefix, these
30019 keys pop a number-of-digits argument from the stack.
30021 The @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
30023 well as to the left.
30025 The @key{RAD} and @key{DEG} keys switch between radians and degrees
30026 for trigonometric functions.
30028 The @key{FRAC} key turns Fraction mode on or off.  This affects
30029 whether commands like @kbd{/} with integer arguments produce
30030 fractional or floating-point results.
30032 The @key{POLR} key turns Polar mode on or off, determining whether
30033 polar or rectangular complex numbers are used by default.
30035 The @key{SYMB} key turns Symbolic mode on or off, in which
30036 operations that would produce inexact floating-point results
30037 are left unevaluated as algebraic formulas.
30039 The @key{PREC} key selects the current precision.  Answer with
30040 the keyboard or with the keypad digit and @key{ENTER} keys.
30042 The @key{SWAP} key exchanges the top two stack elements.
30043 The @key{RLL3} key rotates the top three stack elements upwards.
30044 The @key{RLL4} key rotates the top four stack elements upwards.
30045 The @key{OVER} key duplicates the second-to-top stack element.
30047 The @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
30050 variables are not available in Keypad mode.)  You can also use,
30051 for example, @kbd{STO + 3} to add to register 3.
30053 @node Embedded Mode, Programming, Keypad Mode, Top
30054 @chapter Embedded Mode
30056 @noindent
30057 Embedded mode in Calc provides an alternative to copying numbers
30058 and formulas back and forth between editing buffers and the Calc
30059 stack.  In Embedded mode, your editing buffer becomes temporarily
30060 linked to the stack and this copying is taken care of automatically.
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
30070 @node Basic Embedded Mode, More About Embedded Mode, Embedded Mode, Embedded Mode
30071 @section Basic Embedded Mode
30073 @noindent
30074 @kindex M-# e
30075 @pindex calc-embedded
30076 To enter Embedded mode, position the Emacs point (cursor) on a
30077 formula in any buffer and press @kbd{M-# e} (@code{calc-embedded}).
30078 Note that @kbd{M-# e} is not to be used in the Calc stack buffer
30079 like most Calc commands, but rather in regular editing buffers that
30080 are visiting your own files.
30082 Calc will try to guess an appropriate language based on the major mode
30083 of the editing buffer. (@xref{Language Modes}.) If the current buffer is
30084 in @code{latex-mode}, for example, Calc will set its language to La@TeX{}.
30085 Similarly, 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},
30089 and eqn for @code{nroff-mode} (@pxref{Customizable Variables}).  
30090 These can be overridden with Calc's mode
30091 changing commands (@pxref{Mode Settings in Embedded Mode}).  If no
30092 suitable language is available, Calc will continue with its current language.
30094 Calc normally scans backward and forward in the buffer for the
30095 nearest opening and closing @dfn{formula delimiters}.  The simplest
30096 delimiters are blank lines.  Other delimiters that Embedded mode
30097 understands are:
30099 @enumerate
30100 @item
30101 The @TeX{} and La@TeX{} math delimiters @samp{$ $}, @samp{$$ $$},
30102 @samp{\[ \]}, and @samp{\( \)};
30103 @item
30104 Lines beginning with @samp{\begin} and @samp{\end} (except matrix delimiters);
30105 @item
30106 Lines beginning with @samp{@@} (Texinfo delimiters).
30107 @item
30108 Lines beginning with @samp{.EQ} and @samp{.EN} (@dfn{eqn} delimiters);
30109 @item
30110 Lines containing a single @samp{%} or @samp{.\"} symbol and nothing else.
30111 @end enumerate
30113 @xref{Customizing Embedded Mode}, to see how to make Calc recognize
30114 your own favorite delimiters.  Delimiters like @samp{$ $} can appear
30115 on their own separate lines or in-line with the formula.
30117 If you give a positive or negative numeric prefix argument, Calc
30118 instead uses the current point as one end of the formula, and includes
30119 that many lines forward or backward (respectively, including the current
30120 line). Explicit delimiters are not necessary in this case.
30122 With a prefix argument of zero, Calc uses the current region (delimited
30123 by point and mark) instead of formula delimiters.  With a prefix
30124 argument of @kbd{C-u} only, Calc uses the current line as the formula.
30126 @kindex M-# w
30127 @pindex calc-embedded-word
30128 The @kbd{M-# w} (@code{calc-embedded-word}) command will start Embedded
30129 mode on the current ``word''; in this case Calc will scan for the first
30130 non-numeric character (i.e., the first character that is not a digit,
30131 sign, decimal point, or upper- or lower-case @samp{e}) forward and
30132 backward to delimit the formula.
30134 When you enable Embedded mode for a formula, Calc reads the text
30135 between the delimiters and tries to interpret it as a Calc formula.
30136 Calc can generally identify @TeX{} formulas and
30137 Big-style formulas even if the language mode is wrong.  If Calc
30138 can't make sense of the formula, it beeps and refuses to enter
30139 Embedded mode.  But if the current language is wrong, Calc can
30140 sometimes parse the formula successfully (but incorrectly);
30141 for example, the C expression @samp{atan(a[1])} can be parsed
30142 in Normal language mode, but the @code{atan} won't correspond to
30143 the built-in @code{arctan} function, and the @samp{a[1]} will be
30144 interpreted as @samp{a} times the vector @samp{[1]}!
30146 If you press @kbd{M-# e} or @kbd{M-# w} to activate an embedded
30147 formula which is blank, say with the cursor on the space between
30148 the two delimiters @samp{$ $}, Calc will immediately prompt for
30149 an algebraic entry.
30151 Only one formula in one buffer can be enabled at a time.  If you
30152 move to another area of the current buffer and give Calc commands,
30153 Calc turns Embedded mode off for the old formula and then tries
30154 to restart Embedded mode at the new position.  Other buffers are
30155 not affected by Embedded mode.
30157 When Embedded mode begins, Calc pushes the current formula onto
30158 the stack.  No Calc stack window is created; however, Calc copies
30159 the top-of-stack position into the original buffer at all times.
30160 You can create a Calc window by hand with @kbd{M-# o} if you
30161 find you need to see the entire stack.
30163 For example, typing @kbd{M-# e} while somewhere in the formula
30164 @samp{n>2} in the following line enables Embedded mode on that
30165 inequality:
30167 @example
30168 We define $F_n = F_(n-1)+F_(n-2)$ for all $n>2$.
30169 @end example
30171 @noindent
30172 The formula @expr{n>2} will be pushed onto the Calc stack, and
30173 the top of stack will be copied back into the editing buffer.
30174 This means that spaces will appear around the @samp{>} symbol
30175 to match Calc's usual display style:
30177 @example
30178 We define $F_n = F_(n-1)+F_(n-2)$ for all $n > 2$.
30179 @end example
30181 @noindent
30182 No spaces have appeared around the @samp{+} sign because it's
30183 in a different formula, one which we have not yet touched with
30184 Embedded mode.
30186 Now that Embedded mode is enabled, keys you type in this buffer
30187 are interpreted as Calc commands.  At this point we might use
30188 the ``commute'' command @kbd{j C} to reverse the inequality.
30189 This is a selection-based command for which we first need to
30190 move the cursor onto the operator (@samp{>} in this case) that
30191 needs to be commuted.
30193 @example
30194 We define $F_n = F_(n-1)+F_(n-2)$ for all $2 < n$.
30195 @end example
30197 The @kbd{M-# o} command is a useful way to open a Calc window
30198 without actually selecting that window.  Giving this command
30199 verifies that @samp{2 < n} is also on the Calc stack.  Typing
30200 @kbd{17 @key{RET}} would produce:
30202 @example
30203 We define $F_n = F_(n-1)+F_(n-2)$ for all $17$.
30204 @end example
30206 @noindent
30207 with @samp{2 < n} and @samp{17} on the stack; typing @key{TAB}
30208 at this point will exchange the two stack values and restore
30209 @samp{2 < n} to the embedded formula.  Even though you can't
30210 normally see the stack in Embedded mode, it is still there and
30211 it still operates in the same way.  But, as with old-fashioned
30212 RPN calculators, you can only see the value at the top of the
30213 stack at any given time (unless you use @kbd{M-# o}).
30215 Typing @kbd{M-# e} again turns Embedded mode off.  The Calc
30216 window reveals that the formula @w{@samp{2 < n}} is automatically
30217 removed from the stack, but the @samp{17} is not.  Entering
30218 Embedded mode always pushes one thing onto the stack, and
30219 leaving Embedded mode always removes one thing.  Anything else
30220 that happens on the stack is entirely your business as far as
30221 Embedded mode is concerned.
30223 If you press @kbd{M-# e} in the wrong place by accident, it is
30224 possible that Calc will be able to parse the nearby text as a
30225 formula and will mangle that text in an attempt to redisplay it
30226 ``properly'' in the current language mode.  If this happens,
30227 press @kbd{M-# e} again to exit Embedded mode, then give the
30228 regular Emacs ``undo'' command (@kbd{C-_} or @kbd{C-x u}) to put
30229 the text back the way it was before Calc edited it.  Note that Calc's
30230 own Undo command (typed before you turn Embedded mode back off)
30231 will not do you any good, because as far as Calc is concerned
30232 you haven't done anything with this formula yet.
30234 @node More About Embedded Mode, Assignments in Embedded Mode, Basic Embedded Mode, Embedded Mode
30235 @section More About Embedded Mode
30237 @noindent
30238 When Embedded mode ``activates'' a formula, i.e., when it examines
30239 the formula for the first time since the buffer was created or
30240 loaded, Calc tries to sense the language in which the formula was
30241 written.  If the formula contains any La@TeX{}-like @samp{\} sequences,
30242 it is parsed (i.e., read) in La@TeX{} mode.  If the formula appears to
30243 be written in multi-line Big mode, it is parsed in Big mode.  Otherwise,
30244 it is parsed according to the current language mode.
30246 Note that Calc does not change the current language mode according
30247 the formula it reads in.  Even though it can read a La@TeX{} formula when
30248 not in La@TeX{} mode, it will immediately rewrite this formula using
30249 whatever language mode is in effect.
30251 @tex
30252 \bigskip
30253 @end tex
30255 @kindex d p
30256 @pindex calc-show-plain
30257 Calc's parser is unable to read certain kinds of formulas.  For
30258 example, with @kbd{v ]} (@code{calc-matrix-brackets}) you can
30259 specify matrix display styles which the parser is unable to
30260 recognize as matrices.  The @kbd{d p} (@code{calc-show-plain})
30261 command turns on a mode in which a ``plain'' version of a
30262 formula is placed in front of the fully-formatted version.
30263 When Calc reads a formula that has such a plain version in
30264 front, it reads the plain version and ignores the formatted
30265 version.
30267 Plain formulas are preceded and followed by @samp{%%%} signs
30268 by default.  This notation has the advantage that the @samp{%}
30269 character begins a comment in @TeX{} and La@TeX{}, so if your formula is 
30270 embedded in a @TeX{} or La@TeX{} document its plain version will be
30271 invisible in the final printed copy.  Certain major modes have different
30272 delimiters to ensure that the ``plain'' version will be 
30273 in a comment for those modes, also.  
30274 See @ref{Customizing Embedded Mode} to see how to change the ``plain''
30275 formula delimiters. 
30277 There are several notations which Calc's parser for ``big''
30278 formatted formulas can't yet recognize.  In particular, it can't
30279 read the large symbols for @code{sum}, @code{prod}, and @code{integ},
30280 and it can't handle @samp{=>} with the righthand argument omitted.
30281 Also, Calc won't recognize special formats you have defined with
30282 the @kbd{Z C} command (@pxref{User-Defined Compositions}).  In
30283 these cases it is important to use ``plain'' mode to make sure
30284 Calc will be able to read your formula later.
30286 Another example where ``plain'' mode is important is if you have
30287 specified a float mode with few digits of precision.  Normally
30288 any digits that are computed but not displayed will simply be
30289 lost when you save and re-load your embedded buffer, but ``plain''
30290 mode allows you to make sure that the complete number is present
30291 in the file as well as the rounded-down number.
30293 @tex
30294 \bigskip
30295 @end tex
30297 Embedded buffers remember active formulas for as long as they
30298 exist in Emacs memory.  Suppose you have an embedded formula
30299 which is @cpi{} to the normal 12 decimal places, and then
30300 type @w{@kbd{C-u 5 d n}} to display only five decimal places.
30301 If you then type @kbd{d n}, all 12 places reappear because the
30302 full number is still there on the Calc stack.  More surprisingly,
30303 even if you exit Embedded mode and later re-enter it for that
30304 formula, typing @kbd{d n} will restore all 12 places because
30305 each buffer remembers all its active formulas.  However, if you
30306 save the buffer in a file and reload it in a new Emacs session,
30307 all non-displayed digits will have been lost unless you used
30308 ``plain'' mode.
30310 @tex
30311 \bigskip
30312 @end tex
30314 In some applications of Embedded mode, you will want to have a
30315 sequence of copies of a formula that show its evolution as you
30316 work on it.  For example, you might want to have a sequence
30317 like this in your file (elaborating here on the example from
30318 the ``Getting Started'' chapter):
30320 @smallexample
30321 The derivative of
30323                               ln(ln(x))
30327                   @r{(the derivative of }ln(ln(x))@r{)}
30329 whose value at x = 2 is
30331                             @r{(the value)}
30333 and at x = 3 is
30335                             @r{(the value)}
30336 @end smallexample
30338 @kindex M-# d
30339 @pindex calc-embedded-duplicate
30340 The @kbd{M-# d} (@code{calc-embedded-duplicate}) command is a
30341 handy way to make sequences like this.  If you type @kbd{M-# d},
30342 the formula under the cursor (which may or may not have Embedded
30343 mode enabled for it at the time) is copied immediately below and
30344 Embedded mode is then enabled for that copy.
30346 For this example, you would start with just
30348 @smallexample
30349 The derivative of
30351                               ln(ln(x))
30352 @end smallexample
30354 @noindent
30355 and press @kbd{M-# d} with the cursor on this formula.  The result
30358 @smallexample
30359 The derivative of
30361                               ln(ln(x))
30364                               ln(ln(x))
30365 @end smallexample
30367 @noindent
30368 with the second copy of the formula enabled in Embedded mode.
30369 You can now press @kbd{a d x @key{RET}} to take the derivative, and
30370 @kbd{M-# d M-# d} to make two more copies of the derivative.
30371 To complete the computations, type @kbd{3 s l x @key{RET}} to evaluate
30372 the last formula, then move up to the second-to-last formula
30373 and type @kbd{2 s l x @key{RET}}.
30375 Finally, you would want to press @kbd{M-# e} to exit Embedded
30376 mode, then go up and insert the necessary text in between the
30377 various formulas and numbers.
30379 @tex
30380 \bigskip
30381 @end tex
30383 @kindex M-# f
30384 @kindex M-# '
30385 @pindex calc-embedded-new-formula
30386 The @kbd{M-# f} (@code{calc-embedded-new-formula}) command
30387 creates a new embedded formula at the current point.  It inserts
30388 some default delimiters, which are usually just blank lines,
30389 and then does an algebraic entry to get the formula (which is
30390 then enabled for Embedded mode).  This is just shorthand for
30391 typing the delimiters yourself, positioning the cursor between
30392 the new delimiters, and pressing @kbd{M-# e}.  The key sequence
30393 @kbd{M-# '} is equivalent to @kbd{M-# f}.
30395 @kindex M-# n
30396 @kindex M-# p
30397 @pindex calc-embedded-next
30398 @pindex calc-embedded-previous
30399 The @kbd{M-# n} (@code{calc-embedded-next}) and @kbd{M-# p}
30400 (@code{calc-embedded-previous}) commands move the cursor to the
30401 next or previous active embedded formula in the buffer.  They
30402 can take positive or negative prefix arguments to move by several
30403 formulas.  Note that these commands do not actually examine the
30404 text of the buffer looking for formulas; they only see formulas
30405 which have previously been activated in Embedded mode.  In fact,
30406 @kbd{M-# n} and @kbd{M-# p} are a useful way to tell which
30407 embedded formulas are currently active.  Also, note that these
30408 commands do not enable Embedded mode on the next or previous
30409 formula, they just move the cursor.  (By the way, @kbd{M-# n} is
30410 not as awkward to type as it may seem, because @kbd{M-#} ignores
30411 Shift and Meta on the second keystroke:  @kbd{M-# M-N} can be typed
30412 by holding down Shift and Meta and alternately typing two keys.)
30414 @kindex M-# `
30415 @pindex calc-embedded-edit
30416 The @kbd{M-# `} (@code{calc-embedded-edit}) command edits the
30417 embedded formula at the current point as if by @kbd{`} (@code{calc-edit}).
30418 Embedded mode does not have to be enabled for this to work.  Press
30419 @kbd{C-c C-c} to finish the edit, or @kbd{C-x k} to cancel.
30421 @node Assignments in Embedded Mode, Mode Settings in Embedded Mode, More About Embedded Mode, Embedded Mode
30422 @section Assignments in Embedded Mode
30424 @noindent
30425 The @samp{:=} (assignment) and @samp{=>} (``evaluates-to'') operators
30426 are especially useful in Embedded mode.  They allow you to make
30427 a definition in one formula, then refer to that definition in
30428 other formulas embedded in the same buffer.
30430 An embedded formula which is an assignment to a variable, as in
30432 @example
30433 foo := 5
30434 @end example
30436 @noindent
30437 records @expr{5} as the stored value of @code{foo} for the
30438 purposes of Embedded mode operations in the current buffer.  It
30439 does @emph{not} actually store @expr{5} as the ``global'' value
30440 of @code{foo}, however.  Regular Calc operations, and Embedded
30441 formulas in other buffers, will not see this assignment.
30443 One way to use this assigned value is simply to create an
30444 Embedded formula elsewhere that refers to @code{foo}, and to press
30445 @kbd{=} in that formula.  However, this permanently replaces the
30446 @code{foo} in the formula with its current value.  More interesting
30447 is to use @samp{=>} elsewhere:
30449 @example
30450 foo + 7 => 12
30451 @end example
30453 @xref{Evaluates-To Operator}, for a general discussion of @samp{=>}.
30455 If you move back and change the assignment to @code{foo}, any
30456 @samp{=>} formulas which refer to it are automatically updated.
30458 @example
30459 foo := 17
30461 foo + 7 => 24
30462 @end example
30464 The obvious question then is, @emph{how} can one easily change the
30465 assignment to @code{foo}?  If you simply select the formula in
30466 Embedded mode and type 17, the assignment itself will be replaced
30467 by the 17.  The effect on the other formula will be that the
30468 variable @code{foo} becomes unassigned:
30470 @example
30473 foo + 7 => foo + 7
30474 @end example
30476 The right thing to do is first to use a selection command (@kbd{j 2}
30477 will do the trick) to select the righthand side of the assignment.
30478 Then, @kbd{17 @key{TAB} @key{DEL}} will swap the 17 into place (@pxref{Selecting
30479 Subformulas}, to see how this works).
30481 @kindex M-# j
30482 @pindex calc-embedded-select
30483 The @kbd{M-# j} (@code{calc-embedded-select}) command provides an
30484 easy way to operate on assignments.  It is just like @kbd{M-# e},
30485 except that if the enabled formula is an assignment, it uses
30486 @kbd{j 2} to select the righthand side.  If the enabled formula
30487 is an evaluates-to, it uses @kbd{j 1} to select the lefthand side.
30488 A formula can also be a combination of both:
30490 @example
30491 bar := foo + 3 => 20
30492 @end example
30494 @noindent
30495 in which case @kbd{M-# j} will select the middle part (@samp{foo + 3}).
30497 The formula is automatically deselected when you leave Embedded
30498 mode.
30500 @kindex M-# u
30501 @kindex M-# =
30502 @pindex calc-embedded-update-formula
30503 Another way to change the assignment to @code{foo} would simply be
30504 to edit the number using regular Emacs editing rather than Embedded
30505 mode.  Then, we have to find a way to get Embedded mode to notice
30506 the change.  The @kbd{M-# u} or @kbd{M-# =}
30507 (@code{calc-embedded-update-formula}) command is a convenient way
30508 to do this.
30510 @example
30511 foo := 6
30513 foo + 7 => 13
30514 @end example
30516 Pressing @kbd{M-# u} is much like pressing @kbd{M-# e = M-# e}, that
30517 is, temporarily enabling Embedded mode for the formula under the
30518 cursor and then evaluating it with @kbd{=}.  But @kbd{M-# u} does
30519 not actually use @kbd{M-# e}, and in fact another formula somewhere
30520 else can be enabled in Embedded mode while you use @kbd{M-# u} and
30521 that formula will not be disturbed.
30523 With a numeric prefix argument, @kbd{M-# u} updates all active
30524 @samp{=>} formulas in the buffer.  Formulas which have not yet
30525 been activated in Embedded mode, and formulas which do not have
30526 @samp{=>} as their top-level operator, are not affected by this.
30527 (This is useful only if you have used @kbd{m C}; see below.)
30529 With a plain @kbd{C-u} prefix, @kbd{C-u M-# u} updates only in the
30530 region between mark and point rather than in the whole buffer.
30532 @kbd{M-# u} is also a handy way to activate a formula, such as an
30533 @samp{=>} formula that has freshly been typed in or loaded from a
30534 file.
30536 @kindex M-# a
30537 @pindex calc-embedded-activate
30538 The @kbd{M-# a} (@code{calc-embedded-activate}) command scans
30539 through the current buffer and activates all embedded formulas
30540 that contain @samp{:=} or @samp{=>} symbols.  This does not mean
30541 that Embedded mode is actually turned on, but only that the
30542 formulas' positions are registered with Embedded mode so that
30543 the @samp{=>} values can be properly updated as assignments are
30544 changed.
30546 It is a good idea to type @kbd{M-# a} right after loading a file
30547 that uses embedded @samp{=>} operators.  Emacs includes a nifty
30548 ``buffer-local variables'' feature that you can use to do this
30549 automatically.  The idea is to place near the end of your file
30550 a few lines that look like this:
30552 @example
30553 --- Local Variables: ---
30554 --- eval:(calc-embedded-activate) ---
30555 --- End: ---
30556 @end example
30558 @noindent
30559 where the leading and trailing @samp{---} can be replaced by
30560 any suitable strings (which must be the same on all three lines)
30561 or omitted altogether; in a @TeX{} or La@TeX{} file, @samp{%} would be a good
30562 leading string and no trailing string would be necessary.  In a
30563 C program, @samp{/*} and @samp{*/} would be good leading and
30564 trailing strings.
30566 When Emacs loads a file into memory, it checks for a Local Variables
30567 section like this one at the end of the file.  If it finds this
30568 section, it does the specified things (in this case, running
30569 @kbd{M-# a} automatically) before editing of the file begins.
30570 The Local Variables section must be within 3000 characters of the
30571 end of the file for Emacs to find it, and it must be in the last
30572 page of the file if the file has any page separators.
30573 @xref{File Variables, , Local Variables in Files, emacs, the
30574 Emacs manual}.
30576 Note that @kbd{M-# a} does not update the formulas it finds.
30577 To do this, type, say, @kbd{M-1 M-# u} after @w{@kbd{M-# a}}.
30578 Generally this should not be a problem, though, because the
30579 formulas will have been up-to-date already when the file was
30580 saved.
30582 Normally, @kbd{M-# a} activates all the formulas it finds, but
30583 any previous active formulas remain active as well.  With a
30584 positive numeric prefix argument, @kbd{M-# a} first deactivates
30585 all current active formulas, then actives the ones it finds in
30586 its scan of the buffer.  With a negative prefix argument,
30587 @kbd{M-# a} simply deactivates all formulas.
30589 Embedded mode has two symbols, @samp{Active} and @samp{~Active},
30590 which it puts next to the major mode name in a buffer's mode line.
30591 It puts @samp{Active} if it has reason to believe that all
30592 formulas in the buffer are active, because you have typed @kbd{M-# a}
30593 and Calc has not since had to deactivate any formulas (which can
30594 happen if Calc goes to update an @samp{=>} formula somewhere because
30595 a variable changed, and finds that the formula is no longer there
30596 due to some kind of editing outside of Embedded mode).  Calc puts
30597 @samp{~Active} in the mode line if some, but probably not all,
30598 formulas in the buffer are active.  This happens if you activate
30599 a few formulas one at a time but never use @kbd{M-# a}, or if you
30600 used @kbd{M-# a} but then Calc had to deactivate a formula
30601 because it lost track of it.  If neither of these symbols appears
30602 in the mode line, no embedded formulas are active in the buffer
30603 (e.g., before Embedded mode has been used, or after a @kbd{M-- M-# a}).
30605 Embedded formulas can refer to assignments both before and after them
30606 in the buffer.  If there are several assignments to a variable, the
30607 nearest preceding assignment is used if there is one, otherwise the
30608 following assignment is used.
30610 @example
30611 x => 1
30613 x := 1
30615 x => 1
30617 x := 2
30619 x => 2
30620 @end example
30622 As well as simple variables, you can also assign to subscript
30623 expressions of the form @samp{@var{var}_@var{number}} (as in
30624 @code{x_0}), or @samp{@var{var}_@var{var}} (as in @code{x_max}).
30625 Assignments to other kinds of objects can be represented by Calc,
30626 but the automatic linkage between assignments and references works
30627 only for plain variables and these two kinds of subscript expressions.
30629 If there are no assignments to a given variable, the global
30630 stored value for the variable is used (@pxref{Storing Variables}),
30631 or, if no value is stored, the variable is left in symbolic form.
30632 Note that global stored values will be lost when the file is saved
30633 and loaded in a later Emacs session, unless you have used the
30634 @kbd{s p} (@code{calc-permanent-variable}) command to save them;
30635 @pxref{Operations on Variables}.
30637 The @kbd{m C} (@code{calc-auto-recompute}) command turns automatic
30638 recomputation of @samp{=>} forms on and off.  If you turn automatic
30639 recomputation off, you will have to use @kbd{M-# u} to update these
30640 formulas manually after an assignment has been changed.  If you
30641 plan to change several assignments at once, it may be more efficient
30642 to type @kbd{m C}, change all the assignments, then use @kbd{M-1 M-# u}
30643 to update the entire buffer afterwards.  The @kbd{m C} command also
30644 controls @samp{=>} formulas on the stack; @pxref{Evaluates-To
30645 Operator}.  When you turn automatic recomputation back on, the
30646 stack will be updated but the Embedded buffer will not; you must
30647 use @kbd{M-# u} to update the buffer by hand.
30649 @node Mode Settings in Embedded Mode, Customizing Embedded Mode, Assignments in Embedded Mode, Embedded Mode
30650 @section Mode Settings in Embedded Mode
30652 @kindex m e
30653 @pindex calc-embedded-preserve-modes
30654 @noindent
30655 The mode settings can be changed while Calc is in embedded mode, but
30656 by default they will revert to their original values when embedded mode
30657 is ended. However, the modes saved when the mode-recording mode is
30658 @code{Save} (see below) and the modes in effect when the @kbd{m e}
30659 (@code{calc-embedded-preserve-modes}) command is given
30660 will be preserved when embedded mode is ended.
30662 Embedded mode has a rather complicated mechanism for handling mode
30663 settings in Embedded formulas.  It is possible to put annotations
30664 in the file that specify mode settings either global to the entire
30665 file or local to a particular formula or formulas.  In the latter
30666 case, different modes can be specified for use when a formula
30667 is the enabled Embedded mode formula.
30669 When you give any mode-setting command, like @kbd{m f} (for Fraction
30670 mode) or @kbd{d s} (for scientific notation), Embedded mode adds
30671 a line like the following one to the file just before the opening
30672 delimiter of the formula.
30674 @example
30675 % [calc-mode: fractions: t]
30676 % [calc-mode: float-format: (sci 0)]
30677 @end example
30679 When Calc interprets an embedded formula, it scans the text before
30680 the formula for mode-setting annotations like these and sets the
30681 Calc buffer to match these modes.  Modes not explicitly described
30682 in the file are not changed.  Calc scans all the way to the top of
30683 the file, or up to a line of the form
30685 @example
30686 % [calc-defaults]
30687 @end example
30689 @noindent
30690 which you can insert at strategic places in the file if this backward
30691 scan is getting too slow, or just to provide a barrier between one
30692 ``zone'' of mode settings and another.
30694 If the file contains several annotations for the same mode, the
30695 closest one before the formula is used.  Annotations after the
30696 formula are never used (except for global annotations, described
30697 below).
30699 The scan does not look for the leading @samp{% }, only for the
30700 square brackets and the text they enclose.  In fact, the leading
30701 characters are different for different major modes.  You can edit the
30702 mode annotations to a style that works better in context if you wish.
30703 @xref{Customizing Embedded Mode}, to see how to change the style
30704 that Calc uses when it generates the annotations.  You can write
30705 mode annotations into the file yourself if you know the syntax;
30706 the easiest way to find the syntax for a given mode is to let
30707 Calc write the annotation for it once and see what it does.
30709 If you give a mode-changing command for a mode that already has
30710 a suitable annotation just above the current formula, Calc will
30711 modify that annotation rather than generating a new, conflicting
30712 one.
30714 Mode annotations have three parts, separated by colons.  (Spaces
30715 after the colons are optional.)  The first identifies the kind
30716 of mode setting, the second is a name for the mode itself, and
30717 the third is the value in the form of a Lisp symbol, number,
30718 or list.  Annotations with unrecognizable text in the first or
30719 second parts are ignored.  The third part is not checked to make
30720 sure the value is of a valid type or range; if you write an
30721 annotation by hand, be sure to give a proper value or results
30722 will be unpredictable.  Mode-setting annotations are case-sensitive.
30724 While Embedded mode is enabled, the word @code{Local} appears in
30725 the mode line.  This is to show that mode setting commands generate
30726 annotations that are ``local'' to the current formula or set of
30727 formulas.  The @kbd{m R} (@code{calc-mode-record-mode}) command
30728 causes Calc to generate different kinds of annotations.  Pressing
30729 @kbd{m R} repeatedly cycles through the possible modes.
30731 @code{LocEdit} and @code{LocPerm} modes generate annotations
30732 that look like this, respectively:
30734 @example
30735 % [calc-edit-mode: float-format: (sci 0)]
30736 % [calc-perm-mode: float-format: (sci 5)]
30737 @end example
30739 The first kind of annotation will be used only while a formula
30740 is enabled in Embedded mode.  The second kind will be used only
30741 when the formula is @emph{not} enabled.  (Whether the formula
30742 is ``active'' or not, i.e., whether Calc has seen this formula
30743 yet, is not relevant here.)
30745 @code{Global} mode generates an annotation like this at the end
30746 of the file:
30748 @example
30749 % [calc-global-mode: fractions t]
30750 @end example
30752 Global mode annotations affect all formulas throughout the file,
30753 and may appear anywhere in the file.  This allows you to tuck your
30754 mode annotations somewhere out of the way, say, on a new page of
30755 the file, as long as those mode settings are suitable for all
30756 formulas in the file.
30758 Enabling a formula with @kbd{M-# e} causes a fresh scan for local
30759 mode annotations; you will have to use this after adding annotations
30760 above a formula by hand to get the formula to notice them.  Updating
30761 a formula with @kbd{M-# u} will also re-scan the local modes, but
30762 global modes are only re-scanned by @kbd{M-# a}.
30764 Another way that modes can get out of date is if you add a local
30765 mode annotation to a formula that has another formula after it.
30766 In this example, we have used the @kbd{d s} command while the
30767 first of the two embedded formulas is active.  But the second
30768 formula has not changed its style to match, even though by the
30769 rules of reading annotations the @samp{(sci 0)} applies to it, too.
30771 @example
30772 % [calc-mode: float-format: (sci 0)]
30773 1.23e2
30775 456.
30776 @end example
30778 We would have to go down to the other formula and press @kbd{M-# u}
30779 on it in order to get it to notice the new annotation.
30781 Two more mode-recording modes selectable by @kbd{m R} are available
30782 which are also available outside of Embedded mode.  
30783 (@pxref{General Mode Commands}.) They are @code{Save},  in which mode
30784 settings are recorded permanently in your Calc init file (the file given
30785 by the variable @code{calc-settings-file}, typically @file{~/.calc.el})
30786 rather than by annotating the current document, and no-recording
30787 mode (where there is no symbol like @code{Save} or @code{Local} in
30788 the mode line), in which mode-changing commands do not leave any
30789 annotations at all.
30791 When Embedded mode is not enabled, mode-recording modes except
30792 for @code{Save} have no effect.
30794 @node Customizing Embedded Mode, , Mode Settings in Embedded Mode, Embedded Mode
30795 @section Customizing Embedded Mode
30797 @noindent
30798 You can modify Embedded mode's behavior by setting various Lisp
30799 variables described here.  These variables are customizable 
30800 (@pxref{Customizable Variables}), or you can use @kbd{M-x set-variable}
30801 or @kbd{M-x edit-options} to adjust a variable on the fly.
30802 (Another possibility would be to use a file-local variable annotation at
30803 the end of the file; 
30804 @pxref{File Variables, , Local Variables in Files, emacs, the Emacs manual}.)
30805 Many of the variables given mentioned here can be set to depend on the
30806 major mode of the editing buffer (@pxref{Customizable Variables}).
30808 @vindex calc-embedded-open-formula
30809 The @code{calc-embedded-open-formula} variable holds a regular
30810 expression for the opening delimiter of a formula.  @xref{Regexp Search,
30811 , Regular Expression Search, emacs, the Emacs manual}, to see
30812 how regular expressions work.  Basically, a regular expression is a
30813 pattern that Calc can search for.  A regular expression that considers
30814 blank lines, @samp{$}, and @samp{$$} to be opening delimiters is
30815 @code{"\\`\\|^\n\\|\\$\\$?"}.  Just in case the meaning of this
30816 regular expression is not completely plain, let's go through it
30817 in detail.
30819 The surrounding @samp{" "} marks quote the text between them as a
30820 Lisp string.  If you left them off, @code{set-variable} or
30821 @code{edit-options} would try to read the regular expression as a
30822 Lisp program.
30824 The most obvious property of this regular expression is that it
30825 contains indecently many backslashes.  There are actually two levels
30826 of backslash usage going on here.  First, when Lisp reads a quoted
30827 string, all pairs of characters beginning with a backslash are
30828 interpreted as special characters.  Here, @code{\n} changes to a
30829 new-line character, and @code{\\} changes to a single backslash.
30830 So the actual regular expression seen by Calc is
30831 @samp{\`\|^ @r{(newline)} \|\$\$?}.
30833 Regular expressions also consider pairs beginning with backslash
30834 to have special meanings.  Sometimes the backslash is used to quote
30835 a character that otherwise would have a special meaning in a regular
30836 expression, like @samp{$}, which normally means ``end-of-line,''
30837 or @samp{?}, which means that the preceding item is optional.  So
30838 @samp{\$\$?} matches either one or two dollar signs.
30840 The other codes in this regular expression are @samp{^}, which matches
30841 ``beginning-of-line,'' @samp{\|}, which means ``or,'' and @samp{\`},
30842 which matches ``beginning-of-buffer.''  So the whole pattern means
30843 that a formula begins at the beginning of the buffer, or on a newline
30844 that occurs at the beginning of a line (i.e., a blank line), or at
30845 one or two dollar signs.
30847 The default value of @code{calc-embedded-open-formula} looks just
30848 like this example, with several more alternatives added on to
30849 recognize various other common kinds of delimiters.
30851 By the way, the reason to use @samp{^\n} rather than @samp{^$}
30852 or @samp{\n\n}, which also would appear to match blank lines,
30853 is that the former expression actually ``consumes'' only one
30854 newline character as @emph{part of} the delimiter, whereas the
30855 latter expressions consume zero or two newlines, respectively.
30856 The former choice gives the most natural behavior when Calc
30857 must operate on a whole formula including its delimiters.
30859 See the Emacs manual for complete details on regular expressions.
30860 But just for your convenience, here is a list of all characters
30861 which must be quoted with backslash (like @samp{\$}) to avoid
30862 some special interpretation:  @samp{. * + ? [ ] ^ $ \}.  (Note
30863 the backslash in this list; for example, to match @samp{\[} you
30864 must use @code{"\\\\\\["}.  An exercise for the reader is to
30865 account for each of these six backslashes!)
30867 @vindex calc-embedded-close-formula
30868 The @code{calc-embedded-close-formula} variable holds a regular
30869 expression for the closing delimiter of a formula.  A closing
30870 regular expression to match the above example would be
30871 @code{"\\'\\|\n$\\|\\$\\$?"}.  This is almost the same as the
30872 other one, except it now uses @samp{\'} (``end-of-buffer'') and
30873 @samp{\n$} (newline occurring at end of line, yet another way
30874 of describing a blank line that is more appropriate for this
30875 case).
30877 @vindex calc-embedded-open-word
30878 @vindex calc-embedded-close-word
30879 The @code{calc-embedded-open-word} and @code{calc-embedded-close-word}
30880 variables are similar expressions used when you type @kbd{M-# w}
30881 instead of @kbd{M-# e} to enable Embedded mode.
30883 @vindex calc-embedded-open-plain
30884 The @code{calc-embedded-open-plain} variable is a string which
30885 begins a ``plain'' formula written in front of the formatted
30886 formula when @kbd{d p} mode is turned on.  Note that this is an
30887 actual string, not a regular expression, because Calc must be able
30888 to write this string into a buffer as well as to recognize it.
30889 The default string is @code{"%%% "} (note the trailing space), but may
30890 be different for certain major modes.
30892 @vindex calc-embedded-close-plain
30893 The @code{calc-embedded-close-plain} variable is a string which
30894 ends a ``plain'' formula.  The default is @code{" %%%\n"}, but may be
30895 different for different major modes.  Without
30896 the trailing newline here, the first line of a Big mode formula
30897 that followed might be shifted over with respect to the other lines.
30899 @vindex calc-embedded-open-new-formula
30900 The @code{calc-embedded-open-new-formula} variable is a string
30901 which is inserted at the front of a new formula when you type
30902 @kbd{M-# f}.  Its default value is @code{"\n\n"}.  If this
30903 string begins with a newline character and the @kbd{M-# f} is
30904 typed at the beginning of a line, @kbd{M-# f} will skip this
30905 first newline to avoid introducing unnecessary blank lines in
30906 the file.
30908 @vindex calc-embedded-close-new-formula
30909 The @code{calc-embedded-close-new-formula} variable is the corresponding
30910 string which is inserted at the end of a new formula.  Its default
30911 value is also @code{"\n\n"}.  The final newline is omitted by
30912 @w{@kbd{M-# f}} if typed at the end of a line.  (It follows that if
30913 @kbd{M-# f} is typed on a blank line, both a leading opening
30914 newline and a trailing closing newline are omitted.)
30916 @vindex calc-embedded-announce-formula
30917 The @code{calc-embedded-announce-formula} variable is a regular
30918 expression which is sure to be followed by an embedded formula.
30919 The @kbd{M-# a} command searches for this pattern as well as for
30920 @samp{=>} and @samp{:=} operators.  Note that @kbd{M-# a} will
30921 not activate just anything surrounded by formula delimiters; after
30922 all, blank lines are considered formula delimiters by default!
30923 But if your language includes a delimiter which can only occur
30924 actually in front of a formula, you can take advantage of it here.
30925 The default pattern is @code{"%Embed\n\\(% .*\n\\)*"}, but may be
30926 different for different major modes.
30927 This pattern will check for @samp{%Embed} followed by any number of
30928 lines beginning with @samp{%} and a space.  This last is important to
30929 make Calc consider mode annotations part of the pattern, so that the
30930 formula's opening delimiter really is sure to follow the pattern.
30932 @vindex calc-embedded-open-mode
30933 The @code{calc-embedded-open-mode} variable is a string (not a
30934 regular expression) which should precede a mode annotation.
30935 Calc never scans for this string; Calc always looks for the
30936 annotation itself.  But this is the string that is inserted before
30937 the opening bracket when Calc adds an annotation on its own.
30938 The default is @code{"% "}, but may be different for different major
30939 modes. 
30941 @vindex calc-embedded-close-mode
30942 The @code{calc-embedded-close-mode} variable is a string which
30943 follows a mode annotation written by Calc.  Its default value
30944 is simply a newline, @code{"\n"}, but may be different for different
30945 major modes.  If you change this, it is a good idea still to end with a
30946 newline so that mode annotations will appear on lines by themselves.
30948 @node Programming, Customizable Variables, Embedded Mode, Top
30949 @chapter Programming
30951 @noindent
30952 There are several ways to ``program'' the Emacs Calculator, depending
30953 on the nature of the problem you need to solve.
30955 @enumerate
30956 @item
30957 @dfn{Keyboard macros} allow you to record a sequence of keystrokes
30958 and play them back at a later time.  This is just the standard Emacs
30959 keyboard macro mechanism, dressed up with a few more features such
30960 as loops and conditionals.
30962 @item
30963 @dfn{Algebraic definitions} allow you to use any formula to define a
30964 new function.  This function can then be used in algebraic formulas or
30965 as an interactive command.
30967 @item
30968 @dfn{Rewrite rules} are discussed in the section on algebra commands.
30969 @xref{Rewrite Rules}.  If you put your rewrite rules in the variable
30970 @code{EvalRules}, they will be applied automatically to all Calc
30971 results in just the same way as an internal ``rule'' is applied to
30972 evaluate @samp{sqrt(9)} to 3 and so on.  @xref{Automatic Rewrites}.
30974 @item
30975 @dfn{Lisp} is the programming language that Calc (and most of Emacs)
30976 is written in.  If the above techniques aren't powerful enough, you
30977 can write Lisp functions to do anything that built-in Calc commands
30978 can do.  Lisp code is also somewhat faster than keyboard macros or
30979 rewrite rules.
30980 @end enumerate
30982 @kindex z
30983 Programming features are available through the @kbd{z} and @kbd{Z}
30984 prefix keys.  New commands that you define are two-key sequences
30985 beginning with @kbd{z}.  Commands for managing these definitions
30986 use the shift-@kbd{Z} prefix.  (The @kbd{Z T} (@code{calc-timing})
30987 command is described elsewhere; @pxref{Troubleshooting Commands}.
30988 The @kbd{Z C} (@code{calc-user-define-composition}) command is also
30989 described elsewhere; @pxref{User-Defined Compositions}.)
30991 @menu
30992 * Creating User Keys::
30993 * Keyboard Macros::
30994 * Invocation Macros::
30995 * Algebraic Definitions::
30996 * Lisp Definitions::
30997 @end menu
30999 @node Creating User Keys, Keyboard Macros, Programming, Programming
31000 @section Creating User Keys
31002 @noindent
31003 @kindex Z D
31004 @pindex calc-user-define
31005 Any Calculator command may be bound to a key using the @kbd{Z D}
31006 (@code{calc-user-define}) command.  Actually, it is bound to a two-key
31007 sequence beginning with the lower-case @kbd{z} prefix.
31009 The @kbd{Z D} command first prompts for the key to define.  For example,
31010 press @kbd{Z D a} to define the new key sequence @kbd{z a}.  You are then
31011 prompted for the name of the Calculator command that this key should
31012 run.  For example, the @code{calc-sincos} command is not normally
31013 available on a key.  Typing @kbd{Z D s sincos @key{RET}} programs the
31014 @kbd{z s} key sequence to run @code{calc-sincos}.  This definition will remain
31015 in effect for the rest of this Emacs session, or until you redefine
31016 @kbd{z s} to be something else.
31018 You can actually bind any Emacs command to a @kbd{z} key sequence by
31019 backspacing over the @samp{calc-} when you are prompted for the command name.
31021 As with any other prefix key, you can type @kbd{z ?} to see a list of
31022 all the two-key sequences you have defined that start with @kbd{z}.
31023 Initially, no @kbd{z} sequences (except @kbd{z ?} itself) are defined.
31025 User keys are typically letters, but may in fact be any key.
31026 (@key{META}-keys are not permitted, nor are a terminal's special
31027 function keys which generate multi-character sequences when pressed.)
31028 You can define different commands on the shifted and unshifted versions
31029 of a letter if you wish.
31031 @kindex Z U
31032 @pindex calc-user-undefine
31033 The @kbd{Z U} (@code{calc-user-undefine}) command unbinds a user key.
31034 For example, the key sequence @kbd{Z U s} will undefine the @code{sincos}
31035 key we defined above.
31037 @kindex Z P
31038 @pindex calc-user-define-permanent
31039 @cindex Storing user definitions
31040 @cindex Permanent user definitions
31041 @cindex Calc init file, user-defined commands
31042 The @kbd{Z P} (@code{calc-user-define-permanent}) command makes a key
31043 binding permanent so that it will remain in effect even in future Emacs
31044 sessions.  (It does this by adding a suitable bit of Lisp code into
31045 your Calc init file; that is, the file given by the variable
31046 @code{calc-settings-file}, typically @file{~/.calc.el}.)  For example,
31047 @kbd{Z P s} would register our @code{sincos} command permanently.  If
31048 you later wish to unregister this command you must edit your Calc init
31049 file by hand.  (@xref{General Mode Commands}, for a way to tell Calc to
31050 use a different file for the Calc init file.)
31052 The @kbd{Z P} command also saves the user definition, if any, for the
31053 command bound to the key.  After @kbd{Z F} and @kbd{Z C}, a given user
31054 key could invoke a command, which in turn calls an algebraic function,
31055 which might have one or more special display formats.  A single @kbd{Z P}
31056 command will save all of these definitions.
31057 To save an algebraic function, type @kbd{'} (the apostrophe)
31058 when prompted for a key, and type the function name.  To save a command
31059 without its key binding, type @kbd{M-x} and enter a function name.  (The
31060 @samp{calc-} prefix will automatically be inserted for you.)
31061 (If the command you give implies a function, the function will be saved,
31062 and if the function has any display formats, those will be saved, but
31063 not the other way around:  Saving a function will not save any commands
31064 or key bindings associated with the function.) 
31066 @kindex Z E
31067 @pindex calc-user-define-edit
31068 @cindex Editing user definitions
31069 The @kbd{Z E} (@code{calc-user-define-edit}) command edits the definition
31070 of a user key.  This works for keys that have been defined by either
31071 keyboard macros or formulas; further details are contained in the relevant
31072 following sections.
31074 @node Keyboard Macros, Invocation Macros, Creating User Keys, Programming
31075 @section Programming with Keyboard Macros
31077 @noindent
31078 @kindex X
31079 @cindex Programming with keyboard macros
31080 @cindex Keyboard macros
31081 The easiest way to ``program'' the Emacs Calculator is to use standard
31082 keyboard macros.  Press @w{@kbd{C-x (}} to begin recording a macro.  From
31083 this point on, keystrokes you type will be saved away as well as
31084 performing their usual functions.  Press @kbd{C-x )} to end recording.
31085 Press shift-@kbd{X} (or the standard Emacs key sequence @kbd{C-x e}) to
31086 execute your keyboard macro by replaying the recorded keystrokes.
31087 @xref{Keyboard Macros, , , emacs, the Emacs Manual}, for further
31088 information.
31090 When you use @kbd{X} to invoke a keyboard macro, the entire macro is
31091 treated as a single command by the undo and trail features.  The stack
31092 display buffer is not updated during macro execution, but is instead
31093 fixed up once the macro completes.  Thus, commands defined with keyboard
31094 macros are convenient and efficient.  The @kbd{C-x e} command, on the
31095 other hand, invokes the keyboard macro with no special treatment: Each
31096 command in the macro will record its own undo information and trail entry,
31097 and update the stack buffer accordingly.  If your macro uses features
31098 outside of Calc's control to operate on the contents of the Calc stack
31099 buffer, or if it includes Undo, Redo, or last-arguments commands, you
31100 must use @kbd{C-x e} to make sure the buffer and undo list are up-to-date
31101 at all times.  You could also consider using @kbd{K} (@code{calc-keep-args})
31102 instead of @kbd{M-@key{RET}} (@code{calc-last-args}).
31104 Calc extends the standard Emacs keyboard macros in several ways.
31105 Keyboard macros can be used to create user-defined commands.  Keyboard
31106 macros can include conditional and iteration structures, somewhat
31107 analogous to those provided by a traditional programmable calculator.
31109 @menu
31110 * Naming Keyboard Macros::
31111 * Conditionals in Macros::
31112 * Loops in Macros::
31113 * Local Values in Macros::
31114 * Queries in Macros::
31115 @end menu
31117 @node Naming Keyboard Macros, Conditionals in Macros, Keyboard Macros, Keyboard Macros
31118 @subsection Naming Keyboard Macros
31120 @noindent
31121 @kindex Z K
31122 @pindex calc-user-define-kbd-macro
31123 Once you have defined a keyboard macro, you can bind it to a @kbd{z}
31124 key sequence with the @kbd{Z K} (@code{calc-user-define-kbd-macro}) command.
31125 This command prompts first for a key, then for a command name.  For
31126 example, if you type @kbd{C-x ( n @key{TAB} n @key{TAB} C-x )} you will
31127 define a keyboard macro which negates the top two numbers on the stack
31128 (@key{TAB} swaps the top two stack elements).  Now you can type
31129 @kbd{Z K n @key{RET}} to define this keyboard macro onto the @kbd{z n} key
31130 sequence.  The default command name (if you answer the second prompt with
31131 just the @key{RET} key as in this example) will be something like
31132 @samp{calc-User-n}.  The keyboard macro will now be available as both
31133 @kbd{z n} and @kbd{M-x calc-User-n}.  You can backspace and enter a more
31134 descriptive command name if you wish.
31136 Macros defined by @kbd{Z K} act like single commands; they are executed
31137 in the same way as by the @kbd{X} key.  If you wish to define the macro
31138 as a standard no-frills Emacs macro (to be executed as if by @kbd{C-x e}),
31139 give a negative prefix argument to @kbd{Z K}.
31141 Once you have bound your keyboard macro to a key, you can use
31142 @kbd{Z P} to register it permanently with Emacs.  @xref{Creating User Keys}.
31144 @cindex Keyboard macros, editing
31145 The @kbd{Z E} (@code{calc-user-define-edit}) command on a key that has
31146 been defined by a keyboard macro tries to use the @code{edmacro} package
31147 edit the macro.  Type @kbd{C-c C-c} to finish editing and update 
31148 the definition stored on the key, or, to cancel the edit, kill the
31149 buffer with @kbd{C-x k}.
31150 The special characters @code{RET}, @code{LFD}, @code{TAB}, @code{SPC},
31151 @code{DEL}, and @code{NUL} must be entered as these three character
31152 sequences, written in all uppercase, as must the prefixes @code{C-} and
31153 @code{M-}.  Spaces and line breaks are ignored.  Other characters are
31154 copied verbatim into the keyboard macro.  Basically, the notation is the
31155 same as is used in all of this manual's examples, except that the manual
31156 takes some liberties with spaces: When we say @kbd{' [1 2 3] @key{RET}},
31157 we take it for granted that it is clear we really mean 
31158 @kbd{' [1 @key{SPC} 2 @key{SPC} 3] @key{RET}}.
31160 @kindex M-# m
31161 @pindex read-kbd-macro
31162 The @kbd{M-# m} (@code{read-kbd-macro}) command reads an Emacs ``region''
31163 of spelled-out keystrokes and defines it as the current keyboard macro.
31164 It is a convenient way to define a keyboard macro that has been stored
31165 in a file, or to define a macro without executing it at the same time.
31167 @node Conditionals in Macros, Loops in Macros, Naming Keyboard Macros, Keyboard Macros
31168 @subsection Conditionals in Keyboard Macros
31170 @noindent
31171 @kindex Z [
31172 @kindex Z ]
31173 @pindex calc-kbd-if
31174 @pindex calc-kbd-else
31175 @pindex calc-kbd-else-if
31176 @pindex calc-kbd-end-if
31177 @cindex Conditional structures
31178 The @kbd{Z [} (@code{calc-kbd-if}) and @kbd{Z ]} (@code{calc-kbd-end-if})
31179 commands allow you to put simple tests in a keyboard macro.  When Calc
31180 sees the @kbd{Z [}, it pops an object from the stack and, if the object is
31181 a non-zero value, continues executing keystrokes.  But if the object is
31182 zero, or if it is not provably nonzero, Calc skips ahead to the matching
31183 @kbd{Z ]} keystroke.  @xref{Logical Operations}, for a set of commands for
31184 performing tests which conveniently produce 1 for true and 0 for false.
31186 For example, @kbd{@key{RET} 0 a < Z [ n Z ]} implements an absolute-value
31187 function in the form of a keyboard macro.  This macro duplicates the
31188 number on the top of the stack, pushes zero and compares using @kbd{a <}
31189 (@code{calc-less-than}), then, if the number was less than zero,
31190 executes @kbd{n} (@code{calc-change-sign}).  Otherwise, the change-sign
31191 command is skipped.
31193 To program this macro, type @kbd{C-x (}, type the above sequence of
31194 keystrokes, then type @kbd{C-x )}.  Note that the keystrokes will be
31195 executed while you are making the definition as well as when you later
31196 re-execute the macro by typing @kbd{X}.  Thus you should make sure a
31197 suitable number is on the stack before defining the macro so that you
31198 don't get a stack-underflow error during the definition process.
31200 Conditionals can be nested arbitrarily.  However, there should be exactly
31201 one @kbd{Z ]} for each @kbd{Z [} in a keyboard macro.
31203 @kindex Z :
31204 The @kbd{Z :} (@code{calc-kbd-else}) command allows you to choose between
31205 two keystroke sequences.  The general format is @kbd{@var{cond} Z [
31206 @var{then-part} Z : @var{else-part} Z ]}.  If @var{cond} is true
31207 (i.e., if the top of stack contains a non-zero number after @var{cond}
31208 has been executed), the @var{then-part} will be executed and the
31209 @var{else-part} will be skipped.  Otherwise, the @var{then-part} will
31210 be skipped and the @var{else-part} will be executed.
31212 @kindex Z |
31213 The @kbd{Z |} (@code{calc-kbd-else-if}) command allows you to choose
31214 between any number of alternatives.  For example,
31215 @kbd{@var{cond1} Z [ @var{part1} Z : @var{cond2} Z | @var{part2} Z :
31216 @var{part3} Z ]} will execute @var{part1} if @var{cond1} is true,
31217 otherwise it will execute @var{part2} if @var{cond2} is true, otherwise
31218 it will execute @var{part3}.
31220 More precisely, @kbd{Z [} pops a number and conditionally skips to the
31221 next matching @kbd{Z :} or @kbd{Z ]} key.  @w{@kbd{Z ]}} has no effect when
31222 actually executed.  @kbd{Z :} skips to the next matching @kbd{Z ]}.
31223 @kbd{Z |} pops a number and conditionally skips to the next matching
31224 @kbd{Z :} or @kbd{Z ]}; thus, @kbd{Z [} and @kbd{Z |} are functionally
31225 equivalent except that @kbd{Z [} participates in nesting but @kbd{Z |}
31226 does not.
31228 Calc's conditional and looping constructs work by scanning the
31229 keyboard macro for occurrences of character sequences like @samp{Z:}
31230 and @samp{Z]}.  One side-effect of this is that if you use these
31231 constructs you must be careful that these character pairs do not
31232 occur by accident in other parts of the macros.  Since Calc rarely
31233 uses shift-@kbd{Z} for any purpose except as a prefix character, this
31234 is not likely to be a problem.  Another side-effect is that it will
31235 not work to define your own custom key bindings for these commands.
31236 Only the standard shift-@kbd{Z} bindings will work correctly.
31238 @kindex Z C-g
31239 If Calc gets stuck while skipping characters during the definition of a
31240 macro, type @kbd{Z C-g} to cancel the definition.  (Typing plain @kbd{C-g}
31241 actually adds a @kbd{C-g} keystroke to the macro.)
31243 @node Loops in Macros, Local Values in Macros, Conditionals in Macros, Keyboard Macros
31244 @subsection Loops in Keyboard Macros
31246 @noindent
31247 @kindex Z <
31248 @kindex Z >
31249 @pindex calc-kbd-repeat
31250 @pindex calc-kbd-end-repeat
31251 @cindex Looping structures
31252 @cindex Iterative structures
31253 The @kbd{Z <} (@code{calc-kbd-repeat}) and @kbd{Z >}
31254 (@code{calc-kbd-end-repeat}) commands pop a number from the stack,
31255 which must be an integer, then repeat the keystrokes between the brackets
31256 the specified number of times.  If the integer is zero or negative, the
31257 body is skipped altogether.  For example, @kbd{1 @key{TAB} Z < 2 * Z >}
31258 computes two to a nonnegative integer power.  First, we push 1 on the
31259 stack and then swap the integer argument back to the top.  The @kbd{Z <}
31260 pops that argument leaving the 1 back on top of the stack.  Then, we
31261 repeat a multiply-by-two step however many times.
31263 Once again, the keyboard macro is executed as it is being entered.
31264 In this case it is especially important to set up reasonable initial
31265 conditions before making the definition:  Suppose the integer 1000 just
31266 happened to be sitting on the stack before we typed the above definition!
31267 Another approach is to enter a harmless dummy definition for the macro,
31268 then go back and edit in the real one with a @kbd{Z E} command.  Yet
31269 another approach is to type the macro as written-out keystroke names
31270 in a buffer, then use @kbd{M-# m} (@code{read-kbd-macro}) to read the
31271 macro.
31273 @kindex Z /
31274 @pindex calc-break
31275 The @kbd{Z /} (@code{calc-kbd-break}) command allows you to break out
31276 of a keyboard macro loop prematurely.  It pops an object from the stack;
31277 if that object is true (a non-zero number), control jumps out of the
31278 innermost enclosing @kbd{Z <} @dots{} @kbd{Z >} loop and continues
31279 after the @kbd{Z >}.  If the object is false, the @kbd{Z /} has no
31280 effect.  Thus @kbd{@var{cond} Z /} is similar to @samp{if (@var{cond}) break;}
31281 in the C language.
31283 @kindex Z (
31284 @kindex Z )
31285 @pindex calc-kbd-for
31286 @pindex calc-kbd-end-for
31287 The @kbd{Z (} (@code{calc-kbd-for}) and @kbd{Z )} (@code{calc-kbd-end-for})
31288 commands are similar to @kbd{Z <} and @kbd{Z >}, except that they make the
31289 value of the counter available inside the loop.  The general layout is
31290 @kbd{@var{init} @var{final} Z ( @var{body} @var{step} Z )}.  The @kbd{Z (}
31291 command pops initial and final values from the stack.  It then creates
31292 a temporary internal counter and initializes it with the value @var{init}.
31293 The @kbd{Z (} command then repeatedly pushes the counter value onto the
31294 stack and executes @var{body} and @var{step}, adding @var{step} to the
31295 counter each time until the loop finishes.
31297 @cindex Summations (by keyboard macros)
31298 By default, the loop finishes when the counter becomes greater than (or
31299 less than) @var{final}, assuming @var{initial} is less than (greater
31300 than) @var{final}.  If @var{initial} is equal to @var{final}, the body
31301 executes exactly once.  The body of the loop always executes at least
31302 once.  For example, @kbd{0 1 10 Z ( 2 ^ + 1 Z )} computes the sum of the
31303 squares of the integers from 1 to 10, in steps of 1.
31305 If you give a numeric prefix argument of 1 to @kbd{Z (}, the loop is
31306 forced to use upward-counting conventions.  In this case, if @var{initial}
31307 is greater than @var{final} the body will not be executed at all.
31308 Note that @var{step} may still be negative in this loop; the prefix
31309 argument merely constrains the loop-finished test.  Likewise, a prefix
31310 argument of @mathit{-1} forces downward-counting conventions.
31312 @kindex Z @{
31313 @kindex Z @}
31314 @pindex calc-kbd-loop
31315 @pindex calc-kbd-end-loop
31316 The @kbd{Z @{} (@code{calc-kbd-loop}) and @kbd{Z @}}
31317 (@code{calc-kbd-end-loop}) commands are similar to @kbd{Z <} and
31318 @kbd{Z >}, except that they do not pop a count from the stack---they
31319 effectively create an infinite loop.  Every @kbd{Z @{} @dots{} @kbd{Z @}}
31320 loop ought to include at least one @kbd{Z /} to make sure the loop
31321 doesn't run forever.  (If any error message occurs which causes Emacs
31322 to beep, the keyboard macro will also be halted; this is a standard
31323 feature of Emacs.  You can also generally press @kbd{C-g} to halt a
31324 running keyboard macro, although not all versions of Unix support
31325 this feature.)
31327 The conditional and looping constructs are not actually tied to
31328 keyboard macros, but they are most often used in that context.
31329 For example, the keystrokes @kbd{10 Z < 23 @key{RET} Z >} push
31330 ten copies of 23 onto the stack.  This can be typed ``live'' just
31331 as easily as in a macro definition.
31333 @xref{Conditionals in Macros}, for some additional notes about
31334 conditional and looping commands.
31336 @node Local Values in Macros, Queries in Macros, Loops in Macros, Keyboard Macros
31337 @subsection Local Values in Macros
31339 @noindent
31340 @cindex Local variables
31341 @cindex Restoring saved modes
31342 Keyboard macros sometimes want to operate under known conditions
31343 without affecting surrounding conditions.  For example, a keyboard
31344 macro may wish to turn on Fraction mode, or set a particular
31345 precision, independent of the user's normal setting for those
31346 modes.
31348 @kindex Z `
31349 @kindex Z '
31350 @pindex calc-kbd-push
31351 @pindex calc-kbd-pop
31352 Macros also sometimes need to use local variables.  Assignments to
31353 local variables inside the macro should not affect any variables
31354 outside the macro.  The @kbd{Z `} (@code{calc-kbd-push}) and @kbd{Z '}
31355 (@code{calc-kbd-pop}) commands give you both of these capabilities.
31357 When you type @kbd{Z `} (with a backquote or accent grave character),
31358 the values of various mode settings are saved away.  The ten ``quick''
31359 variables @code{q0} through @code{q9} are also saved.  When
31360 you type @w{@kbd{Z '}} (with an apostrophe), these values are restored.
31361 Pairs of @kbd{Z `} and @kbd{Z '} commands may be nested.
31363 If a keyboard macro halts due to an error in between a @kbd{Z `} and
31364 a @kbd{Z '}, the saved values will be restored correctly even though
31365 the macro never reaches the @kbd{Z '} command.  Thus you can use
31366 @kbd{Z `} and @kbd{Z '} without having to worry about what happens
31367 in exceptional conditions.
31369 If you type @kbd{Z `} ``live'' (not in a keyboard macro), Calc puts
31370 you into a ``recursive edit.''  You can tell you are in a recursive
31371 edit because there will be extra square brackets in the mode line,
31372 as in @samp{[(Calculator)]}.  These brackets will go away when you
31373 type the matching @kbd{Z '} command.  The modes and quick variables
31374 will be saved and restored in just the same way as if actual keyboard
31375 macros were involved.
31377 The modes saved by @kbd{Z `} and @kbd{Z '} are the current precision
31378 and binary word size, the angular mode (Deg, Rad, or HMS), the
31379 simplification mode, Algebraic mode, Symbolic mode, Infinite mode,
31380 Matrix or Scalar mode, Fraction mode, and the current complex mode
31381 (Polar or Rectangular).  The ten ``quick'' variables' values (or lack
31382 thereof) are also saved.
31384 Most mode-setting commands act as toggles, but with a numeric prefix
31385 they force the mode either on (positive prefix) or off (negative
31386 or zero prefix).  Since you don't know what the environment might
31387 be when you invoke your macro, it's best to use prefix arguments
31388 for all mode-setting commands inside the macro.
31390 In fact, @kbd{C-u Z `} is like @kbd{Z `} except that it sets the modes
31391 listed above to their default values.  As usual, the matching @kbd{Z '}
31392 will restore the modes to their settings from before the @kbd{C-u Z `}.
31393 Also, @w{@kbd{Z `}} with a negative prefix argument resets the algebraic mode
31394 to its default (off) but leaves the other modes the same as they were
31395 outside the construct.
31397 The contents of the stack and trail, values of non-quick variables, and
31398 other settings such as the language mode and the various display modes,
31399 are @emph{not} affected by @kbd{Z `} and @kbd{Z '}.
31401 @node Queries in Macros, , Local Values in Macros, Keyboard Macros
31402 @subsection Queries in Keyboard Macros
31404 @c @noindent
31405 @c @kindex Z =
31406 @c @pindex calc-kbd-report
31407 @c The @kbd{Z =} (@code{calc-kbd-report}) command displays an informative
31408 @c message including the value on the top of the stack.  You are prompted
31409 @c to enter a string.  That string, along with the top-of-stack value,
31410 @c is displayed unless @kbd{m w} (@code{calc-working}) has been used
31411 @c to turn such messages off.
31413 @noindent
31414 @kindex Z #
31415 @pindex calc-kbd-query
31416 The @kbd{Z #} (@code{calc-kbd-query}) command prompts for an algebraic
31417 entry which takes its input from the keyboard, even during macro
31418 execution.  All the normal conventions of algebraic input, including the
31419 use of @kbd{$} characters, are supported.  The prompt message itself is
31420 taken from the top of the stack, and so must be entered (as a string)
31421 before the @kbd{Z #} command.  (Recall, as a string it can be entered by
31422 pressing the @kbd{"} key and will appear as a vector when it is put on
31423 the stack.  The prompt message is only put on the stack to provide a
31424 prompt for the @kbd{Z #} command; it will not play any role in any
31425 subsequent calculations.)  This command allows your keyboard macros to
31426 accept numbers or formulas as interactive input.
31428 As an example, 
31429 @kbd{2 @key{RET} "Power: " @key{RET} Z # 3 @key{RET} ^} will prompt for
31430 input with ``Power: '' in the minibuffer, then return 2 to the provided
31431 power.  (The response to the prompt that's given, 3 in this example,
31432 will not be part of the macro.)
31434 @xref{Keyboard Macro Query, , , emacs, the Emacs Manual}, for a description of
31435 @kbd{C-x q} (@code{kbd-macro-query}), the standard Emacs way to accept
31436 keyboard input during a keyboard macro.  In particular, you can use
31437 @kbd{C-x q} to enter a recursive edit, which allows the user to perform
31438 any Calculator operations interactively before pressing @kbd{C-M-c} to
31439 return control to the keyboard macro.
31441 @node Invocation Macros, Algebraic Definitions, Keyboard Macros, Programming
31442 @section Invocation Macros
31444 @kindex M-# z
31445 @kindex Z I
31446 @pindex calc-user-invocation
31447 @pindex calc-user-define-invocation
31448 Calc provides one special keyboard macro, called up by @kbd{M-# z}
31449 (@code{calc-user-invocation}), that is intended to allow you to define
31450 your own special way of starting Calc.  To define this ``invocation
31451 macro,'' create the macro in the usual way with @kbd{C-x (} and
31452 @kbd{C-x )}, then type @kbd{Z I} (@code{calc-user-define-invocation}).
31453 There is only one invocation macro, so you don't need to type any
31454 additional letters after @kbd{Z I}.  From now on, you can type
31455 @kbd{M-# z} at any time to execute your invocation macro.
31457 For example, suppose you find yourself often grabbing rectangles of
31458 numbers into Calc and multiplying their columns.  You can do this
31459 by typing @kbd{M-# r} to grab, and @kbd{V R : *} to multiply columns.
31460 To make this into an invocation macro, just type @kbd{C-x ( M-# r
31461 V R : * C-x )}, then @kbd{Z I}.  Then, to multiply a rectangle of data,
31462 just mark the data in its buffer in the usual way and type @kbd{M-# z}.
31464 Invocation macros are treated like regular Emacs keyboard macros;
31465 all the special features described above for @kbd{Z K}-style macros
31466 do not apply.  @kbd{M-# z} is just like @kbd{C-x e}, except that it
31467 uses the macro that was last stored by @kbd{Z I}.  (In fact, the
31468 macro does not even have to have anything to do with Calc!)
31470 The @kbd{m m} command saves the last invocation macro defined by
31471 @kbd{Z I} along with all the other Calc mode settings.
31472 @xref{General Mode Commands}.
31474 @node Algebraic Definitions, Lisp Definitions, Invocation Macros, Programming
31475 @section Programming with Formulas
31477 @noindent
31478 @kindex Z F
31479 @pindex calc-user-define-formula
31480 @cindex Programming with algebraic formulas
31481 Another way to create a new Calculator command uses algebraic formulas.
31482 The @kbd{Z F} (@code{calc-user-define-formula}) command stores the
31483 formula at the top of the stack as the definition for a key.  This
31484 command prompts for five things: The key, the command name, the function
31485 name, the argument list, and the behavior of the command when given
31486 non-numeric arguments.
31488 For example, suppose we type @kbd{' a+2b @key{RET}} to push the formula
31489 @samp{a + 2*b} onto the stack.  We now type @kbd{Z F m} to define this
31490 formula on the @kbd{z m} key sequence.  The next prompt is for a command
31491 name, beginning with @samp{calc-}, which should be the long (@kbd{M-x}) form
31492 for the new command.  If you simply press @key{RET}, a default name like
31493 @code{calc-User-m} will be constructed.  In our example, suppose we enter
31494 @kbd{spam @key{RET}} to define the new command as @code{calc-spam}.
31496 If you want to give the formula a long-style name only, you can press
31497 @key{SPC} or @key{RET} when asked which single key to use.  For example
31498 @kbd{Z F @key{RET} spam @key{RET}} defines the new command as
31499 @kbd{M-x calc-spam}, with no keyboard equivalent.
31501 The third prompt is for an algebraic function name.  The default is to
31502 use the same name as the command name but without the @samp{calc-}
31503 prefix.  (If this is of the form @samp{User-m}, the hyphen is removed so
31504 it won't be taken for a minus sign in algebraic formulas.)
31505 This is the name you will use if you want to enter your 
31506 new function in an algebraic formula.  Suppose we enter @kbd{yow @key{RET}}.
31507 Then the new function can be invoked by pushing two numbers on the
31508 stack and typing @kbd{z m} or @kbd{x spam}, or by entering the algebraic
31509 formula @samp{yow(x,y)}.
31511 The fourth prompt is for the function's argument list.  This is used to
31512 associate values on the stack with the variables that appear in the formula.
31513 The default is a list of all variables which appear in the formula, sorted
31514 into alphabetical order.  In our case, the default would be @samp{(a b)}.
31515 This means that, when the user types @kbd{z m}, the Calculator will remove
31516 two numbers from the stack, substitute these numbers for @samp{a} and
31517 @samp{b} (respectively) in the formula, then simplify the formula and
31518 push the result on the stack.  In other words, @kbd{10 @key{RET} 100 z m}
31519 would replace the 10 and 100 on the stack with the number 210, which is
31520 @expr{a + 2 b} with @expr{a=10} and @expr{b=100}.  Likewise, the formula
31521 @samp{yow(10, 100)} will be evaluated by substituting @expr{a=10} and
31522 @expr{b=100} in the definition.
31524 You can rearrange the order of the names before pressing @key{RET} to
31525 control which stack positions go to which variables in the formula.  If
31526 you remove a variable from the argument list, that variable will be left
31527 in symbolic form by the command.  Thus using an argument list of @samp{(b)}
31528 for our function would cause @kbd{10 z m} to replace the 10 on the stack
31529 with the formula @samp{a + 20}.  If we had used an argument list of
31530 @samp{(b a)}, the result with inputs 10 and 100 would have been 120.
31532 You can also put a nameless function on the stack instead of just a
31533 formula, as in @samp{<a, b : a + 2 b>}.  @xref{Specifying Operators}.
31534 In this example, the command will be defined by the formula @samp{a + 2 b}
31535 using the argument list @samp{(a b)}.
31537 The final prompt is a y-or-n question concerning what to do if symbolic
31538 arguments are given to your function.  If you answer @kbd{y}, then
31539 executing @kbd{z m} (using the original argument list @samp{(a b)}) with
31540 arguments @expr{10} and @expr{x} will leave the function in symbolic
31541 form, i.e., @samp{yow(10,x)}.  On the other hand, if you answer @kbd{n},
31542 then the formula will always be expanded, even for non-constant
31543 arguments: @samp{10 + 2 x}.  If you never plan to feed algebraic
31544 formulas to your new function, it doesn't matter how you answer this
31545 question.
31547 If you answered @kbd{y} to this question you can still cause a function
31548 call to be expanded by typing @kbd{a "} (@code{calc-expand-formula}).
31549 Also, Calc will expand the function if necessary when you take a
31550 derivative or integral or solve an equation involving the function.
31552 @kindex Z G
31553 @pindex calc-get-user-defn
31554 Once you have defined a formula on a key, you can retrieve this formula
31555 with the @kbd{Z G} (@code{calc-user-define-get-defn}) command.  Press a
31556 key, and this command pushes the formula that was used to define that
31557 key onto the stack.  Actually, it pushes a nameless function that
31558 specifies both the argument list and the defining formula.  You will get
31559 an error message if the key is undefined, or if the key was not defined
31560 by a @kbd{Z F} command.
31562 The @kbd{Z E} (@code{calc-user-define-edit}) command on a key that has
31563 been defined by a formula uses a variant of the @code{calc-edit} command
31564 to edit the defining formula.  Press @kbd{C-c C-c} to finish editing and
31565 store the new formula back in the definition, or kill the buffer with
31566 @kbd{C-x k} to
31567 cancel the edit.  (The argument list and other properties of the
31568 definition are unchanged; to adjust the argument list, you can use
31569 @kbd{Z G} to grab the function onto the stack, edit with @kbd{`}, and
31570 then re-execute the @kbd{Z F} command.)
31572 As usual, the @kbd{Z P} command records your definition permanently.
31573 In this case it will permanently record all three of the relevant
31574 definitions: the key, the command, and the function.
31576 You may find it useful to turn off the default simplifications with
31577 @kbd{m O} (@code{calc-no-simplify-mode}) when entering a formula to be
31578 used as a function definition.  For example, the formula @samp{deriv(a^2,v)}
31579 which might be used to define a new function @samp{dsqr(a,v)} will be
31580 ``simplified'' to 0 immediately upon entry since @code{deriv} considers
31581 @expr{a} to be constant with respect to @expr{v}.  Turning off
31582 default simplifications cures this problem:  The definition will be stored
31583 in symbolic form without ever activating the @code{deriv} function.  Press
31584 @kbd{m D} to turn the default simplifications back on afterwards.
31586 @node Lisp Definitions, , Algebraic Definitions, Programming
31587 @section Programming with Lisp
31589 @noindent
31590 The Calculator can be programmed quite extensively in Lisp.  All you
31591 do is write a normal Lisp function definition, but with @code{defmath}
31592 in place of @code{defun}.  This has the same form as @code{defun}, but it
31593 automagically replaces calls to standard Lisp functions like @code{+} and
31594 @code{zerop} with calls to the corresponding functions in Calc's own library.
31595 Thus you can write natural-looking Lisp code which operates on all of the
31596 standard Calculator data types.  You can then use @kbd{Z D} if you wish to
31597 bind your new command to a @kbd{z}-prefix key sequence.  The @kbd{Z E} command
31598 will not edit a Lisp-based definition.
31600 Emacs Lisp is described in the GNU Emacs Lisp Reference Manual.  This section
31601 assumes a familiarity with Lisp programming concepts; if you do not know
31602 Lisp, you may find keyboard macros or rewrite rules to be an easier way
31603 to program the Calculator.
31605 This section first discusses ways to write commands, functions, or
31606 small programs to be executed inside of Calc.  Then it discusses how
31607 your own separate programs are able to call Calc from the outside.
31608 Finally, there is a list of internal Calc functions and data structures
31609 for the true Lisp enthusiast.
31611 @menu
31612 * Defining Functions::
31613 * Defining Simple Commands::
31614 * Defining Stack Commands::
31615 * Argument Qualifiers::
31616 * Example Definitions::
31618 * Calling Calc from Your Programs::
31619 * Internals::
31620 @end menu
31622 @node Defining Functions, Defining Simple Commands, Lisp Definitions, Lisp Definitions
31623 @subsection Defining New Functions
31625 @noindent
31626 @findex defmath
31627 The @code{defmath} function (actually a Lisp macro) is like @code{defun}
31628 except that code in the body of the definition can make use of the full
31629 range of Calculator data types.  The prefix @samp{calcFunc-} is added
31630 to the specified name to get the actual Lisp function name.  As a simple
31631 example,
31633 @example
31634 (defmath myfact (n)
31635   (if (> n 0)
31636       (* n (myfact (1- n)))
31637     1))
31638 @end example
31640 @noindent
31641 This actually expands to the code,
31643 @example
31644 (defun calcFunc-myfact (n)
31645   (if (math-posp n)
31646       (math-mul n (calcFunc-myfact (math-add n -1)))
31647     1))
31648 @end example
31650 @noindent
31651 This function can be used in algebraic expressions, e.g., @samp{myfact(5)}.
31653 The @samp{myfact} function as it is defined above has the bug that an
31654 expression @samp{myfact(a+b)} will be simplified to 1 because the
31655 formula @samp{a+b} is not considered to be @code{posp}.  A robust
31656 factorial function would be written along the following lines:
31658 @smallexample
31659 (defmath myfact (n)
31660   (if (> n 0)
31661       (* n (myfact (1- n)))
31662     (if (= n 0)
31663         1
31664       nil)))    ; this could be simplified as: (and (= n 0) 1)
31665 @end smallexample
31667 If a function returns @code{nil}, it is left unsimplified by the Calculator
31668 (except that its arguments will be simplified).  Thus, @samp{myfact(a+1+2)}
31669 will be simplified to @samp{myfact(a+3)} but no further.  Beware that every
31670 time the Calculator reexamines this formula it will attempt to resimplify
31671 it, so your function ought to detect the returning-@code{nil} case as
31672 efficiently as possible.
31674 The following standard Lisp functions are treated by @code{defmath}:
31675 @code{+}, @code{-}, @code{*}, @code{/}, @code{%}, @code{^} or
31676 @code{expt}, @code{=}, @code{<}, @code{>}, @code{<=}, @code{>=},
31677 @code{/=}, @code{1+}, @code{1-}, @code{logand}, @code{logior}, @code{logxor},
31678 @code{logandc2}, @code{lognot}.  Also, @code{~=} is an abbreviation for
31679 @code{math-nearly-equal}, which is useful in implementing Taylor series.
31681 For other functions @var{func}, if a function by the name
31682 @samp{calcFunc-@var{func}} exists it is used, otherwise if a function by the
31683 name @samp{math-@var{func}} exists it is used, otherwise if @var{func} itself
31684 is defined as a function it is used, otherwise @samp{calcFunc-@var{func}} is
31685 used on the assumption that this is a to-be-defined math function.  Also, if
31686 the function name is quoted as in @samp{('integerp a)} the function name is
31687 always used exactly as written (but not quoted).
31689 Variable names have @samp{var-} prepended to them unless they appear in
31690 the function's argument list or in an enclosing @code{let}, @code{let*},
31691 @code{for}, or @code{foreach} form,
31692 or their names already contain a @samp{-} character.  Thus a reference to
31693 @samp{foo} is the same as a reference to @samp{var-foo}.
31695 A few other Lisp extensions are available in @code{defmath} definitions:
31697 @itemize @bullet
31698 @item
31699 The @code{elt} function accepts any number of index variables.
31700 Note that Calc vectors are stored as Lisp lists whose first
31701 element is the symbol @code{vec}; thus, @samp{(elt v 2)} yields
31702 the second element of vector @code{v}, and @samp{(elt m i j)}
31703 yields one element of a Calc matrix.
31705 @item
31706 The @code{setq} function has been extended to act like the Common
31707 Lisp @code{setf} function.  (The name @code{setf} is recognized as
31708 a synonym of @code{setq}.)  Specifically, the first argument of
31709 @code{setq} can be an @code{nth}, @code{elt}, @code{car}, or @code{cdr} form,
31710 in which case the effect is to store into the specified
31711 element of a list.  Thus, @samp{(setq (elt m i j) x)} stores @expr{x}
31712 into one element of a matrix.
31714 @item
31715 A @code{for} looping construct is available.  For example,
31716 @samp{(for ((i 0 10)) body)} executes @code{body} once for each
31717 binding of @expr{i} from zero to 10.  This is like a @code{let}
31718 form in that @expr{i} is temporarily bound to the loop count
31719 without disturbing its value outside the @code{for} construct.
31720 Nested loops, as in @samp{(for ((i 0 10) (j 0 (1- i) 2)) body)},
31721 are also available.  For each value of @expr{i} from zero to 10,
31722 @expr{j} counts from 0 to @expr{i-1} in steps of two.  Note that
31723 @code{for} has the same general outline as @code{let*}, except
31724 that each element of the header is a list of three or four
31725 things, not just two.
31727 @item
31728 The @code{foreach} construct loops over elements of a list.
31729 For example, @samp{(foreach ((x (cdr v))) body)} executes
31730 @code{body} with @expr{x} bound to each element of Calc vector
31731 @expr{v} in turn.  The purpose of @code{cdr} here is to skip over
31732 the initial @code{vec} symbol in the vector.
31734 @item
31735 The @code{break} function breaks out of the innermost enclosing
31736 @code{while}, @code{for}, or @code{foreach} loop.  If given a
31737 value, as in @samp{(break x)}, this value is returned by the
31738 loop.  (Lisp loops otherwise always return @code{nil}.)
31740 @item
31741 The @code{return} function prematurely returns from the enclosing
31742 function.  For example, @samp{(return (+ x y))} returns @expr{x+y}
31743 as the value of a function.  You can use @code{return} anywhere
31744 inside the body of the function.
31745 @end itemize
31747 Non-integer numbers (and extremely large integers) cannot be included
31748 directly into a @code{defmath} definition.  This is because the Lisp
31749 reader will fail to parse them long before @code{defmath} ever gets control.
31750 Instead, use the notation, @samp{:"3.1415"}.  In fact, any algebraic
31751 formula can go between the quotes.  For example,
31753 @smallexample
31754 (defmath sqexp (x)     ; sqexp(x) == sqrt(exp(x)) == exp(x*0.5)
31755   (and (numberp x)
31756        (exp :"x * 0.5")))
31757 @end smallexample
31759 expands to
31761 @smallexample
31762 (defun calcFunc-sqexp (x)
31763   (and (math-numberp x)
31764        (calcFunc-exp (math-mul x '(float 5 -1)))))
31765 @end smallexample
31767 Note the use of @code{numberp} as a guard to ensure that the argument is
31768 a number first, returning @code{nil} if not.  The exponential function
31769 could itself have been included in the expression, if we had preferred:
31770 @samp{:"exp(x * 0.5)"}.  As another example, the multiplication-and-recursion
31771 step of @code{myfact} could have been written
31773 @example
31774 :"n * myfact(n-1)"
31775 @end example
31777 A good place to put your @code{defmath} commands is your Calc init file
31778 (the file given by @code{calc-settings-file}, typically
31779 @file{~/.calc.el}), which will not be loaded until Calc starts.
31780 If a file named @file{.emacs} exists in your home directory, Emacs reads
31781 and executes the Lisp forms in this file as it starts up.  While it may
31782 seem reasonable to put your favorite @code{defmath} commands there,
31783 this has the unfortunate side-effect that parts of the Calculator must be
31784 loaded in to process the @code{defmath} commands whether or not you will
31785 actually use the Calculator!  If you want to put the @code{defmath}
31786 commands there (for example, if you redefine @code{calc-settings-file}
31787 to be @file{.emacs}), a better effect can be had by writing
31789 @example
31790 (put 'calc-define 'thing '(progn
31791  (defmath ... )
31792  (defmath ... )
31794 @end example
31796 @noindent
31797 @vindex calc-define
31798 The @code{put} function adds a @dfn{property} to a symbol.  Each Lisp
31799 symbol has a list of properties associated with it.  Here we add a
31800 property with a name of @code{thing} and a @samp{(progn ...)} form as
31801 its value.  When Calc starts up, and at the start of every Calc command,
31802 the property list for the symbol @code{calc-define} is checked and the
31803 values of any properties found are evaluated as Lisp forms.  The
31804 properties are removed as they are evaluated.  The property names
31805 (like @code{thing}) are not used; you should choose something like the
31806 name of your project so as not to conflict with other properties.
31808 The net effect is that you can put the above code in your @file{.emacs}
31809 file and it will not be executed until Calc is loaded.  Or, you can put
31810 that same code in another file which you load by hand either before or
31811 after Calc itself is loaded.
31813 The properties of @code{calc-define} are evaluated in the same order
31814 that they were added.  They can assume that the Calc modules @file{calc.el},
31815 @file{calc-ext.el}, and @file{calc-macs.el} have been fully loaded, and
31816 that the @samp{*Calculator*} buffer will be the current buffer.
31818 If your @code{calc-define} property only defines algebraic functions,
31819 you can be sure that it will have been evaluated before Calc tries to
31820 call your function, even if the file defining the property is loaded
31821 after Calc is loaded.  But if the property defines commands or key
31822 sequences, it may not be evaluated soon enough.  (Suppose it defines the
31823 new command @code{tweak-calc}; the user can load your file, then type
31824 @kbd{M-x tweak-calc} before Calc has had chance to do anything.)  To
31825 protect against this situation, you can put
31827 @example
31828 (run-hooks 'calc-check-defines)
31829 @end example
31831 @findex calc-check-defines
31832 @noindent
31833 at the end of your file.  The @code{calc-check-defines} function is what
31834 looks for and evaluates properties on @code{calc-define}; @code{run-hooks}
31835 has the advantage that it is quietly ignored if @code{calc-check-defines}
31836 is not yet defined because Calc has not yet been loaded.
31838 Examples of things that ought to be enclosed in a @code{calc-define}
31839 property are @code{defmath} calls, @code{define-key} calls that modify
31840 the Calc key map, and any calls that redefine things defined inside Calc.
31841 Ordinary @code{defun}s need not be enclosed with @code{calc-define}.
31843 @node Defining Simple Commands, Defining Stack Commands, Defining Functions, Lisp Definitions
31844 @subsection Defining New Simple Commands
31846 @noindent
31847 @findex interactive
31848 If a @code{defmath} form contains an @code{interactive} clause, it defines
31849 a Calculator command.  Actually such a @code{defmath} results in @emph{two}
31850 function definitions:  One, a @samp{calcFunc-} function as was just described,
31851 with the @code{interactive} clause removed.  Two, a @samp{calc-} function
31852 with a suitable @code{interactive} clause and some sort of wrapper to make
31853 the command work in the Calc environment.
31855 In the simple case, the @code{interactive} clause has the same form as
31856 for normal Emacs Lisp commands:
31858 @smallexample
31859 (defmath increase-precision (delta)
31860   "Increase precision by DELTA."     ; This is the "documentation string"
31861   (interactive "p")                  ; Register this as a M-x-able command
31862   (setq calc-internal-prec (+ calc-internal-prec delta)))
31863 @end smallexample
31865 This expands to the pair of definitions,
31867 @smallexample
31868 (defun calc-increase-precision (delta)
31869   "Increase precision by DELTA."
31870   (interactive "p")
31871   (calc-wrapper
31872    (setq calc-internal-prec (math-add calc-internal-prec delta))))
31874 (defun calcFunc-increase-precision (delta)
31875   "Increase precision by DELTA."
31876   (setq calc-internal-prec (math-add calc-internal-prec delta)))
31877 @end smallexample
31879 @noindent
31880 where in this case the latter function would never really be used!  Note
31881 that since the Calculator stores small integers as plain Lisp integers,
31882 the @code{math-add} function will work just as well as the native
31883 @code{+} even when the intent is to operate on native Lisp integers.
31885 @findex calc-wrapper
31886 The @samp{calc-wrapper} call invokes a macro which surrounds the body of
31887 the function with code that looks roughly like this:
31889 @smallexample
31890 (let ((calc-command-flags nil))
31891   (unwind-protect
31892       (save-excursion
31893         (calc-select-buffer)
31894         @emph{body of function}
31895         @emph{renumber stack}
31896         @emph{clear} Working @emph{message})
31897     @emph{realign cursor and window}
31898     @emph{clear Inverse, Hyperbolic, and Keep Args flags}
31899     @emph{update Emacs mode line}))
31900 @end smallexample
31902 @findex calc-select-buffer
31903 The @code{calc-select-buffer} function selects the @samp{*Calculator*}
31904 buffer if necessary, say, because the command was invoked from inside
31905 the @samp{*Calc Trail*} window.
31907 @findex calc-set-command-flag
31908 You can call, for example, @code{(calc-set-command-flag 'no-align)} to
31909 set the above-mentioned command flags.  Calc routines recognize the
31910 following command flags:
31912 @table @code
31913 @item renum-stack
31914 Stack line numbers @samp{1:}, @samp{2:}, and so on must be renumbered
31915 after this command completes.  This is set by routines like
31916 @code{calc-push}.
31918 @item clear-message
31919 Calc should call @samp{(message "")} if this command completes normally
31920 (to clear a ``Working@dots{}'' message out of the echo area).
31922 @item no-align
31923 Do not move the cursor back to the @samp{.} top-of-stack marker.
31925 @item position-point
31926 Use the variables @code{calc-position-point-line} and
31927 @code{calc-position-point-column} to position the cursor after
31928 this command finishes.
31930 @item keep-flags
31931 Do not clear @code{calc-inverse-flag}, @code{calc-hyperbolic-flag},
31932 and @code{calc-keep-args-flag} at the end of this command.
31934 @item do-edit
31935 Switch to buffer @samp{*Calc Edit*} after this command.
31937 @item hold-trail
31938 Do not move trail pointer to end of trail when something is recorded
31939 there.
31940 @end table
31942 @kindex Y
31943 @kindex Y ?
31944 @vindex calc-Y-help-msgs
31945 Calc reserves a special prefix key, shift-@kbd{Y}, for user-written
31946 extensions to Calc.  There are no built-in commands that work with
31947 this prefix key; you must call @code{define-key} from Lisp (probably
31948 from inside a @code{calc-define} property) to add to it.  Initially only
31949 @kbd{Y ?} is defined; it takes help messages from a list of strings
31950 (initially @code{nil}) in the variable @code{calc-Y-help-msgs}.  All
31951 other undefined keys except for @kbd{Y} are reserved for use by
31952 future versions of Calc.
31954 If you are writing a Calc enhancement which you expect to give to
31955 others, it is best to minimize the number of @kbd{Y}-key sequences
31956 you use.  In fact, if you have more than one key sequence you should
31957 consider defining three-key sequences with a @kbd{Y}, then a key that
31958 stands for your package, then a third key for the particular command
31959 within your package.
31961 Users may wish to install several Calc enhancements, and it is possible
31962 that several enhancements will choose to use the same key.  In the
31963 example below, a variable @code{inc-prec-base-key} has been defined
31964 to contain the key that identifies the @code{inc-prec} package.  Its
31965 value is initially @code{"P"}, but a user can change this variable
31966 if necessary without having to modify the file.
31968 Here is a complete file, @file{inc-prec.el}, which makes a @kbd{Y P I}
31969 command that increases the precision, and a @kbd{Y P D} command that
31970 decreases the precision.
31972 @smallexample
31973 ;;; Increase and decrease Calc precision.  Dave Gillespie, 5/31/91.
31974 ;;; (Include copyright or copyleft stuff here.)
31976 (defvar inc-prec-base-key "P"
31977   "Base key for inc-prec.el commands.")
31979 (put 'calc-define 'inc-prec '(progn
31981 (define-key calc-mode-map (format "Y%sI" inc-prec-base-key)
31982             'increase-precision)
31983 (define-key calc-mode-map (format "Y%sD" inc-prec-base-key)
31984             'decrease-precision)
31986 (setq calc-Y-help-msgs
31987       (cons (format "%s + Inc-prec, Dec-prec" inc-prec-base-key)
31988             calc-Y-help-msgs))
31990 (defmath increase-precision (delta)
31991   "Increase precision by DELTA."
31992   (interactive "p")
31993   (setq calc-internal-prec (+ calc-internal-prec delta)))
31995 (defmath decrease-precision (delta)
31996   "Decrease precision by DELTA."
31997   (interactive "p")
31998   (setq calc-internal-prec (- calc-internal-prec delta)))
32000 ))  ; end of calc-define property
32002 (run-hooks 'calc-check-defines)
32003 @end smallexample
32005 @node Defining Stack Commands, Argument Qualifiers, Defining Simple Commands, Lisp Definitions
32006 @subsection Defining New Stack-Based Commands
32008 @noindent
32009 To define a new computational command which takes and/or leaves arguments
32010 on the stack, a special form of @code{interactive} clause is used.
32012 @example
32013 (interactive @var{num} @var{tag})
32014 @end example
32016 @noindent
32017 where @var{num} is an integer, and @var{tag} is a string.  The effect is
32018 to pop @var{num} values off the stack, resimplify them by calling
32019 @code{calc-normalize}, and hand them to your function according to the
32020 function's argument list.  Your function may include @code{&optional} and
32021 @code{&rest} parameters, so long as calling the function with @var{num}
32022 parameters is valid.
32024 Your function must return either a number or a formula in a form
32025 acceptable to Calc, or a list of such numbers or formulas.  These value(s)
32026 are pushed onto the stack when the function completes.  They are also
32027 recorded in the Calc Trail buffer on a line beginning with @var{tag},
32028 a string of (normally) four characters or less.  If you omit @var{tag}
32029 or use @code{nil} as a tag, the result is not recorded in the trail.
32031 As an example, the definition
32033 @smallexample
32034 (defmath myfact (n)
32035   "Compute the factorial of the integer at the top of the stack."
32036   (interactive 1 "fact")
32037   (if (> n 0)
32038       (* n (myfact (1- n)))
32039     (and (= n 0) 1)))
32040 @end smallexample
32042 @noindent
32043 is a version of the factorial function shown previously which can be used
32044 as a command as well as an algebraic function.  It expands to
32046 @smallexample
32047 (defun calc-myfact ()
32048   "Compute the factorial of the integer at the top of the stack."
32049   (interactive)
32050   (calc-slow-wrapper
32051    (calc-enter-result 1 "fact"
32052      (cons 'calcFunc-myfact (calc-top-list-n 1)))))
32054 (defun calcFunc-myfact (n)
32055   "Compute the factorial of the integer at the top of the stack."
32056   (if (math-posp n)
32057       (math-mul n (calcFunc-myfact (math-add n -1)))
32058     (and (math-zerop n) 1)))
32059 @end smallexample
32061 @findex calc-slow-wrapper
32062 The @code{calc-slow-wrapper} function is a version of @code{calc-wrapper}
32063 that automatically puts up a @samp{Working...} message before the
32064 computation begins.  (This message can be turned off by the user
32065 with an @kbd{m w} (@code{calc-working}) command.)
32067 @findex calc-top-list-n
32068 The @code{calc-top-list-n} function returns a list of the specified number
32069 of values from the top of the stack.  It resimplifies each value by
32070 calling @code{calc-normalize}.  If its argument is zero it returns an
32071 empty list.  It does not actually remove these values from the stack.
32073 @findex calc-enter-result
32074 The @code{calc-enter-result} function takes an integer @var{num} and string
32075 @var{tag} as described above, plus a third argument which is either a
32076 Calculator data object or a list of such objects.  These objects are
32077 resimplified and pushed onto the stack after popping the specified number
32078 of values from the stack.  If @var{tag} is non-@code{nil}, the values
32079 being pushed are also recorded in the trail.
32081 Note that if @code{calcFunc-myfact} returns @code{nil} this represents
32082 ``leave the function in symbolic form.''  To return an actual empty list,
32083 in the sense that @code{calc-enter-result} will push zero elements back
32084 onto the stack, you should return the special value @samp{'(nil)}, a list
32085 containing the single symbol @code{nil}.
32087 The @code{interactive} declaration can actually contain a limited
32088 Emacs-style code string as well which comes just before @var{num} and
32089 @var{tag}.  Currently the only Emacs code supported is @samp{"p"}, as in
32091 @example
32092 (defmath foo (a b &optional c)
32093   (interactive "p" 2 "foo")
32094   @var{body})
32095 @end example
32097 In this example, the command @code{calc-foo} will evaluate the expression
32098 @samp{foo(a,b)} if executed with no argument, or @samp{foo(a,b,n)} if
32099 executed with a numeric prefix argument of @expr{n}.
32101 The other code string allowed is @samp{"m"} (unrelated to the usual @samp{"m"}
32102 code as used with @code{defun}).  It uses the numeric prefix argument as the
32103 number of objects to remove from the stack and pass to the function.
32104 In this case, the integer @var{num} serves as a default number of
32105 arguments to be used when no prefix is supplied.
32107 @node Argument Qualifiers, Example Definitions, Defining Stack Commands, Lisp Definitions
32108 @subsection Argument Qualifiers
32110 @noindent
32111 Anywhere a parameter name can appear in the parameter list you can also use
32112 an @dfn{argument qualifier}.  Thus the general form of a definition is:
32114 @example
32115 (defmath @var{name} (@var{param} @var{param...}
32116                &optional @var{param} @var{param...}
32117                &rest @var{param})
32118   @var{body})
32119 @end example
32121 @noindent
32122 where each @var{param} is either a symbol or a list of the form
32124 @example
32125 (@var{qual} @var{param})
32126 @end example
32128 The following qualifiers are recognized:
32130 @table @samp
32131 @item complete
32132 @findex complete
32133 The argument must not be an incomplete vector, interval, or complex number.
32134 (This is rarely needed since the Calculator itself will never call your
32135 function with an incomplete argument.  But there is nothing stopping your
32136 own Lisp code from calling your function with an incomplete argument.)
32138 @item integer
32139 @findex integer
32140 The argument must be an integer.  If it is an integer-valued float
32141 it will be accepted but converted to integer form.  Non-integers and
32142 formulas are rejected.
32144 @item natnum
32145 @findex natnum
32146 Like @samp{integer}, but the argument must be non-negative.
32148 @item fixnum
32149 @findex fixnum
32150 Like @samp{integer}, but the argument must fit into a native Lisp integer,
32151 which on most systems means less than 2^23 in absolute value.  The
32152 argument is converted into Lisp-integer form if necessary.
32154 @item float
32155 @findex float
32156 The argument is converted to floating-point format if it is a number or
32157 vector.  If it is a formula it is left alone.  (The argument is never
32158 actually rejected by this qualifier.)
32160 @item @var{pred}
32161 The argument must satisfy predicate @var{pred}, which is one of the
32162 standard Calculator predicates.  @xref{Predicates}.
32164 @item not-@var{pred}
32165 The argument must @emph{not} satisfy predicate @var{pred}.
32166 @end table
32168 For example,
32170 @example
32171 (defmath foo (a (constp (not-matrixp b)) &optional (float c)
32172               &rest (integer d))
32173   @var{body})
32174 @end example
32176 @noindent
32177 expands to
32179 @example
32180 (defun calcFunc-foo (a b &optional c &rest d)
32181   (and (math-matrixp b)
32182        (math-reject-arg b 'not-matrixp))
32183   (or (math-constp b)
32184       (math-reject-arg b 'constp))
32185   (and c (setq c (math-check-float c)))
32186   (setq d (mapcar 'math-check-integer d))
32187   @var{body})
32188 @end example
32190 @noindent
32191 which performs the necessary checks and conversions before executing the
32192 body of the function.
32194 @node Example Definitions, Calling Calc from Your Programs, Argument Qualifiers, Lisp Definitions
32195 @subsection Example Definitions
32197 @noindent
32198 This section includes some Lisp programming examples on a larger scale.
32199 These programs make use of some of the Calculator's internal functions;
32200 @pxref{Internals}.
32202 @menu
32203 * Bit Counting Example::
32204 * Sine Example::
32205 @end menu
32207 @node Bit Counting Example, Sine Example, Example Definitions, Example Definitions
32208 @subsubsection Bit-Counting
32210 @noindent
32211 @ignore
32212 @starindex
32213 @end ignore
32214 @tindex bcount
32215 Calc does not include a built-in function for counting the number of
32216 ``one'' bits in a binary integer.  It's easy to invent one using @kbd{b u}
32217 to convert the integer to a set, and @kbd{V #} to count the elements of
32218 that set; let's write a function that counts the bits without having to
32219 create an intermediate set.
32221 @smallexample
32222 (defmath bcount ((natnum n))
32223   (interactive 1 "bcnt")
32224   (let ((count 0))
32225     (while (> n 0)
32226       (if (oddp n)
32227           (setq count (1+ count)))
32228       (setq n (lsh n -1)))
32229     count))
32230 @end smallexample
32232 @noindent
32233 When this is expanded by @code{defmath}, it will become the following
32234 Emacs Lisp function:
32236 @smallexample
32237 (defun calcFunc-bcount (n)
32238   (setq n (math-check-natnum n))
32239   (let ((count 0))
32240     (while (math-posp n)
32241       (if (math-oddp n)
32242           (setq count (math-add count 1)))
32243       (setq n (calcFunc-lsh n -1)))
32244     count))
32245 @end smallexample
32247 If the input numbers are large, this function involves a fair amount
32248 of arithmetic.  A binary right shift is essentially a division by two;
32249 recall that Calc stores integers in decimal form so bit shifts must
32250 involve actual division.
32252 To gain a bit more efficiency, we could divide the integer into
32253 @var{n}-bit chunks, each of which can be handled quickly because
32254 they fit into Lisp integers.  It turns out that Calc's arithmetic
32255 routines are especially fast when dividing by an integer less than
32256 1000, so we can set @var{n = 9} bits and use repeated division by 512:
32258 @smallexample
32259 (defmath bcount ((natnum n))
32260   (interactive 1 "bcnt")
32261   (let ((count 0))
32262     (while (not (fixnump n))
32263       (let ((qr (idivmod n 512)))
32264         (setq count (+ count (bcount-fixnum (cdr qr)))
32265               n (car qr))))
32266     (+ count (bcount-fixnum n))))
32268 (defun bcount-fixnum (n)
32269   (let ((count 0))
32270     (while (> n 0)
32271       (setq count (+ count (logand n 1))
32272             n (lsh n -1)))
32273     count))
32274 @end smallexample
32276 @noindent
32277 Note that the second function uses @code{defun}, not @code{defmath}.
32278 Because this function deals only with native Lisp integers (``fixnums''),
32279 it can use the actual Emacs @code{+} and related functions rather
32280 than the slower but more general Calc equivalents which @code{defmath}
32281 uses.
32283 The @code{idivmod} function does an integer division, returning both
32284 the quotient and the remainder at once.  Again, note that while it
32285 might seem that @samp{(logand n 511)} and @samp{(lsh n -9)} are
32286 more efficient ways to split off the bottom nine bits of @code{n},
32287 actually they are less efficient because each operation is really
32288 a division by 512 in disguise; @code{idivmod} allows us to do the
32289 same thing with a single division by 512.
32291 @node Sine Example, , Bit Counting Example, Example Definitions
32292 @subsubsection The Sine Function
32294 @noindent
32295 @ignore
32296 @starindex
32297 @end ignore
32298 @tindex mysin
32299 A somewhat limited sine function could be defined as follows, using the
32300 well-known Taylor series expansion for 
32301 @texline @math{\sin x}:
32302 @infoline @samp{sin(x)}:
32304 @smallexample
32305 (defmath mysin ((float (anglep x)))
32306   (interactive 1 "mysn")
32307   (setq x (to-radians x))    ; Convert from current angular mode.
32308   (let ((sum x)              ; Initial term of Taylor expansion of sin.
32309         newsum
32310         (nfact 1)            ; "nfact" equals "n" factorial at all times.
32311         (xnegsqr :"-(x^2)")) ; "xnegsqr" equals -x^2.
32312     (for ((n 3 100 2))       ; Upper limit of 100 is a good precaution.
32313       (working "mysin" sum)  ; Display "Working" message, if enabled.
32314       (setq nfact (* nfact (1- n) n)
32315             x (* x xnegsqr)
32316             newsum (+ sum (/ x nfact)))
32317       (if (~= newsum sum)    ; If newsum is "nearly equal to" sum,
32318           (break))           ;  then we are done.
32319       (setq sum newsum))
32320     sum))
32321 @end smallexample
32323 The actual @code{sin} function in Calc works by first reducing the problem
32324 to a sine or cosine of a nonnegative number less than @cpiover{4}.  This
32325 ensures that the Taylor series will converge quickly.  Also, the calculation
32326 is carried out with two extra digits of precision to guard against cumulative
32327 round-off in @samp{sum}.  Finally, complex arguments are allowed and handled
32328 by a separate algorithm.
32330 @smallexample
32331 (defmath mysin ((float (scalarp x)))
32332   (interactive 1 "mysn")
32333   (setq x (to-radians x))    ; Convert from current angular mode.
32334   (with-extra-prec 2         ; Evaluate with extra precision.
32335     (cond ((complexp x)
32336            (mysin-complex x))
32337           ((< x 0)
32338            (- (mysin-raw (- x)))    ; Always call mysin-raw with x >= 0.
32339           (t (mysin-raw x))))))
32341 (defmath mysin-raw (x)
32342   (cond ((>= x 7)
32343          (mysin-raw (% x (two-pi))))     ; Now x < 7.
32344         ((> x (pi-over-2))
32345          (- (mysin-raw (- x (pi)))))     ; Now -pi/2 <= x <= pi/2.
32346         ((> x (pi-over-4))
32347          (mycos-raw (- x (pi-over-2))))  ; Now -pi/2 <= x <= pi/4.
32348         ((< x (- (pi-over-4)))
32349          (- (mycos-raw (+ x (pi-over-2)))))  ; Now -pi/4 <= x <= pi/4,
32350         (t (mysin-series x))))           ; so the series will be efficient.
32351 @end smallexample
32353 @noindent
32354 where @code{mysin-complex} is an appropriate function to handle complex
32355 numbers, @code{mysin-series} is the routine to compute the sine Taylor
32356 series as before, and @code{mycos-raw} is a function analogous to
32357 @code{mysin-raw} for cosines.
32359 The strategy is to ensure that @expr{x} is nonnegative before calling
32360 @code{mysin-raw}.  This function then recursively reduces its argument
32361 to a suitable range, namely, plus-or-minus @cpiover{4}.  Note that each
32362 test, and particularly the first comparison against 7, is designed so
32363 that small roundoff errors cannot produce an infinite loop.  (Suppose
32364 we compared with @samp{(two-pi)} instead; if due to roundoff problems
32365 the modulo operator ever returned @samp{(two-pi)} exactly, an infinite
32366 recursion could result!)  We use modulo only for arguments that will
32367 clearly get reduced, knowing that the next rule will catch any reductions
32368 that this rule misses.
32370 If a program is being written for general use, it is important to code
32371 it carefully as shown in this second example.  For quick-and-dirty programs,
32372 when you know that your own use of the sine function will never encounter
32373 a large argument, a simpler program like the first one shown is fine.
32375 @node Calling Calc from Your Programs, Internals, Example Definitions, Lisp Definitions
32376 @subsection Calling Calc from Your Lisp Programs
32378 @noindent
32379 A later section (@pxref{Internals}) gives a full description of
32380 Calc's internal Lisp functions.  It's not hard to call Calc from
32381 inside your programs, but the number of these functions can be daunting.
32382 So Calc provides one special ``programmer-friendly'' function called
32383 @code{calc-eval} that can be made to do just about everything you
32384 need.  It's not as fast as the low-level Calc functions, but it's
32385 much simpler to use!
32387 It may seem that @code{calc-eval} itself has a daunting number of
32388 options, but they all stem from one simple operation.
32390 In its simplest manifestation, @samp{(calc-eval "1+2")} parses the
32391 string @code{"1+2"} as if it were a Calc algebraic entry and returns
32392 the result formatted as a string: @code{"3"}.
32394 Since @code{calc-eval} is on the list of recommended @code{autoload}
32395 functions, you don't need to make any special preparations to load
32396 Calc before calling @code{calc-eval} the first time.  Calc will be
32397 loaded and initialized for you.
32399 All the Calc modes that are currently in effect will be used when
32400 evaluating the expression and formatting the result.
32402 @ifinfo
32403 @example
32405 @end example
32406 @end ifinfo
32407 @subsubsection Additional Arguments to @code{calc-eval}
32409 @noindent
32410 If the input string parses to a list of expressions, Calc returns
32411 the results separated by @code{", "}.  You can specify a different
32412 separator by giving a second string argument to @code{calc-eval}:
32413 @samp{(calc-eval "1+2,3+4" ";")} returns @code{"3;7"}.
32415 The ``separator'' can also be any of several Lisp symbols which
32416 request other behaviors from @code{calc-eval}.  These are discussed
32417 one by one below.
32419 You can give additional arguments to be substituted for
32420 @samp{$}, @samp{$$}, and so on in the main expression.  For
32421 example, @samp{(calc-eval "$/$$" nil "7" "1+1")} evaluates the
32422 expression @code{"7/(1+1)"} to yield the result @code{"3.5"}
32423 (assuming Fraction mode is not in effect).  Note the @code{nil}
32424 used as a placeholder for the item-separator argument.
32426 @ifinfo
32427 @example
32429 @end example
32430 @end ifinfo
32431 @subsubsection Error Handling
32433 @noindent
32434 If @code{calc-eval} encounters an error, it returns a list containing
32435 the character position of the error, plus a suitable message as a
32436 string.  Note that @samp{1 / 0} is @emph{not} an error by Calc's
32437 standards; it simply returns the string @code{"1 / 0"} which is the
32438 division left in symbolic form.  But @samp{(calc-eval "1/")} will
32439 return the list @samp{(2 "Expected a number")}.
32441 If you bind the variable @code{calc-eval-error} to @code{t}
32442 using a @code{let} form surrounding the call to @code{calc-eval},
32443 errors instead call the Emacs @code{error} function which aborts
32444 to the Emacs command loop with a beep and an error message.
32446 If you bind this variable to the symbol @code{string}, error messages
32447 are returned as strings instead of lists.  The character position is
32448 ignored.
32450 As a courtesy to other Lisp code which may be using Calc, be sure
32451 to bind @code{calc-eval-error} using @code{let} rather than changing
32452 it permanently with @code{setq}.
32454 @ifinfo
32455 @example
32457 @end example
32458 @end ifinfo
32459 @subsubsection Numbers Only
32461 @noindent
32462 Sometimes it is preferable to treat @samp{1 / 0} as an error
32463 rather than returning a symbolic result.  If you pass the symbol
32464 @code{num} as the second argument to @code{calc-eval}, results
32465 that are not constants are treated as errors.  The error message
32466 reported is the first @code{calc-why} message if there is one,
32467 or otherwise ``Number expected.''
32469 A result is ``constant'' if it is a number, vector, or other
32470 object that does not include variables or function calls.  If it
32471 is a vector, the components must themselves be constants.
32473 @ifinfo
32474 @example
32476 @end example
32477 @end ifinfo
32478 @subsubsection Default Modes
32480 @noindent
32481 If the first argument to @code{calc-eval} is a list whose first
32482 element is a formula string, then @code{calc-eval} sets all the
32483 various Calc modes to their default values while the formula is
32484 evaluated and formatted.  For example, the precision is set to 12
32485 digits, digit grouping is turned off, and the Normal language
32486 mode is used.
32488 This same principle applies to the other options discussed below.
32489 If the first argument would normally be @var{x}, then it can also
32490 be the list @samp{(@var{x})} to use the default mode settings.
32492 If there are other elements in the list, they are taken as
32493 variable-name/value pairs which override the default mode
32494 settings.  Look at the documentation at the front of the
32495 @file{calc.el} file to find the names of the Lisp variables for
32496 the various modes.  The mode settings are restored to their
32497 original values when @code{calc-eval} is done.
32499 For example, @samp{(calc-eval '("$+$$" calc-internal-prec 8) 'num a b)}
32500 computes the sum of two numbers, requiring a numeric result, and
32501 using default mode settings except that the precision is 8 instead
32502 of the default of 12.
32504 It's usually best to use this form of @code{calc-eval} unless your
32505 program actually considers the interaction with Calc's mode settings
32506 to be a feature.  This will avoid all sorts of potential ``gotchas'';
32507 consider what happens with @samp{(calc-eval "sqrt(2)" 'num)}
32508 when the user has left Calc in Symbolic mode or No-Simplify mode.
32510 As another example, @samp{(equal (calc-eval '("$<$$") nil a b) "1")}
32511 checks if the number in string @expr{a} is less than the one in
32512 string @expr{b}.  Without using a list, the integer 1 might
32513 come out in a variety of formats which would be hard to test for
32514 conveniently: @code{"1"}, @code{"8#1"}, @code{"00001"}.  (But
32515 see ``Predicates'' mode, below.)
32517 @ifinfo
32518 @example
32520 @end example
32521 @end ifinfo
32522 @subsubsection Raw Numbers
32524 @noindent
32525 Normally all input and output for @code{calc-eval} is done with strings.
32526 You can do arithmetic with, say, @samp{(calc-eval "$+$$" nil a b)}
32527 in place of @samp{(+ a b)}, but this is very inefficient since the
32528 numbers must be converted to and from string format as they are passed
32529 from one @code{calc-eval} to the next.
32531 If the separator is the symbol @code{raw}, the result will be returned
32532 as a raw Calc data structure rather than a string.  You can read about
32533 how these objects look in the following sections, but usually you can
32534 treat them as ``black box'' objects with no important internal
32535 structure.
32537 There is also a @code{rawnum} symbol, which is a combination of
32538 @code{raw} (returning a raw Calc object) and @code{num} (signaling
32539 an error if that object is not a constant).
32541 You can pass a raw Calc object to @code{calc-eval} in place of a
32542 string, either as the formula itself or as one of the @samp{$}
32543 arguments.  Thus @samp{(calc-eval "$+$$" 'raw a b)} is an
32544 addition function that operates on raw Calc objects.  Of course
32545 in this case it would be easier to call the low-level @code{math-add}
32546 function in Calc, if you can remember its name.
32548 In particular, note that a plain Lisp integer is acceptable to Calc
32549 as a raw object.  (All Lisp integers are accepted on input, but
32550 integers of more than six decimal digits are converted to ``big-integer''
32551 form for output.  @xref{Data Type Formats}.)
32553 When it comes time to display the object, just use @samp{(calc-eval a)}
32554 to format it as a string.
32556 It is an error if the input expression evaluates to a list of
32557 values.  The separator symbol @code{list} is like @code{raw}
32558 except that it returns a list of one or more raw Calc objects.
32560 Note that a Lisp string is not a valid Calc object, nor is a list
32561 containing a string.  Thus you can still safely distinguish all the
32562 various kinds of error returns discussed above.
32564 @ifinfo
32565 @example
32567 @end example
32568 @end ifinfo
32569 @subsubsection Predicates
32571 @noindent
32572 If the separator symbol is @code{pred}, the result of the formula is
32573 treated as a true/false value; @code{calc-eval} returns @code{t} or
32574 @code{nil}, respectively.  A value is considered ``true'' if it is a
32575 non-zero number, or false if it is zero or if it is not a number.
32577 For example, @samp{(calc-eval "$<$$" 'pred a b)} tests whether
32578 one value is less than another.
32580 As usual, it is also possible for @code{calc-eval} to return one of
32581 the error indicators described above.  Lisp will interpret such an
32582 indicator as ``true'' if you don't check for it explicitly.  If you
32583 wish to have an error register as ``false'', use something like
32584 @samp{(eq (calc-eval ...) t)}.
32586 @ifinfo
32587 @example
32589 @end example
32590 @end ifinfo
32591 @subsubsection Variable Values
32593 @noindent
32594 Variables in the formula passed to @code{calc-eval} are not normally
32595 replaced by their values.  If you wish this, you can use the
32596 @code{evalv} function (@pxref{Algebraic Manipulation}).  For example,
32597 if 4 is stored in Calc variable @code{a} (i.e., in Lisp variable
32598 @code{var-a}), then @samp{(calc-eval "a+pi")} will return the
32599 formula @code{"a + pi"}, but @samp{(calc-eval "evalv(a+pi)")}
32600 will return @code{"7.14159265359"}.
32602 To store in a Calc variable, just use @code{setq} to store in the
32603 corresponding Lisp variable.  (This is obtained by prepending
32604 @samp{var-} to the Calc variable name.)  Calc routines will
32605 understand either string or raw form values stored in variables,
32606 although raw data objects are much more efficient.  For example,
32607 to increment the Calc variable @code{a}:
32609 @example
32610 (setq var-a (calc-eval "evalv(a+1)" 'raw))
32611 @end example
32613 @ifinfo
32614 @example
32616 @end example
32617 @end ifinfo
32618 @subsubsection Stack Access
32620 @noindent
32621 If the separator symbol is @code{push}, the formula argument is
32622 evaluated (with possible @samp{$} expansions, as usual).  The
32623 result is pushed onto the Calc stack.  The return value is @code{nil}
32624 (unless there is an error from evaluating the formula, in which
32625 case the return value depends on @code{calc-eval-error} in the
32626 usual way).
32628 If the separator symbol is @code{pop}, the first argument to
32629 @code{calc-eval} must be an integer instead of a string.  That
32630 many values are popped from the stack and thrown away.  A negative
32631 argument deletes the entry at that stack level.  The return value
32632 is the number of elements remaining in the stack after popping;
32633 @samp{(calc-eval 0 'pop)} is a good way to measure the size of
32634 the stack.
32636 If the separator symbol is @code{top}, the first argument to
32637 @code{calc-eval} must again be an integer.  The value at that
32638 stack level is formatted as a string and returned.  Thus
32639 @samp{(calc-eval 1 'top)} returns the top-of-stack value.  If the
32640 integer is out of range, @code{nil} is returned.
32642 The separator symbol @code{rawtop} is just like @code{top} except
32643 that the stack entry is returned as a raw Calc object instead of
32644 as a string.
32646 In all of these cases the first argument can be made a list in
32647 order to force the default mode settings, as described above.
32648 Thus @samp{(calc-eval '(2 calc-number-radix 16) 'top)} returns the
32649 second-to-top stack entry, formatted as a string using the default
32650 instead of current display modes, except that the radix is
32651 hexadecimal instead of decimal.
32653 It is, of course, polite to put the Calc stack back the way you
32654 found it when you are done, unless the user of your program is
32655 actually expecting it to affect the stack.
32657 Note that you do not actually have to switch into the @samp{*Calculator*}
32658 buffer in order to use @code{calc-eval}; it temporarily switches into
32659 the stack buffer if necessary.
32661 @ifinfo
32662 @example
32664 @end example
32665 @end ifinfo
32666 @subsubsection Keyboard Macros
32668 @noindent
32669 If the separator symbol is @code{macro}, the first argument must be a
32670 string of characters which Calc can execute as a sequence of keystrokes.
32671 This switches into the Calc buffer for the duration of the macro.
32672 For example, @samp{(calc-eval "vx5\rVR+" 'macro)} pushes the
32673 vector @samp{[1,2,3,4,5]} on the stack and then replaces it
32674 with the sum of those numbers.  Note that @samp{\r} is the Lisp
32675 notation for the carriage-return, @key{RET}, character.
32677 If your keyboard macro wishes to pop the stack, @samp{\C-d} is
32678 safer than @samp{\177} (the @key{DEL} character) because some
32679 installations may have switched the meanings of @key{DEL} and
32680 @kbd{C-h}.  Calc always interprets @kbd{C-d} as a synonym for
32681 ``pop-stack'' regardless of key mapping.
32683 If you provide a third argument to @code{calc-eval}, evaluation
32684 of the keyboard macro will leave a record in the Trail using
32685 that argument as a tag string.  Normally the Trail is unaffected.
32687 The return value in this case is always @code{nil}.
32689 @ifinfo
32690 @example
32692 @end example
32693 @end ifinfo
32694 @subsubsection Lisp Evaluation
32696 @noindent
32697 Finally, if the separator symbol is @code{eval}, then the Lisp
32698 @code{eval} function is called on the first argument, which must
32699 be a Lisp expression rather than a Calc formula.  Remember to
32700 quote the expression so that it is not evaluated until inside
32701 @code{calc-eval}.
32703 The difference from plain @code{eval} is that @code{calc-eval}
32704 switches to the Calc buffer before evaluating the expression.
32705 For example, @samp{(calc-eval '(setq calc-internal-prec 17) 'eval)}
32706 will correctly affect the buffer-local Calc precision variable.
32708 An alternative would be @samp{(calc-eval '(calc-precision 17) 'eval)}.
32709 This is evaluating a call to the function that is normally invoked
32710 by the @kbd{p} key, giving it 17 as its ``numeric prefix argument.''
32711 Note that this function will leave a message in the echo area as
32712 a side effect.  Also, all Calc functions switch to the Calc buffer
32713 automatically if not invoked from there, so the above call is
32714 also equivalent to @samp{(calc-precision 17)} by itself.
32715 In all cases, Calc uses @code{save-excursion} to switch back to
32716 your original buffer when it is done.
32718 As usual the first argument can be a list that begins with a Lisp
32719 expression to use default instead of current mode settings.
32721 The result of @code{calc-eval} in this usage is just the result
32722 returned by the evaluated Lisp expression.
32724 @ifinfo
32725 @example
32727 @end example
32728 @end ifinfo
32729 @subsubsection Example
32731 @noindent
32732 @findex convert-temp
32733 Here is a sample Emacs command that uses @code{calc-eval}.  Suppose
32734 you have a document with lots of references to temperatures on the
32735 Fahrenheit scale, say ``98.6 F'', and you wish to convert these
32736 references to Centigrade.  The following command does this conversion.
32737 Place the Emacs cursor right after the letter ``F'' and invoke the
32738 command to change ``98.6 F'' to ``37 C''.  Or, if the temperature is
32739 already in Centigrade form, the command changes it back to Fahrenheit.
32741 @example
32742 (defun convert-temp ()
32743   (interactive)
32744   (save-excursion
32745     (re-search-backward "[^-.0-9]\\([-.0-9]+\\) *\\([FC]\\)")
32746     (let* ((top1 (match-beginning 1))
32747            (bot1 (match-end 1))
32748            (number (buffer-substring top1 bot1))
32749            (top2 (match-beginning 2))
32750            (bot2 (match-end 2))
32751            (type (buffer-substring top2 bot2)))
32752       (if (equal type "F")
32753           (setq type "C"
32754                 number (calc-eval "($ - 32)*5/9" nil number))
32755         (setq type "F"
32756               number (calc-eval "$*9/5 + 32" nil number)))
32757       (goto-char top2)
32758       (delete-region top2 bot2)
32759       (insert-before-markers type)
32760       (goto-char top1)
32761       (delete-region top1 bot1)
32762       (if (string-match "\\.$" number)   ; change "37." to "37"
32763           (setq number (substring number 0 -1)))
32764       (insert number))))
32765 @end example
32767 Note the use of @code{insert-before-markers} when changing between
32768 ``F'' and ``C'', so that the character winds up before the cursor
32769 instead of after it.
32771 @node Internals, , Calling Calc from Your Programs, Lisp Definitions
32772 @subsection Calculator Internals
32774 @noindent
32775 This section describes the Lisp functions defined by the Calculator that
32776 may be of use to user-written Calculator programs (as described in the
32777 rest of this chapter).  These functions are shown by their names as they
32778 conventionally appear in @code{defmath}.  Their full Lisp names are
32779 generally gotten by prepending @samp{calcFunc-} or @samp{math-} to their
32780 apparent names.  (Names that begin with @samp{calc-} are already in
32781 their full Lisp form.)  You can use the actual full names instead if you
32782 prefer them, or if you are calling these functions from regular Lisp.
32784 The functions described here are scattered throughout the various
32785 Calc component files.  Note that @file{calc.el} includes @code{autoload}s
32786 for only a few component files; when Calc wants to call an advanced
32787 function it calls @samp{(calc-extensions)} first; this function
32788 autoloads @file{calc-ext.el}, which in turn autoloads all the functions
32789 in the remaining component files.
32791 Because @code{defmath} itself uses the extensions, user-written code
32792 generally always executes with the extensions already loaded, so
32793 normally you can use any Calc function and be confident that it will
32794 be autoloaded for you when necessary.  If you are doing something
32795 special, check carefully to make sure each function you are using is
32796 from @file{calc.el} or its components, and call @samp{(calc-extensions)}
32797 before using any function based in @file{calc-ext.el} if you can't
32798 prove this file will already be loaded.
32800 @menu
32801 * Data Type Formats::
32802 * Interactive Lisp Functions::
32803 * Stack Lisp Functions::
32804 * Predicates::
32805 * Computational Lisp Functions::
32806 * Vector Lisp Functions::
32807 * Symbolic Lisp Functions::
32808 * Formatting Lisp Functions::
32809 * Hooks::
32810 @end menu
32812 @node Data Type Formats, Interactive Lisp Functions, Internals, Internals
32813 @subsubsection Data Type Formats
32815 @noindent
32816 Integers are stored in either of two ways, depending on their magnitude.
32817 Integers less than one million in absolute value are stored as standard
32818 Lisp integers.  This is the only storage format for Calc data objects
32819 which is not a Lisp list.
32821 Large integers are stored as lists of the form @samp{(bigpos @var{d0}
32822 @var{d1} @var{d2} @dots{})} for positive integers 1000000 or more, or
32823 @samp{(bigneg @var{d0} @var{d1} @var{d2} @dots{})} for negative integers
32824 @mathit{-1000000} or less.  Each @var{d} is a base-1000 ``digit,'' a Lisp integer
32825 from 0 to 999.  The least significant digit is @var{d0}; the last digit,
32826 @var{dn}, which is always nonzero, is the most significant digit.  For
32827 example, the integer @mathit{-12345678} is stored as @samp{(bigneg 678 345 12)}.
32829 The distinction between small and large integers is entirely hidden from
32830 the user.  In @code{defmath} definitions, the Lisp predicate @code{integerp}
32831 returns true for either kind of integer, and in general both big and small
32832 integers are accepted anywhere the word ``integer'' is used in this manual.
32833 If the distinction must be made, native Lisp integers are called @dfn{fixnums}
32834 and large integers are called @dfn{bignums}.
32836 Fractions are stored as a list of the form, @samp{(frac @var{n} @var{d})}
32837 where @var{n} is an integer (big or small) numerator, @var{d} is an
32838 integer denominator greater than one, and @var{n} and @var{d} are relatively
32839 prime.  Note that fractions where @var{d} is one are automatically converted
32840 to plain integers by all math routines; fractions where @var{d} is negative
32841 are normalized by negating the numerator and denominator.
32843 Floating-point numbers are stored in the form, @samp{(float @var{mant}
32844 @var{exp})}, where @var{mant} (the ``mantissa'') is an integer less than
32845 @samp{10^@var{p}} in absolute value (@var{p} represents the current
32846 precision), and @var{exp} (the ``exponent'') is a fixnum.  The value of
32847 the float is @samp{@var{mant} * 10^@var{exp}}.  For example, the number
32848 @mathit{-3.14} is stored as @samp{(float -314 -2) = -314*10^-2}.  Other constraints
32849 are that the number 0.0 is always stored as @samp{(float 0 0)}, and,
32850 except for the 0.0 case, the rightmost base-10 digit of @var{mant} is
32851 always nonzero.  (If the rightmost digit is zero, the number is
32852 rearranged by dividing @var{mant} by ten and incrementing @var{exp}.)
32854 Rectangular complex numbers are stored in the form @samp{(cplx @var{re}
32855 @var{im})}, where @var{re} and @var{im} are each real numbers, either
32856 integers, fractions, or floats.  The value is @samp{@var{re} + @var{im}i}.
32857 The @var{im} part is nonzero; complex numbers with zero imaginary
32858 components are converted to real numbers automatically.
32860 Polar complex numbers are stored in the form @samp{(polar @var{r}
32861 @var{theta})}, where @var{r} is a positive real value and @var{theta}
32862 is a real value or HMS form representing an angle.  This angle is
32863 usually normalized to lie in the interval @samp{(-180 ..@: 180)} degrees,
32864 or @samp{(-pi ..@: pi)} radians, according to the current angular mode.
32865 If the angle is 0 the value is converted to a real number automatically.
32866 (If the angle is 180 degrees, the value is usually also converted to a
32867 negative real number.)
32869 Hours-minutes-seconds forms are stored as @samp{(hms @var{h} @var{m}
32870 @var{s})}, where @var{h} is an integer or an integer-valued float (i.e.,
32871 a float with @samp{@var{exp} >= 0}), @var{m} is an integer or integer-valued
32872 float in the range @w{@samp{[0 ..@: 60)}}, and @var{s} is any real number
32873 in the range @samp{[0 ..@: 60)}.
32875 Date forms are stored as @samp{(date @var{n})}, where @var{n} is
32876 a real number that counts days since midnight on the morning of
32877 January 1, 1 AD.  If @var{n} is an integer, this is a pure date
32878 form.  If @var{n} is a fraction or float, this is a date/time form.
32880 Modulo forms are stored as @samp{(mod @var{n} @var{m})}, where @var{m} is a
32881 positive real number or HMS form, and @var{n} is a real number or HMS
32882 form in the range @samp{[0 ..@: @var{m})}.
32884 Error forms are stored as @samp{(sdev @var{x} @var{sigma})}, where @var{x}
32885 is the mean value and @var{sigma} is the standard deviation.  Each
32886 component is either a number, an HMS form, or a symbolic object
32887 (a variable or function call).  If @var{sigma} is zero, the value is
32888 converted to a plain real number.  If @var{sigma} is negative or
32889 complex, it is automatically normalized to be a positive real.
32891 Interval forms are stored as @samp{(intv @var{mask} @var{lo} @var{hi})},
32892 where @var{mask} is one of the integers 0, 1, 2, or 3, and @var{lo} and
32893 @var{hi} are real numbers, HMS forms, or symbolic objects.  The @var{mask}
32894 is a binary integer where 1 represents the fact that the interval is
32895 closed on the high end, and 2 represents the fact that it is closed on
32896 the low end.  (Thus 3 represents a fully closed interval.)  The interval
32897 @w{@samp{(intv 3 @var{x} @var{x})}} is converted to the plain number @var{x};
32898 intervals @samp{(intv @var{mask} @var{x} @var{x})} for any other @var{mask}
32899 represent empty intervals.  If @var{hi} is less than @var{lo}, the interval
32900 is converted to a standard empty interval by replacing @var{hi} with @var{lo}.
32902 Vectors are stored as @samp{(vec @var{v1} @var{v2} @dots{})}, where @var{v1}
32903 is the first element of the vector, @var{v2} is the second, and so on.
32904 An empty vector is stored as @samp{(vec)}.  A matrix is simply a vector
32905 where all @var{v}'s are themselves vectors of equal lengths.  Note that
32906 Calc vectors are unrelated to the Emacs Lisp ``vector'' type, which is
32907 generally unused by Calc data structures.
32909 Variables are stored as @samp{(var @var{name} @var{sym})}, where
32910 @var{name} is a Lisp symbol whose print name is used as the visible name
32911 of the variable, and @var{sym} is a Lisp symbol in which the variable's
32912 value is actually stored.  Thus, @samp{(var pi var-pi)} represents the
32913 special constant @samp{pi}.  Almost always, the form is @samp{(var
32914 @var{v} var-@var{v})}.  If the variable name was entered with @code{#}
32915 signs (which are converted to hyphens internally), the form is
32916 @samp{(var @var{u} @var{v})}, where @var{u} is a symbol whose name
32917 contains @code{#} characters, and @var{v} is a symbol that contains
32918 @code{-} characters instead.  The value of a variable is the Calc
32919 object stored in its @var{sym} symbol's value cell.  If the symbol's
32920 value cell is void or if it contains @code{nil}, the variable has no
32921 value.  Special constants have the form @samp{(special-const
32922 @var{value})} stored in their value cell, where @var{value} is a formula
32923 which is evaluated when the constant's value is requested.  Variables
32924 which represent units are not stored in any special way; they are units
32925 only because their names appear in the units table.  If the value
32926 cell contains a string, it is parsed to get the variable's value when
32927 the variable is used.
32929 A Lisp list with any other symbol as the first element is a function call.
32930 The symbols @code{+}, @code{-}, @code{*}, @code{/}, @code{%}, @code{^},
32931 and @code{|} represent special binary operators; these lists are always
32932 of the form @samp{(@var{op} @var{lhs} @var{rhs})} where @var{lhs} is the
32933 sub-formula on the lefthand side and @var{rhs} is the sub-formula on the
32934 right.  The symbol @code{neg} represents unary negation; this list is always
32935 of the form @samp{(neg @var{arg})}.  Any other symbol @var{func} represents a
32936 function that would be displayed in function-call notation; the symbol
32937 @var{func} is in general always of the form @samp{calcFunc-@var{name}}.
32938 The function cell of the symbol @var{func} should contain a Lisp function
32939 for evaluating a call to @var{func}.  This function is passed the remaining
32940 elements of the list (themselves already evaluated) as arguments; such
32941 functions should return @code{nil} or call @code{reject-arg} to signify
32942 that they should be left in symbolic form, or they should return a Calc
32943 object which represents their value, or a list of such objects if they
32944 wish to return multiple values.  (The latter case is allowed only for
32945 functions which are the outer-level call in an expression whose value is
32946 about to be pushed on the stack; this feature is considered obsolete
32947 and is not used by any built-in Calc functions.)
32949 @node Interactive Lisp Functions, Stack Lisp Functions, Data Type Formats, Internals
32950 @subsubsection Interactive Functions
32952 @noindent
32953 The functions described here are used in implementing interactive Calc
32954 commands.  Note that this list is not exhaustive!  If there is an
32955 existing command that behaves similarly to the one you want to define,
32956 you may find helpful tricks by checking the source code for that command.
32958 @defun calc-set-command-flag flag
32959 Set the command flag @var{flag}.  This is generally a Lisp symbol, but
32960 may in fact be anything.  The effect is to add @var{flag} to the list
32961 stored in the variable @code{calc-command-flags}, unless it is already
32962 there.  @xref{Defining Simple Commands}.
32963 @end defun
32965 @defun calc-clear-command-flag flag
32966 If @var{flag} appears among the list of currently-set command flags,
32967 remove it from that list.
32968 @end defun
32970 @defun calc-record-undo rec
32971 Add the ``undo record'' @var{rec} to the list of steps to take if the
32972 current operation should need to be undone.  Stack push and pop functions
32973 automatically call @code{calc-record-undo}, so the kinds of undo records
32974 you might need to create take the form @samp{(set @var{sym} @var{value})},
32975 which says that the Lisp variable @var{sym} was changed and had previously
32976 contained @var{value}; @samp{(store @var{var} @var{value})} which says that
32977 the Calc variable @var{var} (a string which is the name of the symbol that
32978 contains the variable's value) was stored and its previous value was
32979 @var{value} (either a Calc data object, or @code{nil} if the variable was
32980 previously void); or @samp{(eval @var{undo} @var{redo} @var{args} @dots{})},
32981 which means that to undo requires calling the function @samp{(@var{undo}
32982 @var{args} @dots{})} and, if the undo is later redone, calling
32983 @samp{(@var{redo} @var{args} @dots{})}.
32984 @end defun
32986 @defun calc-record-why msg args
32987 Record the error or warning message @var{msg}, which is normally a string.
32988 This message will be replayed if the user types @kbd{w} (@code{calc-why});
32989 if the message string begins with a @samp{*}, it is considered important
32990 enough to display even if the user doesn't type @kbd{w}.  If one or more
32991 @var{args} are present, the displayed message will be of the form,
32992 @samp{@var{msg}: @var{arg1}, @var{arg2}, @dots{}}, where the arguments are
32993 formatted on the assumption that they are either strings or Calc objects of
32994 some sort.  If @var{msg} is a symbol, it is the name of a Calc predicate
32995 (such as @code{integerp} or @code{numvecp}) which the arguments did not
32996 satisfy; it is expanded to a suitable string such as ``Expected an
32997 integer.''  The @code{reject-arg} function calls @code{calc-record-why}
32998 automatically; @pxref{Predicates}.
32999 @end defun
33001 @defun calc-is-inverse
33002 This predicate returns true if the current command is inverse,
33003 i.e., if the Inverse (@kbd{I} key) flag was set.
33004 @end defun
33006 @defun calc-is-hyperbolic
33007 This predicate is the analogous function for the @kbd{H} key.
33008 @end defun
33010 @node Stack Lisp Functions, Predicates, Interactive Lisp Functions, Internals
33011 @subsubsection Stack-Oriented Functions
33013 @noindent
33014 The functions described here perform various operations on the Calc
33015 stack and trail.  They are to be used in interactive Calc commands.
33017 @defun calc-push-list vals n
33018 Push the Calc objects in list @var{vals} onto the stack at stack level
33019 @var{n}.  If @var{n} is omitted it defaults to 1, so that the elements
33020 are pushed at the top of the stack.  If @var{n} is greater than 1, the
33021 elements will be inserted into the stack so that the last element will
33022 end up at level @var{n}, the next-to-last at level @var{n}+1, etc.
33023 The elements of @var{vals} are assumed to be valid Calc objects, and
33024 are not evaluated, rounded, or renormalized in any way.  If @var{vals}
33025 is an empty list, nothing happens.
33027 The stack elements are pushed without any sub-formula selections.
33028 You can give an optional third argument to this function, which must
33029 be a list the same size as @var{vals} of selections.  Each selection
33030 must be @code{eq} to some sub-formula of the corresponding formula
33031 in @var{vals}, or @code{nil} if that formula should have no selection.
33032 @end defun
33034 @defun calc-top-list n m
33035 Return a list of the @var{n} objects starting at level @var{m} of the
33036 stack.  If @var{m} is omitted it defaults to 1, so that the elements are
33037 taken from the top of the stack.  If @var{n} is omitted, it also
33038 defaults to 1, so that the top stack element (in the form of a
33039 one-element list) is returned.  If @var{m} is greater than 1, the
33040 @var{m}th stack element will be at the end of the list, the @var{m}+1st
33041 element will be next-to-last, etc.  If @var{n} or @var{m} are out of
33042 range, the command is aborted with a suitable error message.  If @var{n}
33043 is zero, the function returns an empty list.  The stack elements are not
33044 evaluated, rounded, or renormalized.
33046 If any stack elements contain selections, and selections have not
33047 been disabled by the @kbd{j e} (@code{calc-enable-selections}) command,
33048 this function returns the selected portions rather than the entire
33049 stack elements.  It can be given a third ``selection-mode'' argument
33050 which selects other behaviors.  If it is the symbol @code{t}, then
33051 a selection in any of the requested stack elements produces an
33052 ``invalid operation on selections'' error.  If it is the symbol @code{full},
33053 the whole stack entry is always returned regardless of selections.
33054 If it is the symbol @code{sel}, the selected portion is always returned,
33055 or @code{nil} if there is no selection.  (This mode ignores the @kbd{j e}
33056 command.)  If the symbol is @code{entry}, the complete stack entry in
33057 list form is returned; the first element of this list will be the whole
33058 formula, and the third element will be the selection (or @code{nil}).
33059 @end defun
33061 @defun calc-pop-stack n m
33062 Remove the specified elements from the stack.  The parameters @var{n}
33063 and @var{m} are defined the same as for @code{calc-top-list}.  The return
33064 value of @code{calc-pop-stack} is uninteresting.
33066 If there are any selected sub-formulas among the popped elements, and
33067 @kbd{j e} has not been used to disable selections, this produces an
33068 error without changing the stack.  If you supply an optional third
33069 argument of @code{t}, the stack elements are popped even if they
33070 contain selections.
33071 @end defun
33073 @defun calc-record-list vals tag
33074 This function records one or more results in the trail.  The @var{vals}
33075 are a list of strings or Calc objects.  The @var{tag} is the four-character
33076 tag string to identify the values.  If @var{tag} is omitted, a blank tag
33077 will be used.
33078 @end defun
33080 @defun calc-normalize n
33081 This function takes a Calc object and ``normalizes'' it.  At the very
33082 least this involves re-rounding floating-point values according to the
33083 current precision and other similar jobs.  Also, unless the user has
33084 selected No-Simplify mode (@pxref{Simplification Modes}), this involves
33085 actually evaluating a formula object by executing the function calls
33086 it contains, and possibly also doing algebraic simplification, etc.
33087 @end defun
33089 @defun calc-top-list-n n m
33090 This function is identical to @code{calc-top-list}, except that it calls
33091 @code{calc-normalize} on the values that it takes from the stack.  They
33092 are also passed through @code{check-complete}, so that incomplete
33093 objects will be rejected with an error message.  All computational
33094 commands should use this in preference to @code{calc-top-list}; the only
33095 standard Calc commands that operate on the stack without normalizing
33096 are stack management commands like @code{calc-enter} and @code{calc-roll-up}.
33097 This function accepts the same optional selection-mode argument as
33098 @code{calc-top-list}.
33099 @end defun
33101 @defun calc-top-n m
33102 This function is a convenient form of @code{calc-top-list-n} in which only
33103 a single element of the stack is taken and returned, rather than a list
33104 of elements.  This also accepts an optional selection-mode argument.
33105 @end defun
33107 @defun calc-enter-result n tag vals
33108 This function is a convenient interface to most of the above functions.
33109 The @var{vals} argument should be either a single Calc object, or a list
33110 of Calc objects; the object or objects are normalized, and the top @var{n}
33111 stack entries are replaced by the normalized objects.  If @var{tag} is
33112 non-@code{nil}, the normalized objects are also recorded in the trail.
33113 A typical stack-based computational command would take the form,
33115 @smallexample
33116 (calc-enter-result @var{n} @var{tag} (cons 'calcFunc-@var{func}
33117                                (calc-top-list-n @var{n})))
33118 @end smallexample
33120 If any of the @var{n} stack elements replaced contain sub-formula
33121 selections, and selections have not been disabled by @kbd{j e},
33122 this function takes one of two courses of action.  If @var{n} is
33123 equal to the number of elements in @var{vals}, then each element of
33124 @var{vals} is spliced into the corresponding selection; this is what
33125 happens when you use the @key{TAB} key, or when you use a unary
33126 arithmetic operation like @code{sqrt}.  If @var{vals} has only one
33127 element but @var{n} is greater than one, there must be only one
33128 selection among the top @var{n} stack elements; the element from
33129 @var{vals} is spliced into that selection.  This is what happens when
33130 you use a binary arithmetic operation like @kbd{+}.  Any other
33131 combination of @var{n} and @var{vals} is an error when selections
33132 are present.
33133 @end defun
33135 @defun calc-unary-op tag func arg
33136 This function implements a unary operator that allows a numeric prefix
33137 argument to apply the operator over many stack entries.  If the prefix
33138 argument @var{arg} is @code{nil}, this uses @code{calc-enter-result}
33139 as outlined above.  Otherwise, it maps the function over several stack
33140 elements; @pxref{Prefix Arguments}.  For example,
33142 @smallexample
33143 (defun calc-zeta (arg)
33144   (interactive "P")
33145   (calc-unary-op "zeta" 'calcFunc-zeta arg))
33146 @end smallexample
33147 @end defun
33149 @defun calc-binary-op tag func arg ident unary
33150 This function implements a binary operator, analogously to
33151 @code{calc-unary-op}.  The optional @var{ident} and @var{unary}
33152 arguments specify the behavior when the prefix argument is zero or
33153 one, respectively.  If the prefix is zero, the value @var{ident}
33154 is pushed onto the stack, if specified, otherwise an error message
33155 is displayed.  If the prefix is one, the unary function @var{unary}
33156 is applied to the top stack element, or, if @var{unary} is not
33157 specified, nothing happens.  When the argument is two or more,
33158 the binary function @var{func} is reduced across the top @var{arg}
33159 stack elements; when the argument is negative, the function is
33160 mapped between the next-to-top @mathit{-@var{arg}} stack elements and the
33161 top element.
33162 @end defun
33164 @defun calc-stack-size
33165 Return the number of elements on the stack as an integer.  This count
33166 does not include elements that have been temporarily hidden by stack
33167 truncation; @pxref{Truncating the Stack}.
33168 @end defun
33170 @defun calc-cursor-stack-index n
33171 Move the point to the @var{n}th stack entry.  If @var{n} is zero, this
33172 will be the @samp{.} line.  If @var{n} is from 1 to the current stack size,
33173 this will be the beginning of the first line of that stack entry's display.
33174 If line numbers are enabled, this will move to the first character of the
33175 line number, not the stack entry itself.
33176 @end defun
33178 @defun calc-substack-height n
33179 Return the number of lines between the beginning of the @var{n}th stack
33180 entry and the bottom of the buffer.  If @var{n} is zero, this
33181 will be one (assuming no stack truncation).  If all stack entries are
33182 one line long (i.e., no matrices are displayed), the return value will
33183 be equal @var{n}+1 as long as @var{n} is in range.  (Note that in Big
33184 mode, the return value includes the blank lines that separate stack
33185 entries.)
33186 @end defun
33188 @defun calc-refresh
33189 Erase the @code{*Calculator*} buffer and reformat its contents from memory.
33190 This must be called after changing any parameter, such as the current
33191 display radix, which might change the appearance of existing stack
33192 entries.  (During a keyboard macro invoked by the @kbd{X} key, refreshing
33193 is suppressed, but a flag is set so that the entire stack will be refreshed
33194 rather than just the top few elements when the macro finishes.)
33195 @end defun
33197 @node Predicates, Computational Lisp Functions, Stack Lisp Functions, Internals
33198 @subsubsection Predicates
33200 @noindent
33201 The functions described here are predicates, that is, they return a
33202 true/false value where @code{nil} means false and anything else means
33203 true.  These predicates are expanded by @code{defmath}, for example,
33204 from @code{zerop} to @code{math-zerop}.  In many cases they correspond
33205 to native Lisp functions by the same name, but are extended to cover
33206 the full range of Calc data types.
33208 @defun zerop x
33209 Returns true if @var{x} is numerically zero, in any of the Calc data
33210 types.  (Note that for some types, such as error forms and intervals,
33211 it never makes sense to return true.)  In @code{defmath}, the expression
33212 @samp{(= x 0)} will automatically be converted to @samp{(math-zerop x)},
33213 and @samp{(/= x 0)} will be converted to @samp{(not (math-zerop x))}.
33214 @end defun
33216 @defun negp x
33217 Returns true if @var{x} is negative.  This accepts negative real numbers
33218 of various types, negative HMS and date forms, and intervals in which
33219 all included values are negative.  In @code{defmath}, the expression
33220 @samp{(< x 0)} will automatically be converted to @samp{(math-negp x)},
33221 and @samp{(>= x 0)} will be converted to @samp{(not (math-negp x))}.
33222 @end defun
33224 @defun posp x
33225 Returns true if @var{x} is positive (and non-zero).  For complex
33226 numbers, none of these three predicates will return true.
33227 @end defun
33229 @defun looks-negp x
33230 Returns true if @var{x} is ``negative-looking.''  This returns true if
33231 @var{x} is a negative number, or a formula with a leading minus sign
33232 such as @samp{-a/b}.  In other words, this is an object which can be
33233 made simpler by calling @code{(- @var{x})}.
33234 @end defun
33236 @defun integerp x
33237 Returns true if @var{x} is an integer of any size.
33238 @end defun
33240 @defun fixnump x
33241 Returns true if @var{x} is a native Lisp integer.
33242 @end defun
33244 @defun natnump x
33245 Returns true if @var{x} is a nonnegative integer of any size.
33246 @end defun
33248 @defun fixnatnump x
33249 Returns true if @var{x} is a nonnegative Lisp integer.
33250 @end defun
33252 @defun num-integerp x
33253 Returns true if @var{x} is numerically an integer, i.e., either a
33254 true integer or a float with no significant digits to the right of
33255 the decimal point.
33256 @end defun
33258 @defun messy-integerp x
33259 Returns true if @var{x} is numerically, but not literally, an integer.
33260 A value is @code{num-integerp} if it is @code{integerp} or
33261 @code{messy-integerp} (but it is never both at once).
33262 @end defun
33264 @defun num-natnump x
33265 Returns true if @var{x} is numerically a nonnegative integer.
33266 @end defun
33268 @defun evenp x
33269 Returns true if @var{x} is an even integer.
33270 @end defun
33272 @defun looks-evenp x
33273 Returns true if @var{x} is an even integer, or a formula with a leading
33274 multiplicative coefficient which is an even integer.
33275 @end defun
33277 @defun oddp x
33278 Returns true if @var{x} is an odd integer.
33279 @end defun
33281 @defun ratp x
33282 Returns true if @var{x} is a rational number, i.e., an integer or a
33283 fraction.
33284 @end defun
33286 @defun realp x
33287 Returns true if @var{x} is a real number, i.e., an integer, fraction,
33288 or floating-point number.
33289 @end defun
33291 @defun anglep x
33292 Returns true if @var{x} is a real number or HMS form.
33293 @end defun
33295 @defun floatp x
33296 Returns true if @var{x} is a float, or a complex number, error form,
33297 interval, date form, or modulo form in which at least one component
33298 is a float.
33299 @end defun
33301 @defun complexp x
33302 Returns true if @var{x} is a rectangular or polar complex number
33303 (but not a real number).
33304 @end defun
33306 @defun rect-complexp x
33307 Returns true if @var{x} is a rectangular complex number.
33308 @end defun
33310 @defun polar-complexp x
33311 Returns true if @var{x} is a polar complex number.
33312 @end defun
33314 @defun numberp x
33315 Returns true if @var{x} is a real number or a complex number.
33316 @end defun
33318 @defun scalarp x
33319 Returns true if @var{x} is a real or complex number or an HMS form.
33320 @end defun
33322 @defun vectorp x
33323 Returns true if @var{x} is a vector (this simply checks if its argument
33324 is a list whose first element is the symbol @code{vec}).
33325 @end defun
33327 @defun numvecp x
33328 Returns true if @var{x} is a number or vector.
33329 @end defun
33331 @defun matrixp x
33332 Returns true if @var{x} is a matrix, i.e., a vector of one or more vectors,
33333 all of the same size.
33334 @end defun
33336 @defun square-matrixp x
33337 Returns true if @var{x} is a square matrix.
33338 @end defun
33340 @defun objectp x
33341 Returns true if @var{x} is any numeric Calc object, including real and
33342 complex numbers, HMS forms, date forms, error forms, intervals, and
33343 modulo forms.  (Note that error forms and intervals may include formulas
33344 as their components; see @code{constp} below.)
33345 @end defun
33347 @defun objvecp x
33348 Returns true if @var{x} is an object or a vector.  This also accepts
33349 incomplete objects, but it rejects variables and formulas (except as
33350 mentioned above for @code{objectp}).
33351 @end defun
33353 @defun primp x
33354 Returns true if @var{x} is a ``primitive'' or ``atomic'' Calc object,
33355 i.e., one whose components cannot be regarded as sub-formulas.  This
33356 includes variables, and all @code{objectp} types except error forms
33357 and intervals.
33358 @end defun
33360 @defun constp x
33361 Returns true if @var{x} is constant, i.e., a real or complex number,
33362 HMS form, date form, or error form, interval, or vector all of whose
33363 components are @code{constp}.
33364 @end defun
33366 @defun lessp x y
33367 Returns true if @var{x} is numerically less than @var{y}.  Returns false
33368 if @var{x} is greater than or equal to @var{y}, or if the order is
33369 undefined or cannot be determined.  Generally speaking, this works
33370 by checking whether @samp{@var{x} - @var{y}} is @code{negp}.  In
33371 @code{defmath}, the expression @samp{(< x y)} will automatically be
33372 converted to @samp{(lessp x y)}; expressions involving @code{>}, @code{<=},
33373 and @code{>=} are similarly converted in terms of @code{lessp}.
33374 @end defun
33376 @defun beforep x y
33377 Returns true if @var{x} comes before @var{y} in a canonical ordering
33378 of Calc objects.  If @var{x} and @var{y} are both real numbers, this
33379 will be the same as @code{lessp}.  But whereas @code{lessp} considers
33380 other types of objects to be unordered, @code{beforep} puts any two
33381 objects into a definite, consistent order.  The @code{beforep}
33382 function is used by the @kbd{V S} vector-sorting command, and also
33383 by @kbd{a s} to put the terms of a product into canonical order:
33384 This allows @samp{x y + y x} to be simplified easily to @samp{2 x y}.
33385 @end defun
33387 @defun equal x y
33388 This is the standard Lisp @code{equal} predicate; it returns true if
33389 @var{x} and @var{y} are structurally identical.  This is the usual way
33390 to compare numbers for equality, but note that @code{equal} will treat
33391 0 and 0.0 as different.
33392 @end defun
33394 @defun math-equal x y
33395 Returns true if @var{x} and @var{y} are numerically equal, either because
33396 they are @code{equal}, or because their difference is @code{zerop}.  In
33397 @code{defmath}, the expression @samp{(= x y)} will automatically be
33398 converted to @samp{(math-equal x y)}.
33399 @end defun
33401 @defun equal-int x n
33402 Returns true if @var{x} and @var{n} are numerically equal, where @var{n}
33403 is a fixnum which is not a multiple of 10.  This will automatically be
33404 used by @code{defmath} in place of the more general @code{math-equal}
33405 whenever possible.
33406 @end defun
33408 @defun nearly-equal x y
33409 Returns true if @var{x} and @var{y}, as floating-point numbers, are
33410 equal except possibly in the last decimal place.  For example,
33411 314.159 and 314.166 are considered nearly equal if the current
33412 precision is 6 (since they differ by 7 units), but not if the current
33413 precision is 7 (since they differ by 70 units).  Most functions which
33414 use series expansions use @code{with-extra-prec} to evaluate the
33415 series with 2 extra digits of precision, then use @code{nearly-equal}
33416 to decide when the series has converged; this guards against cumulative
33417 error in the series evaluation without doing extra work which would be
33418 lost when the result is rounded back down to the current precision.
33419 In @code{defmath}, this can be written @samp{(~= @var{x} @var{y})}.
33420 The @var{x} and @var{y} can be numbers of any kind, including complex.
33421 @end defun
33423 @defun nearly-zerop x y
33424 Returns true if @var{x} is nearly zero, compared to @var{y}.  This
33425 checks whether @var{x} plus @var{y} would by be @code{nearly-equal}
33426 to @var{y} itself, to within the current precision, in other words,
33427 if adding @var{x} to @var{y} would have a negligible effect on @var{y}
33428 due to roundoff error.  @var{X} may be a real or complex number, but
33429 @var{y} must be real.
33430 @end defun
33432 @defun is-true x
33433 Return true if the formula @var{x} represents a true value in
33434 Calc, not Lisp, terms.  It tests if @var{x} is a non-zero number
33435 or a provably non-zero formula.
33436 @end defun
33438 @defun reject-arg val pred
33439 Abort the current function evaluation due to unacceptable argument values.
33440 This calls @samp{(calc-record-why @var{pred} @var{val})}, then signals a
33441 Lisp error which @code{normalize} will trap.  The net effect is that the
33442 function call which led here will be left in symbolic form.
33443 @end defun
33445 @defun inexact-value
33446 If Symbolic mode is enabled, this will signal an error that causes
33447 @code{normalize} to leave the formula in symbolic form, with the message
33448 ``Inexact result.''  (This function has no effect when not in Symbolic mode.)
33449 Note that if your function calls @samp{(sin 5)} in Symbolic mode, the
33450 @code{sin} function will call @code{inexact-value}, which will cause your
33451 function to be left unsimplified.  You may instead wish to call
33452 @samp{(normalize (list 'calcFunc-sin 5))}, which in Symbolic mode will
33453 return the formula @samp{sin(5)} to your function.
33454 @end defun
33456 @defun overflow
33457 This signals an error that will be reported as a floating-point overflow.
33458 @end defun
33460 @defun underflow
33461 This signals a floating-point underflow.
33462 @end defun
33464 @node Computational Lisp Functions, Vector Lisp Functions, Predicates, Internals
33465 @subsubsection Computational Functions
33467 @noindent
33468 The functions described here do the actual computational work of the
33469 Calculator.  In addition to these, note that any function described in
33470 the main body of this manual may be called from Lisp; for example, if
33471 the documentation refers to the @code{calc-sqrt} [@code{sqrt}] command,
33472 this means @code{calc-sqrt} is an interactive stack-based square-root
33473 command and @code{sqrt} (which @code{defmath} expands to @code{calcFunc-sqrt})
33474 is the actual Lisp function for taking square roots.
33476 The functions @code{math-add}, @code{math-sub}, @code{math-mul},
33477 @code{math-div}, @code{math-mod}, and @code{math-neg} are not included
33478 in this list, since @code{defmath} allows you to write native Lisp
33479 @code{+}, @code{-}, @code{*}, @code{/}, @code{%}, and unary @code{-},
33480 respectively, instead.
33482 @defun normalize val
33483 (Full form: @code{math-normalize}.)
33484 Reduce the value @var{val} to standard form.  For example, if @var{val}
33485 is a fixnum, it will be converted to a bignum if it is too large, and
33486 if @var{val} is a bignum it will be normalized by clipping off trailing
33487 (i.e., most-significant) zero digits and converting to a fixnum if it is
33488 small.  All the various data types are similarly converted to their standard
33489 forms.  Variables are left alone, but function calls are actually evaluated
33490 in formulas.  For example, normalizing @samp{(+ 2 (calcFunc-abs -4))} will
33491 return 6.
33493 If a function call fails, because the function is void or has the wrong
33494 number of parameters, or because it returns @code{nil} or calls
33495 @code{reject-arg} or @code{inexact-result}, @code{normalize} returns
33496 the formula still in symbolic form.
33498 If the current simplification mode is ``none'' or ``numeric arguments
33499 only,'' @code{normalize} will act appropriately.  However, the more
33500 powerful simplification modes (like Algebraic Simplification) are
33501 not handled by @code{normalize}.  They are handled by @code{calc-normalize},
33502 which calls @code{normalize} and possibly some other routines, such
33503 as @code{simplify} or @code{simplify-units}.  Programs generally will
33504 never call @code{calc-normalize} except when popping or pushing values
33505 on the stack.
33506 @end defun
33508 @defun evaluate-expr expr
33509 Replace all variables in @var{expr} that have values with their values,
33510 then use @code{normalize} to simplify the result.  This is what happens
33511 when you press the @kbd{=} key interactively.
33512 @end defun
33514 @defmac with-extra-prec n body
33515 Evaluate the Lisp forms in @var{body} with precision increased by @var{n}
33516 digits.  This is a macro which expands to
33518 @smallexample
33519 (math-normalize
33520   (let ((calc-internal-prec (+ calc-internal-prec @var{n})))
33521     @var{body}))
33522 @end smallexample
33524 The surrounding call to @code{math-normalize} causes a floating-point
33525 result to be rounded down to the original precision afterwards.  This
33526 is important because some arithmetic operations assume a number's
33527 mantissa contains no more digits than the current precision allows.
33528 @end defmac
33530 @defun make-frac n d
33531 Build a fraction @samp{@var{n}:@var{d}}.  This is equivalent to calling
33532 @samp{(normalize (list 'frac @var{n} @var{d}))}, but more efficient.
33533 @end defun
33535 @defun make-float mant exp
33536 Build a floating-point value out of @var{mant} and @var{exp}, both
33537 of which are arbitrary integers.  This function will return a
33538 properly normalized float value, or signal an overflow or underflow
33539 if @var{exp} is out of range.
33540 @end defun
33542 @defun make-sdev x sigma
33543 Build an error form out of @var{x} and the absolute value of @var{sigma}.
33544 If @var{sigma} is zero, the result is the number @var{x} directly.
33545 If @var{sigma} is negative or complex, its absolute value is used.
33546 If @var{x} or @var{sigma} is not a valid type of object for use in
33547 error forms, this calls @code{reject-arg}.
33548 @end defun
33550 @defun make-intv mask lo hi
33551 Build an interval form out of @var{mask} (which is assumed to be an
33552 integer from 0 to 3), and the limits @var{lo} and @var{hi}.  If
33553 @var{lo} is greater than @var{hi}, an empty interval form is returned.
33554 This calls @code{reject-arg} if @var{lo} or @var{hi} is unsuitable.
33555 @end defun
33557 @defun sort-intv mask lo hi
33558 Build an interval form, similar to @code{make-intv}, except that if
33559 @var{lo} is less than @var{hi} they are simply exchanged, and the
33560 bits of @var{mask} are swapped accordingly.
33561 @end defun
33563 @defun make-mod n m
33564 Build a modulo form out of @var{n} and the modulus @var{m}.  Since modulo
33565 forms do not allow formulas as their components, if @var{n} or @var{m}
33566 is not a real number or HMS form the result will be a formula which
33567 is a call to @code{makemod}, the algebraic version of this function.
33568 @end defun
33570 @defun float x
33571 Convert @var{x} to floating-point form.  Integers and fractions are
33572 converted to numerically equivalent floats; components of complex
33573 numbers, vectors, HMS forms, date forms, error forms, intervals, and
33574 modulo forms are recursively floated.  If the argument is a variable
33575 or formula, this calls @code{reject-arg}.
33576 @end defun
33578 @defun compare x y
33579 Compare the numbers @var{x} and @var{y}, and return @mathit{-1} if
33580 @samp{(lessp @var{x} @var{y})}, 1 if @samp{(lessp @var{y} @var{x})},
33581 0 if @samp{(math-equal @var{x} @var{y})}, or 2 if the order is
33582 undefined or cannot be determined.
33583 @end defun
33585 @defun numdigs n
33586 Return the number of digits of integer @var{n}, effectively
33587 @samp{ceil(log10(@var{n}))}, but much more efficient.  Zero is
33588 considered to have zero digits.
33589 @end defun
33591 @defun scale-int x n
33592 Shift integer @var{x} left @var{n} decimal digits, or right @mathit{-@var{n}}
33593 digits with truncation toward zero.
33594 @end defun
33596 @defun scale-rounding x n
33597 Like @code{scale-int}, except that a right shift rounds to the nearest
33598 integer rather than truncating.
33599 @end defun
33601 @defun fixnum n
33602 Return the integer @var{n} as a fixnum, i.e., a native Lisp integer.
33603 If @var{n} is outside the permissible range for Lisp integers (usually
33604 24 binary bits) the result is undefined.
33605 @end defun
33607 @defun sqr x
33608 Compute the square of @var{x}; short for @samp{(* @var{x} @var{x})}.
33609 @end defun
33611 @defun quotient x y
33612 Divide integer @var{x} by integer @var{y}; return an integer quotient
33613 and discard the remainder.  If @var{x} or @var{y} is negative, the
33614 direction of rounding is undefined.
33615 @end defun
33617 @defun idiv x y
33618 Perform an integer division; if @var{x} and @var{y} are both nonnegative
33619 integers, this uses the @code{quotient} function, otherwise it computes
33620 @samp{floor(@var{x}/@var{y})}.  Thus the result is well-defined but
33621 slower than for @code{quotient}.
33622 @end defun
33624 @defun imod x y
33625 Divide integer @var{x} by integer @var{y}; return the integer remainder
33626 and discard the quotient.  Like @code{quotient}, this works only for
33627 integer arguments and is not well-defined for negative arguments.
33628 For a more well-defined result, use @samp{(% @var{x} @var{y})}.
33629 @end defun
33631 @defun idivmod x y
33632 Divide integer @var{x} by integer @var{y}; return a cons cell whose
33633 @code{car} is @samp{(quotient @var{x} @var{y})} and whose @code{cdr}
33634 is @samp{(imod @var{x} @var{y})}.
33635 @end defun
33637 @defun pow x y
33638 Compute @var{x} to the power @var{y}.  In @code{defmath} code, this can
33639 also be written @samp{(^ @var{x} @var{y})} or
33640 @w{@samp{(expt @var{x} @var{y})}}.
33641 @end defun
33643 @defun abs-approx x
33644 Compute a fast approximation to the absolute value of @var{x}.  For
33645 example, for a rectangular complex number the result is the sum of
33646 the absolute values of the components.
33647 @end defun
33649 @findex e
33650 @findex gamma-const
33651 @findex ln-2
33652 @findex ln-10
33653 @findex phi
33654 @findex pi-over-2
33655 @findex pi-over-4
33656 @findex pi-over-180
33657 @findex sqrt-two-pi
33658 @findex sqrt-e
33659 @findex two-pi
33660 @defun pi
33661 The function @samp{(pi)} computes @samp{pi} to the current precision.
33662 Other related constant-generating functions are @code{two-pi},
33663 @code{pi-over-2}, @code{pi-over-4}, @code{pi-over-180}, @code{sqrt-two-pi},
33664 @code{e}, @code{sqrt-e}, @code{ln-2}, @code{ln-10}, @code{phi} and
33665 @code{gamma-const}.  Each function returns a floating-point value in the
33666 current precision, and each uses caching so that all calls after the
33667 first are essentially free.
33668 @end defun
33670 @defmac math-defcache @var{func} @var{initial} @var{form}
33671 This macro, usually used as a top-level call like @code{defun} or
33672 @code{defvar}, defines a new cached constant analogous to @code{pi}, etc.
33673 It defines a function @code{func} which returns the requested value;
33674 if @var{initial} is non-@code{nil} it must be a @samp{(float @dots{})}
33675 form which serves as an initial value for the cache.  If @var{func}
33676 is called when the cache is empty or does not have enough digits to
33677 satisfy the current precision, the Lisp expression @var{form} is evaluated
33678 with the current precision increased by four, and the result minus its
33679 two least significant digits is stored in the cache.  For example,
33680 calling @samp{(pi)} with a precision of 30 computes @samp{pi} to 34
33681 digits, rounds it down to 32 digits for future use, then rounds it
33682 again to 30 digits for use in the present request.
33683 @end defmac
33685 @findex half-circle
33686 @findex quarter-circle
33687 @defun full-circle symb
33688 If the current angular mode is Degrees or HMS, this function returns the
33689 integer 360.  In Radians mode, this function returns either the
33690 corresponding value in radians to the current precision, or the formula
33691 @samp{2*pi}, depending on the Symbolic mode.  There are also similar
33692 function @code{half-circle} and @code{quarter-circle}.
33693 @end defun
33695 @defun power-of-2 n
33696 Compute two to the integer power @var{n}, as a (potentially very large)
33697 integer.  Powers of two are cached, so only the first call for a
33698 particular @var{n} is expensive.
33699 @end defun
33701 @defun integer-log2 n
33702 Compute the base-2 logarithm of @var{n}, which must be an integer which
33703 is a power of two.  If @var{n} is not a power of two, this function will
33704 return @code{nil}.
33705 @end defun
33707 @defun div-mod a b m
33708 Divide @var{a} by @var{b}, modulo @var{m}.  This returns @code{nil} if
33709 there is no solution, or if any of the arguments are not integers.
33710 @end defun
33712 @defun pow-mod a b m
33713 Compute @var{a} to the power @var{b}, modulo @var{m}.  If @var{a},
33714 @var{b}, and @var{m} are integers, this uses an especially efficient
33715 algorithm.  Otherwise, it simply computes @samp{(% (^ a b) m)}.
33716 @end defun
33718 @defun isqrt n
33719 Compute the integer square root of @var{n}.  This is the square root
33720 of @var{n} rounded down toward zero, i.e., @samp{floor(sqrt(@var{n}))}.
33721 If @var{n} is itself an integer, the computation is especially efficient.
33722 @end defun
33724 @defun to-hms a ang
33725 Convert the argument @var{a} into an HMS form.  If @var{ang} is specified,
33726 it is the angular mode in which to interpret @var{a}, either @code{deg}
33727 or @code{rad}.  Otherwise, the current angular mode is used.  If @var{a}
33728 is already an HMS form it is returned as-is.
33729 @end defun
33731 @defun from-hms a ang
33732 Convert the HMS form @var{a} into a real number.  If @var{ang} is specified,
33733 it is the angular mode in which to express the result, otherwise the
33734 current angular mode is used.  If @var{a} is already a real number, it
33735 is returned as-is.
33736 @end defun
33738 @defun to-radians a
33739 Convert the number or HMS form @var{a} to radians from the current
33740 angular mode.
33741 @end defun
33743 @defun from-radians a
33744 Convert the number @var{a} from radians to the current angular mode.
33745 If @var{a} is a formula, this returns the formula @samp{deg(@var{a})}.
33746 @end defun
33748 @defun to-radians-2 a
33749 Like @code{to-radians}, except that in Symbolic mode a degrees to
33750 radians conversion yields a formula like @samp{@var{a}*pi/180}.
33751 @end defun
33753 @defun from-radians-2 a
33754 Like @code{from-radians}, except that in Symbolic mode a radians to
33755 degrees conversion yields a formula like @samp{@var{a}*180/pi}.
33756 @end defun
33758 @defun random-digit
33759 Produce a random base-1000 digit in the range 0 to 999.
33760 @end defun
33762 @defun random-digits n
33763 Produce a random @var{n}-digit integer; this will be an integer
33764 in the interval @samp{[0, 10^@var{n})}.
33765 @end defun
33767 @defun random-float
33768 Produce a random float in the interval @samp{[0, 1)}.
33769 @end defun
33771 @defun prime-test n iters
33772 Determine whether the integer @var{n} is prime.  Return a list which has
33773 one of these forms: @samp{(nil @var{f})} means the number is non-prime
33774 because it was found to be divisible by @var{f}; @samp{(nil)} means it
33775 was found to be non-prime by table look-up (so no factors are known);
33776 @samp{(nil unknown)} means it is definitely non-prime but no factors
33777 are known because @var{n} was large enough that Fermat's probabilistic
33778 test had to be used; @samp{(t)} means the number is definitely prime;
33779 and @samp{(maybe @var{i} @var{p})} means that Fermat's test, after @var{i}
33780 iterations, is @var{p} percent sure that the number is prime.  The
33781 @var{iters} parameter is the number of Fermat iterations to use, in the
33782 case that this is necessary.  If @code{prime-test} returns ``maybe,''
33783 you can call it again with the same @var{n} to get a greater certainty;
33784 @code{prime-test} remembers where it left off.
33785 @end defun
33787 @defun to-simple-fraction f
33788 If @var{f} is a floating-point number which can be represented exactly
33789 as a small rational number. return that number, else return @var{f}.
33790 For example, 0.75 would be converted to 3:4.  This function is very
33791 fast.
33792 @end defun
33794 @defun to-fraction f tol
33795 Find a rational approximation to floating-point number @var{f} to within
33796 a specified tolerance @var{tol}; this corresponds to the algebraic
33797 function @code{frac}, and can be rather slow.
33798 @end defun
33800 @defun quarter-integer n
33801 If @var{n} is an integer or integer-valued float, this function
33802 returns zero.  If @var{n} is a half-integer (i.e., an integer plus
33803 @mathit{1:2} or 0.5), it returns 2.  If @var{n} is a quarter-integer,
33804 it returns 1 or 3.  If @var{n} is anything else, this function
33805 returns @code{nil}.
33806 @end defun
33808 @node Vector Lisp Functions, Symbolic Lisp Functions, Computational Lisp Functions, Internals
33809 @subsubsection Vector Functions
33811 @noindent
33812 The functions described here perform various operations on vectors and
33813 matrices.
33815 @defun math-concat x y
33816 Do a vector concatenation; this operation is written @samp{@var{x} | @var{y}}
33817 in a symbolic formula.  @xref{Building Vectors}.
33818 @end defun
33820 @defun vec-length v
33821 Return the length of vector @var{v}.  If @var{v} is not a vector, the
33822 result is zero.  If @var{v} is a matrix, this returns the number of
33823 rows in the matrix.
33824 @end defun
33826 @defun mat-dimens m
33827 Determine the dimensions of vector or matrix @var{m}.  If @var{m} is not
33828 a vector, the result is an empty list.  If @var{m} is a plain vector
33829 but not a matrix, the result is a one-element list containing the length
33830 of the vector.  If @var{m} is a matrix with @var{r} rows and @var{c} columns,
33831 the result is the list @samp{(@var{r} @var{c})}.  Higher-order tensors
33832 produce lists of more than two dimensions.  Note that the object
33833 @samp{[[1, 2, 3], [4, 5]]} is a vector of vectors not all the same size,
33834 and is treated by this and other Calc routines as a plain vector of two
33835 elements.
33836 @end defun
33838 @defun dimension-error
33839 Abort the current function with a message of ``Dimension error.''
33840 The Calculator will leave the function being evaluated in symbolic
33841 form; this is really just a special case of @code{reject-arg}.
33842 @end defun
33844 @defun build-vector args
33845 Return a Calc vector with @var{args} as elements.
33846 For example, @samp{(build-vector 1 2 3)} returns the Calc vector
33847 @samp{[1, 2, 3]}, stored internally as the list @samp{(vec 1 2 3)}.
33848 @end defun
33850 @defun make-vec obj dims
33851 Return a Calc vector or matrix all of whose elements are equal to
33852 @var{obj}.  For example, @samp{(make-vec 27 3 4)} returns a 3x4 matrix
33853 filled with 27's.
33854 @end defun
33856 @defun row-matrix v
33857 If @var{v} is a plain vector, convert it into a row matrix, i.e.,
33858 a matrix whose single row is @var{v}.  If @var{v} is already a matrix,
33859 leave it alone.
33860 @end defun
33862 @defun col-matrix v
33863 If @var{v} is a plain vector, convert it into a column matrix, i.e., a
33864 matrix with each element of @var{v} as a separate row.  If @var{v} is
33865 already a matrix, leave it alone.
33866 @end defun
33868 @defun map-vec f v
33869 Map the Lisp function @var{f} over the Calc vector @var{v}.  For example,
33870 @samp{(map-vec 'math-floor v)} returns a vector of the floored components
33871 of vector @var{v}.
33872 @end defun
33874 @defun map-vec-2 f a b
33875 Map the Lisp function @var{f} over the two vectors @var{a} and @var{b}.
33876 If @var{a} and @var{b} are vectors of equal length, the result is a
33877 vector of the results of calling @samp{(@var{f} @var{ai} @var{bi})}
33878 for each pair of elements @var{ai} and @var{bi}.  If either @var{a} or
33879 @var{b} is a scalar, it is matched with each value of the other vector.
33880 For example, @samp{(map-vec-2 'math-add v 1)} returns the vector @var{v}
33881 with each element increased by one.  Note that using @samp{'+} would not
33882 work here, since @code{defmath} does not expand function names everywhere,
33883 just where they are in the function position of a Lisp expression.
33884 @end defun
33886 @defun reduce-vec f v
33887 Reduce the function @var{f} over the vector @var{v}.  For example, if
33888 @var{v} is @samp{[10, 20, 30, 40]}, this calls @samp{(f (f (f 10 20) 30) 40)}.
33889 If @var{v} is a matrix, this reduces over the rows of @var{v}.
33890 @end defun
33892 @defun reduce-cols f m
33893 Reduce the function @var{f} over the columns of matrix @var{m}.  For
33894 example, if @var{m} is @samp{[[1, 2], [3, 4], [5, 6]]}, the result
33895 is a vector of the two elements @samp{(f (f 1 3) 5)} and @samp{(f (f 2 4) 6)}.
33896 @end defun
33898 @defun mat-row m n
33899 Return the @var{n}th row of matrix @var{m}.  This is equivalent to
33900 @samp{(elt m n)}.  For a slower but safer version, use @code{mrow}.
33901 (@xref{Extracting Elements}.)
33902 @end defun
33904 @defun mat-col m n
33905 Return the @var{n}th column of matrix @var{m}, in the form of a vector.
33906 The arguments are not checked for correctness.
33907 @end defun
33909 @defun mat-less-row m n
33910 Return a copy of matrix @var{m} with its @var{n}th row deleted.  The
33911 number @var{n} must be in range from 1 to the number of rows in @var{m}.
33912 @end defun
33914 @defun mat-less-col m n
33915 Return a copy of matrix @var{m} with its @var{n}th column deleted.
33916 @end defun
33918 @defun transpose m
33919 Return the transpose of matrix @var{m}.
33920 @end defun
33922 @defun flatten-vector v
33923 Flatten nested vector @var{v} into a vector of scalars.  For example,
33924 if @var{v} is @samp{[[1, 2, 3], [4, 5]]} the result is @samp{[1, 2, 3, 4, 5]}.
33925 @end defun
33927 @defun copy-matrix m
33928 If @var{m} is a matrix, return a copy of @var{m}.  This maps
33929 @code{copy-sequence} over the rows of @var{m}; in Lisp terms, each
33930 element of the result matrix will be @code{eq} to the corresponding
33931 element of @var{m}, but none of the @code{cons} cells that make up
33932 the structure of the matrix will be @code{eq}.  If @var{m} is a plain
33933 vector, this is the same as @code{copy-sequence}.
33934 @end defun
33936 @defun swap-rows m r1 r2
33937 Exchange rows @var{r1} and @var{r2} of matrix @var{m} in-place.  In
33938 other words, unlike most of the other functions described here, this
33939 function changes @var{m} itself rather than building up a new result
33940 matrix.  The return value is @var{m}, i.e., @samp{(eq (swap-rows m 1 2) m)}
33941 is true, with the side effect of exchanging the first two rows of
33942 @var{m}.
33943 @end defun
33945 @node Symbolic Lisp Functions, Formatting Lisp Functions, Vector Lisp Functions, Internals
33946 @subsubsection Symbolic Functions
33948 @noindent
33949 The functions described here operate on symbolic formulas in the
33950 Calculator.
33952 @defun calc-prepare-selection num
33953 Prepare a stack entry for selection operations.  If @var{num} is
33954 omitted, the stack entry containing the cursor is used; otherwise,
33955 it is the number of the stack entry to use.  This function stores
33956 useful information about the current stack entry into a set of
33957 variables.  @code{calc-selection-cache-num} contains the number of
33958 the stack entry involved (equal to @var{num} if you specified it);
33959 @code{calc-selection-cache-entry} contains the stack entry as a
33960 list (such as @code{calc-top-list} would return with @code{entry}
33961 as the selection mode); and @code{calc-selection-cache-comp} contains
33962 a special ``tagged'' composition (@pxref{Formatting Lisp Functions})
33963 which allows Calc to relate cursor positions in the buffer with
33964 their corresponding sub-formulas.
33966 A slight complication arises in the selection mechanism because
33967 formulas may contain small integers.  For example, in the vector
33968 @samp{[1, 2, 1]} the first and last elements are @code{eq} to each
33969 other; selections are recorded as the actual Lisp object that
33970 appears somewhere in the tree of the whole formula, but storing
33971 @code{1} would falsely select both @code{1}'s in the vector.  So
33972 @code{calc-prepare-selection} also checks the stack entry and
33973 replaces any plain integers with ``complex number'' lists of the form
33974 @samp{(cplx @var{n} 0)}.  This list will be displayed the same as a
33975 plain @var{n} and the change will be completely invisible to the
33976 user, but it will guarantee that no two sub-formulas of the stack
33977 entry will be @code{eq} to each other.  Next time the stack entry
33978 is involved in a computation, @code{calc-normalize} will replace
33979 these lists with plain numbers again, again invisibly to the user.
33980 @end defun
33982 @defun calc-encase-atoms x
33983 This modifies the formula @var{x} to ensure that each part of the
33984 formula is a unique atom, using the @samp{(cplx @var{n} 0)} trick
33985 described above.  This function may use @code{setcar} to modify
33986 the formula in-place.
33987 @end defun
33989 @defun calc-find-selected-part
33990 Find the smallest sub-formula of the current formula that contains
33991 the cursor.  This assumes @code{calc-prepare-selection} has been
33992 called already.  If the cursor is not actually on any part of the
33993 formula, this returns @code{nil}.
33994 @end defun
33996 @defun calc-change-current-selection selection
33997 Change the currently prepared stack element's selection to
33998 @var{selection}, which should be @code{eq} to some sub-formula
33999 of the stack element, or @code{nil} to unselect the formula.
34000 The stack element's appearance in the Calc buffer is adjusted
34001 to reflect the new selection.
34002 @end defun
34004 @defun calc-find-nth-part expr n
34005 Return the @var{n}th sub-formula of @var{expr}.  This function is used
34006 by the selection commands, and (unless @kbd{j b} has been used) treats
34007 sums and products as flat many-element formulas.  Thus if @var{expr}
34008 is @samp{((a + b) - c) + d}, calling @code{calc-find-nth-part} with
34009 @var{n} equal to four will return @samp{d}.
34010 @end defun
34012 @defun calc-find-parent-formula expr part
34013 Return the sub-formula of @var{expr} which immediately contains
34014 @var{part}.  If @var{expr} is @samp{a*b + (c+1)*d} and @var{part}
34015 is @code{eq} to the @samp{c+1} term of @var{expr}, then this function
34016 will return @samp{(c+1)*d}.  If @var{part} turns out not to be a
34017 sub-formula of @var{expr}, the function returns @code{nil}.  If
34018 @var{part} is @code{eq} to @var{expr}, the function returns @code{t}.
34019 This function does not take associativity into account.
34020 @end defun
34022 @defun calc-find-assoc-parent-formula expr part
34023 This is the same as @code{calc-find-parent-formula}, except that
34024 (unless @kbd{j b} has been used) it continues widening the selection
34025 to contain a complete level of the formula.  Given @samp{a} from
34026 @samp{((a + b) - c) + d}, @code{calc-find-parent-formula} will
34027 return @samp{a + b} but @code{calc-find-assoc-parent-formula} will
34028 return the whole expression.
34029 @end defun
34031 @defun calc-grow-assoc-formula expr part
34032 This expands sub-formula @var{part} of @var{expr} to encompass a
34033 complete level of the formula.  If @var{part} and its immediate
34034 parent are not compatible associative operators, or if @kbd{j b}
34035 has been used, this simply returns @var{part}.
34036 @end defun
34038 @defun calc-find-sub-formula expr part
34039 This finds the immediate sub-formula of @var{expr} which contains
34040 @var{part}.  It returns an index @var{n} such that
34041 @samp{(calc-find-nth-part @var{expr} @var{n})} would return @var{part}.
34042 If @var{part} is not a sub-formula of @var{expr}, it returns @code{nil}.
34043 If @var{part} is @code{eq} to @var{expr}, it returns @code{t}.  This
34044 function does not take associativity into account.
34045 @end defun
34047 @defun calc-replace-sub-formula expr old new
34048 This function returns a copy of formula @var{expr}, with the
34049 sub-formula that is @code{eq} to @var{old} replaced by @var{new}.
34050 @end defun
34052 @defun simplify expr
34053 Simplify the expression @var{expr} by applying various algebraic rules.
34054 This is what the @w{@kbd{a s}} (@code{calc-simplify}) command uses.  This
34055 always returns a copy of the expression; the structure @var{expr} points
34056 to remains unchanged in memory.
34058 More precisely, here is what @code{simplify} does:  The expression is
34059 first normalized and evaluated by calling @code{normalize}.  If any
34060 @code{AlgSimpRules} have been defined, they are then applied.  Then
34061 the expression is traversed in a depth-first, bottom-up fashion; at
34062 each level, any simplifications that can be made are made until no
34063 further changes are possible.  Once the entire formula has been
34064 traversed in this way, it is compared with the original formula (from
34065 before the call to @code{normalize}) and, if it has changed,
34066 the entire procedure is repeated (starting with @code{normalize})
34067 until no further changes occur.  Usually only two iterations are
34068 needed:@: one to simplify the formula, and another to verify that no
34069 further simplifications were possible.
34070 @end defun
34072 @defun simplify-extended expr
34073 Simplify the expression @var{expr}, with additional rules enabled that
34074 help do a more thorough job, while not being entirely ``safe'' in all
34075 circumstances.  (For example, this mode will simplify @samp{sqrt(x^2)}
34076 to @samp{x}, which is only valid when @var{x} is positive.)  This is
34077 implemented by temporarily binding the variable @code{math-living-dangerously}
34078 to @code{t} (using a @code{let} form) and calling @code{simplify}.
34079 Dangerous simplification rules are written to check this variable
34080 before taking any action.
34081 @end defun
34083 @defun simplify-units expr
34084 Simplify the expression @var{expr}, treating variable names as units
34085 whenever possible.  This works by binding the variable
34086 @code{math-simplifying-units} to @code{t} while calling @code{simplify}.
34087 @end defun
34089 @defmac math-defsimplify funcs body
34090 Register a new simplification rule; this is normally called as a top-level
34091 form, like @code{defun} or @code{defmath}.  If @var{funcs} is a symbol
34092 (like @code{+} or @code{calcFunc-sqrt}), this simplification rule is
34093 applied to the formulas which are calls to the specified function.  Or,
34094 @var{funcs} can be a list of such symbols; the rule applies to all
34095 functions on the list.  The @var{body} is written like the body of a
34096 function with a single argument called @code{expr}.  The body will be
34097 executed with @code{expr} bound to a formula which is a call to one of
34098 the functions @var{funcs}.  If the function body returns @code{nil}, or
34099 if it returns a result @code{equal} to the original @code{expr}, it is
34100 ignored and Calc goes on to try the next simplification rule that applies.
34101 If the function body returns something different, that new formula is
34102 substituted for @var{expr} in the original formula.
34104 At each point in the formula, rules are tried in the order of the
34105 original calls to @code{math-defsimplify}; the search stops after the
34106 first rule that makes a change.  Thus later rules for that same
34107 function will not have a chance to trigger until the next iteration
34108 of the main @code{simplify} loop.
34110 Note that, since @code{defmath} is not being used here, @var{body} must
34111 be written in true Lisp code without the conveniences that @code{defmath}
34112 provides.  If you prefer, you can have @var{body} simply call another
34113 function (defined with @code{defmath}) which does the real work.
34115 The arguments of a function call will already have been simplified
34116 before any rules for the call itself are invoked.  Since a new argument
34117 list is consed up when this happens, this means that the rule's body is
34118 allowed to rearrange the function's arguments destructively if that is
34119 convenient.  Here is a typical example of a simplification rule:
34121 @smallexample
34122 (math-defsimplify calcFunc-arcsinh
34123   (or (and (math-looks-negp (nth 1 expr))
34124            (math-neg (list 'calcFunc-arcsinh
34125                            (math-neg (nth 1 expr)))))
34126       (and (eq (car-safe (nth 1 expr)) 'calcFunc-sinh)
34127            (or math-living-dangerously
34128                (math-known-realp (nth 1 (nth 1 expr))))
34129            (nth 1 (nth 1 expr)))))
34130 @end smallexample
34132 This is really a pair of rules written with one @code{math-defsimplify}
34133 for convenience; the first replaces @samp{arcsinh(-x)} with
34134 @samp{-arcsinh(x)}, and the second, which is safe only for real @samp{x},
34135 replaces @samp{arcsinh(sinh(x))} with @samp{x}.
34136 @end defmac
34138 @defun common-constant-factor expr
34139 Check @var{expr} to see if it is a sum of terms all multiplied by the
34140 same rational value.  If so, return this value.  If not, return @code{nil}.
34141 For example, if called on @samp{6x + 9y + 12z}, it would return 3, since
34142 3 is a common factor of all the terms.
34143 @end defun
34145 @defun cancel-common-factor expr factor
34146 Assuming @var{expr} is a sum with @var{factor} as a common factor,
34147 divide each term of the sum by @var{factor}.  This is done by
34148 destructively modifying parts of @var{expr}, on the assumption that
34149 it is being used by a simplification rule (where such things are
34150 allowed; see above).  For example, consider this built-in rule for
34151 square roots:
34153 @smallexample
34154 (math-defsimplify calcFunc-sqrt
34155   (let ((fac (math-common-constant-factor (nth 1 expr))))
34156     (and fac (not (eq fac 1))
34157          (math-mul (math-normalize (list 'calcFunc-sqrt fac))
34158                    (math-normalize
34159                     (list 'calcFunc-sqrt
34160                           (math-cancel-common-factor
34161                            (nth 1 expr) fac)))))))
34162 @end smallexample
34163 @end defun
34165 @defun frac-gcd a b
34166 Compute a ``rational GCD'' of @var{a} and @var{b}, which must both be
34167 rational numbers.  This is the fraction composed of the GCD of the
34168 numerators of @var{a} and @var{b}, over the GCD of the denominators.
34169 It is used by @code{common-constant-factor}.  Note that the standard
34170 @code{gcd} function uses the LCM to combine the denominators.
34171 @end defun
34173 @defun map-tree func expr many
34174 Try applying Lisp function @var{func} to various sub-expressions of
34175 @var{expr}.  Initially, call @var{func} with @var{expr} itself as an
34176 argument.  If this returns an expression which is not @code{equal} to
34177 @var{expr}, apply @var{func} again until eventually it does return
34178 @var{expr} with no changes.  Then, if @var{expr} is a function call,
34179 recursively apply @var{func} to each of the arguments.  This keeps going
34180 until no changes occur anywhere in the expression; this final expression
34181 is returned by @code{map-tree}.  Note that, unlike simplification rules,
34182 @var{func} functions may @emph{not} make destructive changes to
34183 @var{expr}.  If a third argument @var{many} is provided, it is an
34184 integer which says how many times @var{func} may be applied; the
34185 default, as described above, is infinitely many times.
34186 @end defun
34188 @defun compile-rewrites rules
34189 Compile the rewrite rule set specified by @var{rules}, which should
34190 be a formula that is either a vector or a variable name.  If the latter,
34191 the compiled rules are saved so that later @code{compile-rules} calls
34192 for that same variable can return immediately.  If there are problems
34193 with the rules, this function calls @code{error} with a suitable
34194 message.
34195 @end defun
34197 @defun apply-rewrites expr crules heads
34198 Apply the compiled rewrite rule set @var{crules} to the expression
34199 @var{expr}.  This will make only one rewrite and only checks at the
34200 top level of the expression.  The result @code{nil} if no rules
34201 matched, or if the only rules that matched did not actually change
34202 the expression.  The @var{heads} argument is optional; if is given,
34203 it should be a list of all function names that (may) appear in
34204 @var{expr}.  The rewrite compiler tags each rule with the
34205 rarest-looking function name in the rule; if you specify @var{heads},
34206 @code{apply-rewrites} can use this information to narrow its search
34207 down to just a few rules in the rule set.
34208 @end defun
34210 @defun rewrite-heads expr
34211 Compute a @var{heads} list for @var{expr} suitable for use with
34212 @code{apply-rewrites}, as discussed above.
34213 @end defun
34215 @defun rewrite expr rules many
34216 This is an all-in-one rewrite function.  It compiles the rule set
34217 specified by @var{rules}, then uses @code{map-tree} to apply the
34218 rules throughout @var{expr} up to @var{many} (default infinity)
34219 times.
34220 @end defun
34222 @defun match-patterns pat vec not-flag
34223 Given a Calc vector @var{vec} and an uncompiled pattern set or
34224 pattern set variable @var{pat}, this function returns a new vector
34225 of all elements of @var{vec} which do (or don't, if @var{not-flag} is
34226 non-@code{nil}) match any of the patterns in @var{pat}.
34227 @end defun
34229 @defun deriv expr var value symb
34230 Compute the derivative of @var{expr} with respect to variable @var{var}
34231 (which may actually be any sub-expression).  If @var{value} is specified,
34232 the derivative is evaluated at the value of @var{var}; otherwise, the
34233 derivative is left in terms of @var{var}.  If the expression contains
34234 functions for which no derivative formula is known, new derivative
34235 functions are invented by adding primes to the names; @pxref{Calculus}.
34236 However, if @var{symb} is non-@code{nil}, the presence of undifferentiable
34237 functions in @var{expr} instead cancels the whole differentiation, and
34238 @code{deriv} returns @code{nil} instead.
34240 Derivatives of an @var{n}-argument function can be defined by
34241 adding a @code{math-derivative-@var{n}} property to the property list
34242 of the symbol for the function's derivative, which will be the
34243 function name followed by an apostrophe.  The value of the property
34244 should be a Lisp function; it is called with the same arguments as the
34245 original function call that is being differentiated.  It should return
34246 a formula for the derivative.  For example, the derivative of @code{ln}
34247 is defined by
34249 @smallexample
34250 (put 'calcFunc-ln\' 'math-derivative-1
34251      (function (lambda (u) (math-div 1 u))))
34252 @end smallexample
34254 The two-argument @code{log} function has two derivatives,
34255 @smallexample
34256 (put 'calcFunc-log\' 'math-derivative-2     ; d(log(x,b)) / dx
34257      (function (lambda (x b) ... )))
34258 (put 'calcFunc-log\'2 'math-derivative-2    ; d(log(x,b)) / db
34259      (function (lambda (x b) ... )))
34260 @end smallexample
34261 @end defun
34263 @defun tderiv expr var value symb
34264 Compute the total derivative of @var{expr}.  This is the same as
34265 @code{deriv}, except that variables other than @var{var} are not
34266 assumed to be constant with respect to @var{var}.
34267 @end defun
34269 @defun integ expr var low high
34270 Compute the integral of @var{expr} with respect to @var{var}.
34271 @xref{Calculus}, for further details.
34272 @end defun
34274 @defmac math-defintegral funcs body
34275 Define a rule for integrating a function or functions of one argument;
34276 this macro is very similar in format to @code{math-defsimplify}.
34277 The main difference is that here @var{body} is the body of a function
34278 with a single argument @code{u} which is bound to the argument to the
34279 function being integrated, not the function call itself.  Also, the
34280 variable of integration is available as @code{math-integ-var}.  If
34281 evaluation of the integral requires doing further integrals, the body
34282 should call @samp{(math-integral @var{x})} to find the integral of
34283 @var{x} with respect to @code{math-integ-var}; this function returns
34284 @code{nil} if the integral could not be done.  Some examples:
34286 @smallexample
34287 (math-defintegral calcFunc-conj
34288   (let ((int (math-integral u)))
34289     (and int
34290          (list 'calcFunc-conj int))))
34292 (math-defintegral calcFunc-cos
34293   (and (equal u math-integ-var)
34294        (math-from-radians-2 (list 'calcFunc-sin u))))
34295 @end smallexample
34297 In the @code{cos} example, we define only the integral of @samp{cos(x) dx},
34298 relying on the general integration-by-substitution facility to handle
34299 cosines of more complicated arguments.  An integration rule should return
34300 @code{nil} if it can't do the integral; if several rules are defined for
34301 the same function, they are tried in order until one returns a non-@code{nil}
34302 result.
34303 @end defmac
34305 @defmac math-defintegral-2 funcs body
34306 Define a rule for integrating a function or functions of two arguments.
34307 This is exactly analogous to @code{math-defintegral}, except that @var{body}
34308 is written as the body of a function with two arguments, @var{u} and
34309 @var{v}.
34310 @end defmac
34312 @defun solve-for lhs rhs var full
34313 Attempt to solve the equation @samp{@var{lhs} = @var{rhs}} by isolating
34314 the variable @var{var} on the lefthand side; return the resulting righthand
34315 side, or @code{nil} if the equation cannot be solved.  The variable
34316 @var{var} must appear at least once in @var{lhs} or @var{rhs}.  Note that
34317 the return value is a formula which does not contain @var{var}; this is
34318 different from the user-level @code{solve} and @code{finv} functions,
34319 which return a rearranged equation or a functional inverse, respectively.
34320 If @var{full} is non-@code{nil}, a full solution including dummy signs
34321 and dummy integers will be produced.  User-defined inverses are provided
34322 as properties in a manner similar to derivatives:
34324 @smallexample
34325 (put 'calcFunc-ln 'math-inverse
34326      (function (lambda (x) (list 'calcFunc-exp x))))
34327 @end smallexample
34329 This function can call @samp{(math-solve-get-sign @var{x})} to create
34330 a new arbitrary sign variable, returning @var{x} times that sign, and
34331 @samp{(math-solve-get-int @var{x})} to create a new arbitrary integer
34332 variable multiplied by @var{x}.  These functions simply return @var{x}
34333 if the caller requested a non-``full'' solution.
34334 @end defun
34336 @defun solve-eqn expr var full
34337 This version of @code{solve-for} takes an expression which will
34338 typically be an equation or inequality.  (If it is not, it will be
34339 interpreted as the equation @samp{@var{expr} = 0}.)  It returns an
34340 equation or inequality, or @code{nil} if no solution could be found.
34341 @end defun
34343 @defun solve-system exprs vars full
34344 This function solves a system of equations.  Generally, @var{exprs}
34345 and @var{vars} will be vectors of equal length.
34346 @xref{Solving Systems of Equations}, for other options.
34347 @end defun
34349 @defun expr-contains expr var
34350 Returns a non-@code{nil} value if @var{var} occurs as a subexpression
34351 of @var{expr}.
34353 This function might seem at first to be identical to
34354 @code{calc-find-sub-formula}.  The key difference is that
34355 @code{expr-contains} uses @code{equal} to test for matches, whereas
34356 @code{calc-find-sub-formula} uses @code{eq}.  In the formula
34357 @samp{f(a, a)}, the two @samp{a}s will be @code{equal} but not
34358 @code{eq} to each other.
34359 @end defun
34361 @defun expr-contains-count expr var
34362 Returns the number of occurrences of @var{var} as a subexpression
34363 of @var{expr}, or @code{nil} if there are no occurrences.
34364 @end defun
34366 @defun expr-depends expr var
34367 Returns true if @var{expr} refers to any variable the occurs in @var{var}.
34368 In other words, it checks if @var{expr} and @var{var} have any variables
34369 in common.
34370 @end defun
34372 @defun expr-contains-vars expr
34373 Return true if @var{expr} contains any variables, or @code{nil} if @var{expr}
34374 contains only constants and functions with constant arguments.
34375 @end defun
34377 @defun expr-subst expr old new
34378 Returns a copy of @var{expr}, with all occurrences of @var{old} replaced
34379 by @var{new}.  This treats @code{lambda} forms specially with respect
34380 to the dummy argument variables, so that the effect is always to return
34381 @var{expr} evaluated at @var{old} = @var{new}.
34382 @end defun
34384 @defun multi-subst expr old new
34385 This is like @code{expr-subst}, except that @var{old} and @var{new}
34386 are lists of expressions to be substituted simultaneously.  If one
34387 list is shorter than the other, trailing elements of the longer list
34388 are ignored.
34389 @end defun
34391 @defun expr-weight expr
34392 Returns the ``weight'' of @var{expr}, basically a count of the total
34393 number of objects and function calls that appear in @var{expr}.  For
34394 ``primitive'' objects, this will be one.
34395 @end defun
34397 @defun expr-height expr
34398 Returns the ``height'' of @var{expr}, which is the deepest level to
34399 which function calls are nested.  (Note that @samp{@var{a} + @var{b}}
34400 counts as a function call.)  For primitive objects, this returns zero.
34401 @end defun
34403 @defun polynomial-p expr var
34404 Check if @var{expr} is a polynomial in variable (or sub-expression)
34405 @var{var}.  If so, return the degree of the polynomial, that is, the
34406 highest power of @var{var} that appears in @var{expr}.  For example,
34407 for @samp{(x^2 + 3)^3 + 4} this would return 6.  This function returns
34408 @code{nil} unless @var{expr}, when expanded out by @kbd{a x}
34409 (@code{calc-expand}), would consist of a sum of terms in which @var{var}
34410 appears only raised to nonnegative integer powers.  Note that if
34411 @var{var} does not occur in @var{expr}, then @var{expr} is considered
34412 a polynomial of degree 0.
34413 @end defun
34415 @defun is-polynomial expr var degree loose
34416 Check if @var{expr} is a polynomial in variable or sub-expression
34417 @var{var}, and, if so, return a list representation of the polynomial
34418 where the elements of the list are coefficients of successive powers of
34419 @var{var}: @samp{@var{a} + @var{b} x + @var{c} x^3} would produce the
34420 list @samp{(@var{a} @var{b} 0 @var{c})}, and @samp{(x + 1)^2} would
34421 produce the list @samp{(1 2 1)}.  The highest element of the list will
34422 be non-zero, with the special exception that if @var{expr} is the
34423 constant zero, the returned value will be @samp{(0)}.  Return @code{nil}
34424 if @var{expr} is not a polynomial in @var{var}.  If @var{degree} is
34425 specified, this will not consider polynomials of degree higher than that
34426 value.  This is a good precaution because otherwise an input of
34427 @samp{(x+1)^1000} will cause a huge coefficient list to be built.  If
34428 @var{loose} is non-@code{nil}, then a looser definition of a polynomial
34429 is used in which coefficients are no longer required not to depend on
34430 @var{var}, but are only required not to take the form of polynomials
34431 themselves.  For example, @samp{sin(x) x^2 + cos(x)} is a loose
34432 polynomial with coefficients @samp{((calcFunc-cos x) 0 (calcFunc-sin
34433 x))}.  The result will never be @code{nil} in loose mode, since any
34434 expression can be interpreted as a ``constant'' loose polynomial.
34435 @end defun
34437 @defun polynomial-base expr pred
34438 Check if @var{expr} is a polynomial in any variable that occurs in it;
34439 if so, return that variable.  (If @var{expr} is a multivariate polynomial,
34440 this chooses one variable arbitrarily.)  If @var{pred} is specified, it should
34441 be a Lisp function which is called as @samp{(@var{pred} @var{subexpr})},
34442 and which should return true if @code{mpb-top-expr} (a global name for
34443 the original @var{expr}) is a suitable polynomial in @var{subexpr}.
34444 The default predicate uses @samp{(polynomial-p mpb-top-expr @var{subexpr})};
34445 you can use @var{pred} to specify additional conditions.  Or, you could
34446 have @var{pred} build up a list of every suitable @var{subexpr} that
34447 is found.
34448 @end defun
34450 @defun poly-simplify poly
34451 Simplify polynomial coefficient list @var{poly} by (destructively)
34452 clipping off trailing zeros.
34453 @end defun
34455 @defun poly-mix a ac b bc
34456 Mix two polynomial lists @var{a} and @var{b} (in the form returned by
34457 @code{is-polynomial}) in a linear combination with coefficient expressions
34458 @var{ac} and @var{bc}.  The result is a (not necessarily simplified)
34459 polynomial list representing @samp{@var{ac} @var{a} + @var{bc} @var{b}}.
34460 @end defun
34462 @defun poly-mul a b
34463 Multiply two polynomial coefficient lists @var{a} and @var{b}.  The
34464 result will be in simplified form if the inputs were simplified.
34465 @end defun
34467 @defun build-polynomial-expr poly var
34468 Construct a Calc formula which represents the polynomial coefficient
34469 list @var{poly} applied to variable @var{var}.  The @kbd{a c}
34470 (@code{calc-collect}) command uses @code{is-polynomial} to turn an
34471 expression into a coefficient list, then @code{build-polynomial-expr}
34472 to turn the list back into an expression in regular form.
34473 @end defun
34475 @defun check-unit-name var
34476 Check if @var{var} is a variable which can be interpreted as a unit
34477 name.  If so, return the units table entry for that unit.  This
34478 will be a list whose first element is the unit name (not counting
34479 prefix characters) as a symbol and whose second element is the
34480 Calc expression which defines the unit.  (Refer to the Calc sources
34481 for details on the remaining elements of this list.)  If @var{var}
34482 is not a variable or is not a unit name, return @code{nil}.
34483 @end defun
34485 @defun units-in-expr-p expr sub-exprs
34486 Return true if @var{expr} contains any variables which can be
34487 interpreted as units.  If @var{sub-exprs} is @code{t}, the entire
34488 expression is searched.  If @var{sub-exprs} is @code{nil}, this
34489 checks whether @var{expr} is directly a units expression.
34490 @end defun
34492 @defun single-units-in-expr-p expr
34493 Check whether @var{expr} contains exactly one units variable.  If so,
34494 return the units table entry for the variable.  If @var{expr} does
34495 not contain any units, return @code{nil}.  If @var{expr} contains
34496 two or more units, return the symbol @code{wrong}.
34497 @end defun
34499 @defun to-standard-units expr which
34500 Convert units expression @var{expr} to base units.  If @var{which}
34501 is @code{nil}, use Calc's native base units.  Otherwise, @var{which}
34502 can specify a units system, which is a list of two-element lists,
34503 where the first element is a Calc base symbol name and the second
34504 is an expression to substitute for it.
34505 @end defun
34507 @defun remove-units expr
34508 Return a copy of @var{expr} with all units variables replaced by ones.
34509 This expression is generally normalized before use.
34510 @end defun
34512 @defun extract-units expr
34513 Return a copy of @var{expr} with everything but units variables replaced
34514 by ones.
34515 @end defun
34517 @node Formatting Lisp Functions, Hooks, Symbolic Lisp Functions, Internals
34518 @subsubsection I/O and Formatting Functions
34520 @noindent
34521 The functions described here are responsible for parsing and formatting
34522 Calc numbers and formulas.
34524 @defun calc-eval str sep arg1 arg2 @dots{}
34525 This is the simplest interface to the Calculator from another Lisp program.
34526 @xref{Calling Calc from Your Programs}.
34527 @end defun
34529 @defun read-number str
34530 If string @var{str} contains a valid Calc number, either integer,
34531 fraction, float, or HMS form, this function parses and returns that
34532 number.  Otherwise, it returns @code{nil}.
34533 @end defun
34535 @defun read-expr str
34536 Read an algebraic expression from string @var{str}.  If @var{str} does
34537 not have the form of a valid expression, return a list of the form
34538 @samp{(error @var{pos} @var{msg})} where @var{pos} is an integer index
34539 into @var{str} of the general location of the error, and @var{msg} is
34540 a string describing the problem.
34541 @end defun
34543 @defun read-exprs str
34544 Read a list of expressions separated by commas, and return it as a
34545 Lisp list.  If an error occurs in any expressions, an error list as
34546 shown above is returned instead.
34547 @end defun
34549 @defun calc-do-alg-entry initial prompt no-norm
34550 Read an algebraic formula or formulas using the minibuffer.  All
34551 conventions of regular algebraic entry are observed.  The return value
34552 is a list of Calc formulas; there will be more than one if the user
34553 entered a list of values separated by commas.  The result is @code{nil}
34554 if the user presses Return with a blank line.  If @var{initial} is
34555 given, it is a string which the minibuffer will initially contain.
34556 If @var{prompt} is given, it is the prompt string to use; the default
34557 is ``Algebraic:''.  If @var{no-norm} is @code{t}, the formulas will
34558 be returned exactly as parsed; otherwise, they will be passed through
34559 @code{calc-normalize} first.
34561 To support the use of @kbd{$} characters in the algebraic entry, use
34562 @code{let} to bind @code{calc-dollar-values} to a list of the values
34563 to be substituted for @kbd{$}, @kbd{$$}, and so on, and bind
34564 @code{calc-dollar-used} to 0.  Upon return, @code{calc-dollar-used}
34565 will have been changed to the highest number of consecutive @kbd{$}s
34566 that actually appeared in the input.
34567 @end defun
34569 @defun format-number a
34570 Convert the real or complex number or HMS form @var{a} to string form.
34571 @end defun
34573 @defun format-flat-expr a prec
34574 Convert the arbitrary Calc number or formula @var{a} to string form,
34575 in the style used by the trail buffer and the @code{calc-edit} command.
34576 This is a simple format designed
34577 mostly to guarantee the string is of a form that can be re-parsed by
34578 @code{read-expr}.  Most formatting modes, such as digit grouping,
34579 complex number format, and point character, are ignored to ensure the
34580 result will be re-readable.  The @var{prec} parameter is normally 0; if
34581 you pass a large integer like 1000 instead, the expression will be
34582 surrounded by parentheses unless it is a plain number or variable name.
34583 @end defun
34585 @defun format-nice-expr a width
34586 This is like @code{format-flat-expr} (with @var{prec} equal to 0),
34587 except that newlines will be inserted to keep lines down to the
34588 specified @var{width}, and vectors that look like matrices or rewrite
34589 rules are written in a pseudo-matrix format.  The @code{calc-edit}
34590 command uses this when only one stack entry is being edited.
34591 @end defun
34593 @defun format-value a width
34594 Convert the Calc number or formula @var{a} to string form, using the
34595 format seen in the stack buffer.  Beware the string returned may
34596 not be re-readable by @code{read-expr}, for example, because of digit
34597 grouping.  Multi-line objects like matrices produce strings that
34598 contain newline characters to separate the lines.  The @var{w}
34599 parameter, if given, is the target window size for which to format
34600 the expressions.  If @var{w} is omitted, the width of the Calculator
34601 window is used.
34602 @end defun
34604 @defun compose-expr a prec
34605 Format the Calc number or formula @var{a} according to the current
34606 language mode, returning a ``composition.''  To learn about the
34607 structure of compositions, see the comments in the Calc source code.
34608 You can specify the format of a given type of function call by putting
34609 a @code{math-compose-@var{lang}} property on the function's symbol,
34610 whose value is a Lisp function that takes @var{a} and @var{prec} as
34611 arguments and returns a composition.  Here @var{lang} is a language
34612 mode name, one of @code{normal}, @code{big}, @code{c}, @code{pascal},
34613 @code{fortran}, @code{tex}, @code{eqn}, @code{math}, or @code{maple}.
34614 In Big mode, Calc actually tries @code{math-compose-big} first, then
34615 tries @code{math-compose-normal}.  If this property does not exist,
34616 or if the function returns @code{nil}, the function is written in the
34617 normal function-call notation for that language.
34618 @end defun
34620 @defun composition-to-string c w
34621 Convert a composition structure returned by @code{compose-expr} into
34622 a string.  Multi-line compositions convert to strings containing
34623 newline characters.  The target window size is given by @var{w}.
34624 The @code{format-value} function basically calls @code{compose-expr}
34625 followed by @code{composition-to-string}.
34626 @end defun
34628 @defun comp-width c
34629 Compute the width in characters of composition @var{c}.
34630 @end defun
34632 @defun comp-height c
34633 Compute the height in lines of composition @var{c}.
34634 @end defun
34636 @defun comp-ascent c
34637 Compute the portion of the height of composition @var{c} which is on or
34638 above the baseline.  For a one-line composition, this will be one.
34639 @end defun
34641 @defun comp-descent c
34642 Compute the portion of the height of composition @var{c} which is below
34643 the baseline.  For a one-line composition, this will be zero.
34644 @end defun
34646 @defun comp-first-char c
34647 If composition @var{c} is a ``flat'' composition, return the first
34648 (leftmost) character of the composition as an integer.  Otherwise,
34649 return @code{nil}.
34650 @end defun
34652 @defun comp-last-char c
34653 If composition @var{c} is a ``flat'' composition, return the last
34654 (rightmost) character, otherwise return @code{nil}.
34655 @end defun
34657 @comment @node Lisp Variables, Hooks, Formatting Lisp Functions, Internals
34658 @comment @subsubsection Lisp Variables
34659 @comment
34660 @comment @noindent
34661 @comment (This section is currently unfinished.)
34663 @node Hooks, , Formatting Lisp Functions, Internals
34664 @subsubsection Hooks
34666 @noindent
34667 Hooks are variables which contain Lisp functions (or lists of functions)
34668 which are called at various times.  Calc defines a number of hooks
34669 that help you to customize it in various ways.  Calc uses the Lisp
34670 function @code{run-hooks} to invoke the hooks shown below.  Several
34671 other customization-related variables are also described here.
34673 @defvar calc-load-hook
34674 This hook is called at the end of @file{calc.el}, after the file has
34675 been loaded, before any functions in it have been called, but after
34676 @code{calc-mode-map} and similar variables have been set up.
34677 @end defvar
34679 @defvar calc-ext-load-hook
34680 This hook is called at the end of @file{calc-ext.el}.
34681 @end defvar
34683 @defvar calc-start-hook
34684 This hook is called as the last step in a @kbd{M-x calc} command.
34685 At this point, the Calc buffer has been created and initialized if
34686 necessary, the Calc window and trail window have been created,
34687 and the ``Welcome to Calc'' message has been displayed.
34688 @end defvar
34690 @defvar calc-mode-hook
34691 This hook is called when the Calc buffer is being created.  Usually
34692 this will only happen once per Emacs session.  The hook is called
34693 after Emacs has switched to the new buffer, the mode-settings file
34694 has been read if necessary, and all other buffer-local variables
34695 have been set up.  After this hook returns, Calc will perform a
34696 @code{calc-refresh} operation, set up the mode line display, then
34697 evaluate any deferred @code{calc-define} properties that have not
34698 been evaluated yet.
34699 @end defvar
34701 @defvar calc-trail-mode-hook
34702 This hook is called when the Calc Trail buffer is being created.
34703 It is called as the very last step of setting up the Trail buffer.
34704 Like @code{calc-mode-hook}, this will normally happen only once
34705 per Emacs session.
34706 @end defvar
34708 @defvar calc-end-hook
34709 This hook is called by @code{calc-quit}, generally because the user
34710 presses @kbd{q} or @kbd{M-# c} while in Calc.  The Calc buffer will
34711 be the current buffer.  The hook is called as the very first
34712 step, before the Calc window is destroyed.
34713 @end defvar
34715 @defvar calc-window-hook
34716 If this hook is non-@code{nil}, it is called to create the Calc window.
34717 Upon return, this new Calc window should be the current window.
34718 (The Calc buffer will already be the current buffer when the
34719 hook is called.)  If the hook is not defined, Calc will
34720 generally use @code{split-window}, @code{set-window-buffer},
34721 and @code{select-window} to create the Calc window.
34722 @end defvar
34724 @defvar calc-trail-window-hook
34725 If this hook is non-@code{nil}, it is called to create the Calc Trail
34726 window.  The variable @code{calc-trail-buffer} will contain the buffer
34727 which the window should use.  Unlike @code{calc-window-hook}, this hook
34728 must @emph{not} switch into the new window.
34729 @end defvar
34731 @defvar calc-embedded-mode-hook
34732 This hook is called the first time that Embedded mode is entered.
34733 @end defvar
34735 @defvar calc-embedded-new-buffer-hook
34736 This hook is called each time that Embedded mode is entered in a
34737 new buffer.
34738 @end defvar
34740 @defvar calc-embedded-new-formula-hook
34741 This hook is called each time that Embedded mode is enabled for a
34742 new formula.
34743 @end defvar
34745 @defvar calc-edit-mode-hook
34746 This hook is called by @code{calc-edit} (and the other ``edit''
34747 commands) when the temporary editing buffer is being created.
34748 The buffer will have been selected and set up to be in
34749 @code{calc-edit-mode}, but will not yet have been filled with
34750 text.  (In fact it may still have leftover text from a previous
34751 @code{calc-edit} command.)
34752 @end defvar
34754 @defvar calc-mode-save-hook
34755 This hook is called by the @code{calc-save-modes} command,
34756 after Calc's own mode features have been inserted into the
34757 Calc init file and just before the ``End of mode settings''
34758 message is inserted.
34759 @end defvar
34761 @defvar calc-reset-hook
34762 This hook is called after @kbd{M-# 0} (@code{calc-reset}) has
34763 reset all modes.  The Calc buffer will be the current buffer.
34764 @end defvar
34766 @defvar calc-other-modes
34767 This variable contains a list of strings.  The strings are
34768 concatenated at the end of the modes portion of the Calc
34769 mode line (after standard modes such as ``Deg'', ``Inv'' and
34770 ``Hyp'').  Each string should be a short, single word followed
34771 by a space.  The variable is @code{nil} by default.
34772 @end defvar
34774 @defvar calc-mode-map
34775 This is the keymap that is used by Calc mode.  The best time
34776 to adjust it is probably in a @code{calc-mode-hook}.  If the
34777 Calc extensions package (@file{calc-ext.el}) has not yet been
34778 loaded, many of these keys will be bound to @code{calc-missing-key},
34779 which is a command that loads the extensions package and
34780 ``retypes'' the key.  If your @code{calc-mode-hook} rebinds
34781 one of these keys, it will probably be overridden when the
34782 extensions are loaded.
34783 @end defvar
34785 @defvar calc-digit-map
34786 This is the keymap that is used during numeric entry.  Numeric
34787 entry uses the minibuffer, but this map binds every non-numeric
34788 key to @code{calcDigit-nondigit} which generally calls
34789 @code{exit-minibuffer} and ``retypes'' the key.
34790 @end defvar
34792 @defvar calc-alg-ent-map
34793 This is the keymap that is used during algebraic entry.  This is
34794 mostly a copy of @code{minibuffer-local-map}.
34795 @end defvar
34797 @defvar calc-store-var-map
34798 This is the keymap that is used during entry of variable names for
34799 commands like @code{calc-store} and @code{calc-recall}.  This is
34800 mostly a copy of @code{minibuffer-local-completion-map}.
34801 @end defvar
34803 @defvar calc-edit-mode-map
34804 This is the (sparse) keymap used by @code{calc-edit} and other
34805 temporary editing commands.  It binds @key{RET}, @key{LFD},
34806 and @kbd{C-c C-c} to @code{calc-edit-finish}.
34807 @end defvar
34809 @defvar calc-mode-var-list
34810 This is a list of variables which are saved by @code{calc-save-modes}.
34811 Each entry is a list of two items, the variable (as a Lisp symbol)
34812 and its default value.  When modes are being saved, each variable
34813 is compared with its default value (using @code{equal}) and any
34814 non-default variables are written out.
34815 @end defvar
34817 @defvar calc-local-var-list
34818 This is a list of variables which should be buffer-local to the
34819 Calc buffer.  Each entry is a variable name (as a Lisp symbol).
34820 These variables also have their default values manipulated by
34821 the @code{calc} and @code{calc-quit} commands; @pxref{Multiple Calculators}.
34822 Since @code{calc-mode-hook} is called after this list has been
34823 used the first time, your hook should add a variable to the
34824 list and also call @code{make-local-variable} itself.
34825 @end defvar
34827 @node Customizable Variables, Reporting Bugs, Programming, Top
34828 @appendix Customizable Variables
34830 GNU Calc is controlled by many variables, most of which can be reset
34831 from within Calc.  Some variables are less involved with actual
34832 calculation, and can be set outside of Calc using Emacs's
34833 customization facilities.  These variables are listed below.
34834 Typing @kbd{M-x customize-variable RET @var{variable-name} RET}
34835 will bring up a buffer in which the variable's value can be redefined.
34836 Typing @kbd{M-x customize-group RET calc RET} will bring up a buffer which
34837 contains all of Calc's customizable variables.  (These variables can
34838 also be reset by putting the appropriate lines in your .emacs file;
34839 @xref{Init File, ,Init File, emacs, The GNU Emacs Manual}.)
34841 Some of the customizable variables are regular expressions.  A regular
34842 expression is basically a pattern that Calc can search for.
34843 See @ref{Regexp Search,, Regular Expression Search, emacs, The GNU Emacs Manual}
34844 to see how regular expressions work.
34846 @defvar calc-settings-file
34847 The variable @code{calc-settings-file} holds the file name in
34848 which commands like @kbd{m m} and @kbd{Z P} store ``permanent''
34849 definitions.  
34850 If @code{calc-settings-file} is not your user init file (typically
34851 @file{~/.emacs}) and if the variable @code{calc-loaded-settings-file} is
34852 @code{nil}, then Calc will automatically load your settings file (if it
34853 exists) the first time Calc is invoked.
34855 The default value for this variable is @code{"~/.calc.el"}.
34856 @end defvar
34858 @defvar calc-gnuplot-name
34859 See @ref{Graphics}.@*
34860 The variable @code{calc-gnuplot-name} should be the name of the
34861 GNUPLOT program (a string).  If you have GNUPLOT installed on your
34862 system but Calc is unable to find it, you may need to set this
34863 variable.  (@pxref{Customizable Variables})
34864 You may also need to set some Lisp variables to show Calc how to run
34865 GNUPLOT on your system, see @ref{Devices, ,Graphical Devices} .  The default value
34866 of @code{calc-gnuplot-name} is @code{"gnuplot"}.
34867 @end defvar
34869 @defvar  calc-gnuplot-plot-command
34870 @defvarx calc-gnuplot-print-command
34871 See @ref{Devices, ,Graphical Devices}.@*
34872 The variables @code{calc-gnuplot-plot-command} and
34873 @code{calc-gnuplot-print-command} represent system commands to
34874 display and print the output of GNUPLOT, respectively.  These may be
34875 @code{nil} if no command is necessary, or strings which can include
34876 @samp{%s} to signify the name of the file to be displayed or printed.
34877 Or, these variables may contain Lisp expressions which are evaluated
34878 to display or print the output.
34880 The default value of @code{calc-gnuplot-plot-command} is @code{nil},
34881 and the default value of @code{calc-gnuplot-print-command} is
34882 @code{"lp %s"}.
34883 @end defvar
34885 @defvar calc-language-alist
34886 See @ref{Basic Embedded Mode}.@*
34887 The variable @code{calc-language-alist} controls the languages that
34888 Calc will associate with major modes.  When Calc embedded mode is
34889 enabled, it will try to use the current major mode to
34890 determine what language should be used.  (This can be overridden using
34891 Calc's mode changing commands, @xref{Mode Settings in Embedded Mode}.)
34892 The variable @code{calc-language-alist} consists of a list of pairs of
34893 the form  @code{(@var{MAJOR-MODE} . @var{LANGUAGE})}; for example, 
34894 @code{(latex-mode . latex)} is one such pair.  If Calc embedded is
34895 activated in a buffer whose major mode is @var{MAJOR-MODE}, it will set itself
34896 to use the language @var{LANGUAGE}.
34898 The default value of @code{calc-language-alist} is
34899 @example
34900    ((latex-mode . latex)
34901     (tex-mode   . tex)
34902     (plain-tex-mode . tex)
34903     (context-mode . tex)
34904     (nroff-mode . eqn)
34905     (pascal-mode . pascal)
34906     (c-mode . c)
34907     (c++-mode . c)
34908     (fortran-mode . fortran)
34909     (f90-mode . fortran))
34910 @end example
34911 @end defvar
34913 @defvar calc-embedded-announce-formula
34914 @defvarx calc-embedded-announce-formula-alist
34915 See @ref{Customizing Embedded Mode}.@*
34916 The variable @code{calc-embedded-announce-formula} helps determine
34917 what formulas @kbd{M-# a} will activate in a buffer.  It is a
34918 regular expression, and when activating embedded formulas with
34919 @kbd{M-# a}, it will tell Calc that what follows is a formula to be
34920 activated.  (Calc also uses other patterns to find formulas, such as
34921 @samp{=>} and @samp{:=}.)  
34923 The default pattern is @code{"%Embed\n\\(% .*\n\\)*"}, which checks
34924 for @samp{%Embed} followed by any number of lines beginning with
34925 @samp{%} and a space.
34927 The variable @code{calc-embedded-announce-formula-alist} is used to
34928 set @code{calc-embedded-announce-formula} to different regular
34929 expressions depending on the major mode of the editing buffer.
34930 It consists of a list of pairs of the form @code{(@var{MAJOR-MODE} .
34931 @var{REGEXP})}, and its default value is
34932 @example
34933    ((c++-mode     . "//Embed\n\\(// .*\n\\)*")
34934     (c-mode       . "/\\*Embed\\*/\n\\(/\\* .*\\*/\n\\)*")
34935     (f90-mode     . "!Embed\n\\(! .*\n\\)*")
34936     (fortran-mode . "C Embed\n\\(C .*\n\\)*")
34937     (html-helper-mode . "<!-- Embed -->\n\\(<!-- .* -->\n\\)*")
34938     (html-mode    . "<!-- Embed -->\n\\(<!-- .* -->\n\\)*")
34939     (nroff-mode   . "\\\\\"Embed\n\\(\\\\\" .*\n\\)*")
34940     (pascal-mode  . "@{Embed@}\n\\(@{.*@}\n\\)*")
34941     (sgml-mode    . "<!-- Embed -->\n\\(<!-- .* -->\n\\)*")
34942     (xml-mode     . "<!-- Embed -->\n\\(<!-- .* -->\n\\)*")
34943     (texinfo-mode . "@@c Embed\n\\(@@c .*\n\\)*"))
34944 @end example
34945 Any major modes added to @code{calc-embedded-announce-formula-alist}
34946 should also be added to @code{calc-embedded-open-close-plain-alist} 
34947 and @code{calc-embedded-open-close-mode-alist}.
34948 @end defvar
34950 @defvar  calc-embedded-open-formula
34951 @defvarx calc-embedded-close-formula
34952 @defvarx calc-embedded-open-close-formula-alist
34953 See @ref{Customizing Embedded Mode}.@*
34954 The variables @code{calc-embedded-open-formula} and
34955 @code{calc-embedded-open-formula} control the region that Calc will
34956 activate as a formula when Embedded mode is entered with @kbd{M-# e}.
34957 They are regular expressions; 
34958 Calc normally scans backward and forward in the buffer for the
34959 nearest text matching these regular expressions to be the ``formula
34960 delimiters''.
34962 The simplest delimiters are blank lines.  Other delimiters that
34963 Embedded mode understands by default are:
34964 @enumerate
34965 @item
34966 The @TeX{} and La@TeX{} math delimiters @samp{$ $}, @samp{$$ $$},
34967 @samp{\[ \]}, and @samp{\( \)};
34968 @item
34969 Lines beginning with @samp{\begin} and @samp{\end} (except matrix delimiters);
34970 @item
34971 Lines beginning with @samp{@@} (Texinfo delimiters).
34972 @item
34973 Lines beginning with @samp{.EQ} and @samp{.EN} (@dfn{eqn} delimiters);
34974 @item
34975 Lines containing a single @samp{%} or @samp{.\"} symbol and nothing else.
34976 @end enumerate
34978 The variable @code{calc-embedded-open-close-formula-alist} is used to
34979 set @code{calc-embedded-open-formula} and
34980 @code{calc-embedded-close-formula} to different regular
34981 expressions depending on the major mode of the editing buffer.
34982 It consists of a list of lists of the form 
34983 @code{(@var{MAJOR-MODE}  @var{OPEN-FORMULA-REGEXP}
34984 @var{CLOSE-FORMULA-REGEXP})}, and its default value is
34985 @code{nil}.
34986 @end defvar
34988 @defvar  calc-embedded-open-word
34989 @defvarx calc-embedded-close-word
34990 @defvarx calc-embedded-open-close-word-alist
34991 See @ref{Customizing Embedded Mode}.@*
34992 The variables @code{calc-embedded-open-word} and
34993 @code{calc-embedded-close-word} control the region that Calc will
34994 activate when Embedded mode is entered with @kbd{M-# w}.  They are
34995 regular expressions.
34997 The default values of @code{calc-embedded-open-word} and
34998 @code{calc-embedded-close-word} are @code{"^\\|[^-+0-9.eE]"} and 
34999 @code{"$\\|[^-+0-9.eE]"} respectively.
35001 The variable @code{calc-embedded-open-close-word-alist} is used to
35002 set @code{calc-embedded-open-word} and
35003 @code{calc-embedded-close-word} to different regular
35004 expressions depending on the major mode of the editing buffer.
35005 It consists of a list of lists of the form 
35006 @code{(@var{MAJOR-MODE}  @var{OPEN-WORD-REGEXP}
35007 @var{CLOSE-WORD-REGEXP})}, and its default value is
35008 @code{nil}.
35009 @end defvar
35011 @defvar  calc-embedded-open-plain
35012 @defvarx calc-embedded-close-plain
35013 @defvarx calc-embedded-open-close-plain-alist
35014 See @ref{Customizing Embedded Mode}.@*
35015 The variables @code{calc-embedded-open-plain} and
35016 @code{calc-embedded-open-plain} are used to delimit ``plain''
35017 formulas.  Note that these are actual strings, not regular
35018 expressions, because Calc must be able to write these string into a
35019 buffer as well as to recognize them.
35021 The default string for @code{calc-embedded-open-plain} is 
35022 @code{"%%% "}, note the trailing space.  The default string for 
35023 @code{calc-embedded-close-plain} is @code{" %%%\n"}, without
35024 the trailing newline here, the first line of a Big mode formula
35025 that followed might be shifted over with respect to the other lines.
35027 The variable @code{calc-embedded-open-close-plain-alist} is used to
35028 set @code{calc-embedded-open-plain} and
35029 @code{calc-embedded-close-plain} to different strings
35030 depending on the major mode of the editing buffer.
35031 It consists of a list of lists of the form 
35032 @code{(@var{MAJOR-MODE}  @var{OPEN-PLAIN-STRING}
35033 @var{CLOSE-PLAIN-STRING})}, and its default value is
35034 @example
35035    ((c++-mode     "// %% "   " %%\n")
35036     (c-mode       "/* %% "   " %% */\n")
35037     (f90-mode     "! %% "    " %%\n")
35038     (fortran-mode "C %% "    " %%\n")
35039     (html-helper-mode "<!-- %% " " %% -->\n")
35040     (html-mode "<!-- %% " " %% -->\n")
35041     (nroff-mode   "\\\" %% " " %%\n")
35042     (pascal-mode  "@{%% "    " %%@}\n")
35043     (sgml-mode     "<!-- %% " " %% -->\n")
35044     (xml-mode     "<!-- %% " " %% -->\n")
35045     (texinfo-mode "@@c %% "   " %%\n"))
35046 @end example
35047 Any major modes added to @code{calc-embedded-open-close-plain-alist}
35048 should also be added to @code{calc-embedded-announce-formula-alist}
35049 and @code{calc-embedded-open-close-mode-alist}.
35050 @end defvar
35052 @defvar  calc-embedded-open-new-formula
35053 @defvarx calc-embedded-close-new-formula
35054 @defvarx calc-embedded-open-close-new-formula-alist
35055 See @ref{Customizing Embedded Mode}.@*
35056 The variables @code{calc-embedded-open-new-formula} and
35057 @code{calc-embedded-close-new-formula} are strings which are
35058 inserted before and after a new formula when you type @kbd{M-# f}.
35060 The default value of @code{calc-embedded-open-new-formula} is
35061 @code{"\n\n"}.  If this string begins with a newline character and the
35062 @kbd{M-# f} is typed at the beginning of a line, @kbd{M-# f} will skip
35063 this first newline to avoid introducing unnecessary blank lines in the
35064 file.  The default value of @code{calc-embedded-close-new-formula} is
35065 also @code{"\n\n"}.  The final newline is omitted by @w{@kbd{M-# f}}
35066 if typed at the end of a line.  (It follows that if @kbd{M-# f} is
35067 typed on a blank line, both a leading opening newline and a trailing
35068 closing newline are omitted.)
35070 The variable @code{calc-embedded-open-close-new-formula-alist} is used to
35071 set @code{calc-embedded-open-new-formula} and
35072 @code{calc-embedded-close-new-formula} to different strings
35073 depending on the major mode of the editing buffer.
35074 It consists of a list of lists of the form 
35075 @code{(@var{MAJOR-MODE}  @var{OPEN-NEW-FORMULA-STRING}
35076 @var{CLOSE-NEW-FORMULA-STRING})}, and its default value is
35077 @code{nil}.
35078 @end defvar
35080 @defvar  calc-embedded-open-mode
35081 @defvarx calc-embedded-close-mode
35082 @defvarx calc-embedded-open-close-mode-alist
35083 See @ref{Customizing Embedded Mode}.@*
35084 The variables @code{calc-embedded-open-mode} and
35085 @code{calc-embedded-close-mode} are strings which Calc will place before
35086 and after any mode annotations that it inserts.  Calc never scans for
35087 these strings; Calc always looks for the annotation itself, so it is not
35088 necessary to add them to user-written annotations.
35090 The default value of @code{calc-embedded-open-mode} is @code{"% "}
35091 and the default value of @code{calc-embedded-close-mode} is
35092 @code{"\n"}.  
35093 If you change the value of @code{calc-embedded-close-mode}, it is a good
35094 idea still to end with a newline so that mode annotations will appear on
35095 lines by themselves.
35097 The variable @code{calc-embedded-open-close-mode-alist} is used to
35098 set @code{calc-embedded-open-mode} and
35099 @code{calc-embedded-close-mode} to different strings
35100 expressions depending on the major mode of the editing buffer.
35101 It consists of a list of lists of the form 
35102 @code{(@var{MAJOR-MODE}  @var{OPEN-MODE-STRING}
35103 @var{CLOSE-MODE-STRING})}, and its default value is
35104 @example
35105    ((c++-mode     "// "   "\n")
35106     (c-mode       "/* "   " */\n")
35107     (f90-mode     "! "    "\n")
35108     (fortran-mode "C "    "\n")
35109     (html-helper-mode "<!-- " " -->\n")
35110     (html-mode    "<!-- " " -->\n")
35111     (nroff-mode   "\\\" " "\n")
35112     (pascal-mode  "@{ "    " @}\n")
35113     (sgml-mode    "<!-- " " -->\n")
35114     (xml-mode     "<!-- " " -->\n")
35115     (texinfo-mode "@@c "   "\n"))
35116 @end example
35117 Any major modes added to @code{calc-embedded-open-close-mode-alist}
35118 should also be added to @code{calc-embedded-announce-formula-alist}
35119 and @code{calc-embedded-open-close-plain-alist}.
35120 @end defvar
35122 @node Reporting Bugs, Summary, Customizable Variables, Top
35123 @appendix Reporting Bugs
35125 @noindent
35126 If you find a bug in Calc, send e-mail to Jay Belanger,
35128 @example
35129 belanger@@truman.edu
35130 @end example
35132 @noindent
35133 There is an automatic command @kbd{M-x report-calc-bug} which helps
35134 you to report bugs.  This command prompts you for a brief subject
35135 line, then leaves you in a mail editing buffer.  Type @kbd{C-c C-c} to
35136 send your mail.  Make sure your subject line indicates that you are
35137 reporting a Calc bug; this command sends mail to the maintainer's
35138 regular mailbox.
35140 If you have suggestions for additional features for Calc, please send
35141 them.  Some have dared to suggest that Calc is already top-heavy with
35142 features; this obviously cannot be the case, so if you have ideas, send
35143 them right in.
35145 At the front of the source file, @file{calc.el}, is a list of ideas for
35146 future work.  If any enthusiastic souls wish to take it upon themselves
35147 to work on these, please send a message (using @kbd{M-x report-calc-bug})
35148 so any efforts can be coordinated.
35150 The latest version of Calc is available from Savannah, in the Emacs
35151 CVS tree.  See @uref{http://savannah.gnu.org/projects/emacs}.
35153 @c [summary]
35154 @node Summary, Key Index, Reporting Bugs, Top
35155 @appendix Calc Summary
35157 @noindent
35158 This section includes a complete list of Calc 2.1 keystroke commands.
35159 Each line lists the stack entries used by the command (top-of-stack
35160 last), the keystrokes themselves, the prompts asked by the command,
35161 and the result of the command (also with top-of-stack last).
35162 The result is expressed using the equivalent algebraic function.
35163 Commands which put no results on the stack show the full @kbd{M-x}
35164 command name in that position.  Numbers preceding the result or
35165 command name refer to notes at the end.
35167 Algebraic functions and @kbd{M-x} commands that don't have corresponding
35168 keystrokes are not listed in this summary.
35169 @xref{Command Index}.  @xref{Function Index}.
35171 @iftex
35172 @begingroup
35173 @tex
35174 \vskip-2\baselineskip \null
35175 \gdef\sumrow#1{\sumrowx#1\relax}%
35176 \gdef\sumrowx#1\:#2\:#3\:#4\:#5\:#6\relax{%
35177 \leavevmode%
35178 {\smallfonts
35179 \hbox to5em{\sl\hss#1}%
35180 \hbox to5em{\tt#2\hss}%
35181 \hbox to4em{\sl#3\hss}%
35182 \hbox to5em{\rm\hss#4}%
35183 \thinspace%
35184 {\tt#5}%
35185 {\sl#6}%
35187 \gdef\sumlpar{{\rm(}}%
35188 \gdef\sumrpar{{\rm)}}%
35189 \gdef\sumcomma{{\rm,\thinspace}}%
35190 \gdef\sumexcl{{\rm!}}%
35191 \gdef\sumbreak{\vskip-2.5\baselineskip\goodbreak}%
35192 \gdef\minus#1{{\tt-}}%
35193 @end tex
35194 @let@:=@sumsep
35195 @let@r=@sumrow
35196 @catcode`@(=@active @let(=@sumlpar
35197 @catcode`@)=@active @let)=@sumrpar
35198 @catcode`@,=@active @let,=@sumcomma
35199 @catcode`@!=@active @let!=@sumexcl
35200 @end iftex
35201 @format
35202 @iftex
35203 @advance@baselineskip-2.5pt
35204 @let@c@sumbreak
35205 @end iftex
35206 @r{       @:     M-# a  @:             @:    33  @:calc-embedded-activate@:}
35207 @r{       @:     M-# b  @:             @:        @:calc-big-or-small@:}
35208 @r{       @:     M-# c  @:             @:        @:calc@:}
35209 @r{       @:     M-# d  @:             @:        @:calc-embedded-duplicate@:}
35210 @r{       @:     M-# e  @:             @:    34  @:calc-embedded@:}
35211 @r{       @:     M-# f  @:formula      @:        @:calc-embedded-new-formula@:}
35212 @r{       @:     M-# g  @:             @:    35  @:calc-grab-region@:}
35213 @r{       @:     M-# i  @:             @:        @:calc-info@:}
35214 @r{       @:     M-# j  @:             @:        @:calc-embedded-select@:}
35215 @r{       @:     M-# k  @:             @:        @:calc-keypad@:}
35216 @r{       @:     M-# l  @:             @:        @:calc-load-everything@:}
35217 @r{       @:     M-# m  @:             @:        @:read-kbd-macro@:}
35218 @r{       @:     M-# n  @:             @:     4  @:calc-embedded-next@:}
35219 @r{       @:     M-# o  @:             @:        @:calc-other-window@:}
35220 @r{       @:     M-# p  @:             @:     4  @:calc-embedded-previous@:}
35221 @r{       @:     M-# q  @:formula      @:        @:quick-calc@:}
35222 @r{       @:     M-# r  @:             @:    36  @:calc-grab-rectangle@:}
35223 @r{       @:     M-# s  @:             @:        @:calc-info-summary@:}
35224 @r{       @:     M-# t  @:             @:        @:calc-tutorial@:}
35225 @r{       @:     M-# u  @:             @:        @:calc-embedded-update-formula@:}
35226 @r{       @:     M-# w  @:             @:        @:calc-embedded-word@:}
35227 @r{       @:     M-# x  @:             @:        @:calc-quit@:}
35228 @r{       @:     M-# y  @:            @:1,28,49  @:calc-copy-to-buffer@:}
35229 @r{       @:     M-# z  @:             @:        @:calc-user-invocation@:}
35230 @r{       @:     M-# =  @:             @:        @:calc-embedded-update-formula@:}
35231 @r{       @:     M-# :  @:             @:    36  @:calc-grab-sum-down@:}
35232 @r{       @:     M-# _  @:             @:    36  @:calc-grab-sum-across@:}
35233 @r{       @:     M-# `  @:editing      @:    30  @:calc-embedded-edit@:}
35234 @r{       @:     M-# 0  @:(zero)       @:        @:calc-reset@:}
35237 @r{       @:      0-9   @:number       @:        @:@:number}
35238 @r{       @:      .     @:number       @:        @:@:0.number}
35239 @r{       @:      _     @:number       @:        @:-@:number}
35240 @r{       @:      e     @:number       @:        @:@:1e number}
35241 @r{       @:      #     @:number       @:        @:@:current-radix@tfn{#}number}
35242 @r{       @:      P     @:(in number)  @:        @:+/-@:}
35243 @r{       @:      M     @:(in number)  @:        @:mod@:}
35244 @r{       @:      @@ ' " @:  (in number)@:        @:@:HMS form}
35245 @r{       @:      h m s @:  (in number)@:        @:@:HMS form}
35248 @r{       @:      '     @:formula      @: 37,46  @:@:formula}
35249 @r{       @:      $     @:formula      @: 37,46  @:$@:formula}
35250 @r{       @:      "     @:string       @: 37,46  @:@:string}
35253 @r{    a b@:      +     @:             @:     2  @:add@:(a,b)  a+b}
35254 @r{    a b@:      -     @:             @:     2  @:sub@:(a,b)  a@minus{}b}
35255 @r{    a b@:      *     @:             @:     2  @:mul@:(a,b)  a b, a*b}
35256 @r{    a b@:      /     @:             @:     2  @:div@:(a,b)  a/b}
35257 @r{    a b@:      ^     @:             @:     2  @:pow@:(a,b)  a^b}
35258 @r{    a b@:    I ^     @:             @:     2  @:nroot@:(a,b)  a^(1/b)}
35259 @r{    a b@:      %     @:             @:     2  @:mod@:(a,b)  a%b}
35260 @r{    a b@:      \     @:             @:     2  @:idiv@:(a,b)  a\b}
35261 @r{    a b@:      :     @:             @:     2  @:fdiv@:(a,b)}
35262 @r{    a b@:      |     @:             @:     2  @:vconcat@:(a,b)  a|b}
35263 @r{    a b@:    I |     @:             @:        @:vconcat@:(b,a)  b|a}
35264 @r{    a b@:    H |     @:             @:     2  @:append@:(a,b)}
35265 @r{    a b@:  I H |     @:             @:        @:append@:(b,a)}
35266 @r{      a@:      &     @:             @:     1  @:inv@:(a)  1/a}
35267 @r{      a@:      !     @:             @:     1  @:fact@:(a)  a!}
35268 @r{      a@:      =     @:             @:     1  @:evalv@:(a)}
35269 @r{      a@:      M-%   @:             @:        @:percent@:(a)  a%}
35272 @r{  ... a@:      @key{RET}   @:             @:     1  @:@:... a a}
35273 @r{  ... a@:      @key{SPC}   @:             @:     1  @:@:... a a}
35274 @r{... a b@:      @key{TAB}   @:             @:     3  @:@:... b a}
35275 @r{. a b c@:      M-@key{TAB} @:             @:     3  @:@:... b c a}
35276 @r{... a b@:      @key{LFD}   @:             @:     1  @:@:... a b a}
35277 @r{  ... a@:      @key{DEL}   @:             @:     1  @:@:...}
35278 @r{... a b@:      M-@key{DEL} @:             @:     1  @:@:... b}
35279 @r{       @:      M-@key{RET} @:             @:     4  @:calc-last-args@:}
35280 @r{      a@:      `     @:editing      @:  1,30  @:calc-edit@:}
35283 @r{  ... a@:      C-d   @:             @:     1  @:@:...}
35284 @r{       @:      C-k   @:             @:    27  @:calc-kill@:}
35285 @r{       @:      C-w   @:             @:    27  @:calc-kill-region@:}
35286 @r{       @:      C-y   @:             @:        @:calc-yank@:}
35287 @r{       @:      C-_   @:             @:     4  @:calc-undo@:}
35288 @r{       @:      M-k   @:             @:    27  @:calc-copy-as-kill@:}
35289 @r{       @:      M-w   @:             @:    27  @:calc-copy-region-as-kill@:}
35292 @r{       @:      [     @:             @:        @:@:[...}
35293 @r{[.. a b@:      ]     @:             @:        @:@:[a,b]}
35294 @r{       @:      (     @:             @:        @:@:(...}
35295 @r{(.. a b@:      )     @:             @:        @:@:(a,b)}
35296 @r{       @:      ,     @:             @:        @:@:vector or rect complex}
35297 @r{       @:      ;     @:             @:        @:@:matrix or polar complex}
35298 @r{       @:      ..    @:             @:        @:@:interval}
35301 @r{       @:      ~     @:             @:        @:calc-num-prefix@:}
35302 @r{       @:      <     @:             @:     4  @:calc-scroll-left@:}
35303 @r{       @:      >     @:             @:     4  @:calc-scroll-right@:}
35304 @r{       @:      @{     @:             @:     4  @:calc-scroll-down@:}
35305 @r{       @:      @}     @:             @:     4  @:calc-scroll-up@:}
35306 @r{       @:      ?     @:             @:        @:calc-help@:}
35309 @r{      a@:      n     @:             @:     1  @:neg@:(a)  @minus{}a}
35310 @r{       @:      o     @:             @:     4  @:calc-realign@:}
35311 @r{       @:      p     @:precision    @:    31  @:calc-precision@:}
35312 @r{       @:      q     @:             @:        @:calc-quit@:}
35313 @r{       @:      w     @:             @:        @:calc-why@:}
35314 @r{       @:      x     @:command      @:        @:M-x calc-@:command}
35315 @r{      a@:      y     @:            @:1,28,49  @:calc-copy-to-buffer@:}
35318 @r{      a@:      A     @:             @:     1  @:abs@:(a)}
35319 @r{    a b@:      B     @:             @:     2  @:log@:(a,b)}
35320 @r{    a b@:    I B     @:             @:     2  @:alog@:(a,b)  b^a}
35321 @r{      a@:      C     @:             @:     1  @:cos@:(a)}
35322 @r{      a@:    I C     @:             @:     1  @:arccos@:(a)}
35323 @r{      a@:    H C     @:             @:     1  @:cosh@:(a)}
35324 @r{      a@:  I H C     @:             @:     1  @:arccosh@:(a)}
35325 @r{       @:      D     @:             @:     4  @:calc-redo@:}
35326 @r{      a@:      E     @:             @:     1  @:exp@:(a)}
35327 @r{      a@:    H E     @:             @:     1  @:exp10@:(a)  10.^a}
35328 @r{      a@:      F     @:             @:  1,11  @:floor@:(a,d)}
35329 @r{      a@:    I F     @:             @:  1,11  @:ceil@:(a,d)}
35330 @r{      a@:    H F     @:             @:  1,11  @:ffloor@:(a,d)}
35331 @r{      a@:  I H F     @:             @:  1,11  @:fceil@:(a,d)}
35332 @r{      a@:      G     @:             @:     1  @:arg@:(a)}
35333 @r{       @:      H     @:command      @:    32  @:@:Hyperbolic}
35334 @r{       @:      I     @:command      @:    32  @:@:Inverse}
35335 @r{      a@:      J     @:             @:     1  @:conj@:(a)}
35336 @r{       @:      K     @:command      @:    32  @:@:Keep-args}
35337 @r{      a@:      L     @:             @:     1  @:ln@:(a)}
35338 @r{      a@:    H L     @:             @:     1  @:log10@:(a)}
35339 @r{       @:      M     @:             @:        @:calc-more-recursion-depth@:}
35340 @r{       @:    I M     @:             @:        @:calc-less-recursion-depth@:}
35341 @r{      a@:      N     @:             @:     5  @:evalvn@:(a)}
35342 @r{       @:      P     @:             @:        @:@:pi}
35343 @r{       @:    I P     @:             @:        @:@:gamma}
35344 @r{       @:    H P     @:             @:        @:@:e}
35345 @r{       @:  I H P     @:             @:        @:@:phi}
35346 @r{      a@:      Q     @:             @:     1  @:sqrt@:(a)}
35347 @r{      a@:    I Q     @:             @:     1  @:sqr@:(a)  a^2}
35348 @r{      a@:      R     @:             @:  1,11  @:round@:(a,d)}
35349 @r{      a@:    I R     @:             @:  1,11  @:trunc@:(a,d)}
35350 @r{      a@:    H R     @:             @:  1,11  @:fround@:(a,d)}
35351 @r{      a@:  I H R     @:             @:  1,11  @:ftrunc@:(a,d)}
35352 @r{      a@:      S     @:             @:     1  @:sin@:(a)}
35353 @r{      a@:    I S     @:             @:     1  @:arcsin@:(a)}
35354 @r{      a@:    H S     @:             @:     1  @:sinh@:(a)}
35355 @r{      a@:  I H S     @:             @:     1  @:arcsinh@:(a)}
35356 @r{      a@:      T     @:             @:     1  @:tan@:(a)}
35357 @r{      a@:    I T     @:             @:     1  @:arctan@:(a)}
35358 @r{      a@:    H T     @:             @:     1  @:tanh@:(a)}
35359 @r{      a@:  I H T     @:             @:     1  @:arctanh@:(a)}
35360 @r{       @:      U     @:             @:     4  @:calc-undo@:}
35361 @r{       @:      X     @:             @:     4  @:calc-call-last-kbd-macro@:}
35364 @r{    a b@:      a =   @:             @:     2  @:eq@:(a,b)  a=b}
35365 @r{    a b@:      a #   @:             @:     2  @:neq@:(a,b)  a!=b}
35366 @r{    a b@:      a <   @:             @:     2  @:lt@:(a,b)  a<b}
35367 @r{    a b@:      a >   @:             @:     2  @:gt@:(a,b)  a>b}
35368 @r{    a b@:      a [   @:             @:     2  @:leq@:(a,b)  a<=b}
35369 @r{    a b@:      a ]   @:             @:     2  @:geq@:(a,b)  a>=b}
35370 @r{    a b@:      a @{   @:             @:     2  @:in@:(a,b)}
35371 @r{    a b@:      a &   @:             @:  2,45  @:land@:(a,b)  a&&b}
35372 @r{    a b@:      a |   @:             @:  2,45  @:lor@:(a,b)  a||b}
35373 @r{      a@:      a !   @:             @:  1,45  @:lnot@:(a)  !a}
35374 @r{  a b c@:      a :   @:             @:    45  @:if@:(a,b,c)  a?b:c}
35375 @r{      a@:      a .   @:             @:     1  @:rmeq@:(a)}
35376 @r{      a@:      a "   @:             @:   7,8  @:calc-expand-formula@:}
35379 @r{      a@:      a +   @:i, l, h      @:  6,38  @:sum@:(a,i,l,h)}
35380 @r{      a@:      a -   @:i, l, h      @:  6,38  @:asum@:(a,i,l,h)}
35381 @r{      a@:      a *   @:i, l, h      @:  6,38  @:prod@:(a,i,l,h)}
35382 @r{    a b@:      a _   @:             @:     2  @:subscr@:(a,b)  a_b}
35385 @r{    a b@:      a \   @:             @:     2  @:pdiv@:(a,b)}
35386 @r{    a b@:      a %   @:             @:     2  @:prem@:(a,b)}
35387 @r{    a b@:      a /   @:             @:     2  @:pdivrem@:(a,b)  [q,r]}
35388 @r{    a b@:    H a /   @:             @:     2  @:pdivide@:(a,b)  q+r/b}
35391 @r{      a@:      a a   @:             @:     1  @:apart@:(a)}
35392 @r{      a@:      a b   @:old, new     @:    38  @:subst@:(a,old,new)}
35393 @r{      a@:      a c   @:v            @:    38  @:collect@:(a,v)}
35394 @r{      a@:      a d   @:v            @:  4,38  @:deriv@:(a,v)}
35395 @r{      a@:    H a d   @:v            @:  4,38  @:tderiv@:(a,v)}
35396 @r{      a@:      a e   @:             @:        @:esimplify@:(a)}
35397 @r{      a@:      a f   @:             @:     1  @:factor@:(a)}
35398 @r{      a@:    H a f   @:             @:     1  @:factors@:(a)}
35399 @r{    a b@:      a g   @:             @:     2  @:pgcd@:(a,b)}
35400 @r{      a@:      a i   @:v            @:    38  @:integ@:(a,v)}
35401 @r{      a@:      a m   @:pats         @:    38  @:match@:(a,pats)}
35402 @r{      a@:    I a m   @:pats         @:    38  @:matchnot@:(a,pats)}
35403 @r{ data x@:      a p   @:             @:    28  @:polint@:(data,x)}
35404 @r{ data x@:    H a p   @:             @:    28  @:ratint@:(data,x)}
35405 @r{      a@:      a n   @:             @:     1  @:nrat@:(a)}
35406 @r{      a@:      a r   @:rules        @:4,8,38  @:rewrite@:(a,rules,n)}
35407 @r{      a@:      a s   @:             @:        @:simplify@:(a)}
35408 @r{      a@:      a t   @:v, n         @: 31,39  @:taylor@:(a,v,n)}
35409 @r{      a@:      a v   @:             @:   7,8  @:calc-alg-evaluate@:}
35410 @r{      a@:      a x   @:             @:   4,8  @:expand@:(a)}
35413 @r{   data@:      a F   @:model, vars  @:    48  @:fit@:(m,iv,pv,data)}
35414 @r{   data@:    I a F   @:model, vars  @:    48  @:xfit@:(m,iv,pv,data)}
35415 @r{   data@:    H a F   @:model, vars  @:    48  @:efit@:(m,iv,pv,data)}
35416 @r{      a@:      a I   @:v, l, h      @:    38  @:ninteg@:(a,v,l,h)}
35417 @r{    a b@:      a M   @:op           @:    22  @:mapeq@:(op,a,b)}
35418 @r{    a b@:    I a M   @:op           @:    22  @:mapeqr@:(op,a,b)}
35419 @r{    a b@:    H a M   @:op           @:    22  @:mapeqp@:(op,a,b)}
35420 @r{    a g@:      a N   @:v            @:    38  @:minimize@:(a,v,g)}
35421 @r{    a g@:    H a N   @:v            @:    38  @:wminimize@:(a,v,g)}
35422 @r{      a@:      a P   @:v            @:    38  @:roots@:(a,v)}
35423 @r{    a g@:      a R   @:v            @:    38  @:root@:(a,v,g)}
35424 @r{    a g@:    H a R   @:v            @:    38  @:wroot@:(a,v,g)}
35425 @r{      a@:      a S   @:v            @:    38  @:solve@:(a,v)}
35426 @r{      a@:    I a S   @:v            @:    38  @:finv@:(a,v)}
35427 @r{      a@:    H a S   @:v            @:    38  @:fsolve@:(a,v)}
35428 @r{      a@:  I H a S   @:v            @:    38  @:ffinv@:(a,v)}
35429 @r{      a@:      a T   @:i, l, h      @:  6,38  @:table@:(a,i,l,h)}
35430 @r{    a g@:      a X   @:v            @:    38  @:maximize@:(a,v,g)}
35431 @r{    a g@:    H a X   @:v            @:    38  @:wmaximize@:(a,v,g)}
35434 @r{    a b@:      b a   @:             @:     9  @:and@:(a,b,w)}
35435 @r{      a@:      b c   @:             @:     9  @:clip@:(a,w)}
35436 @r{    a b@:      b d   @:             @:     9  @:diff@:(a,b,w)}
35437 @r{      a@:      b l   @:             @:    10  @:lsh@:(a,n,w)}
35438 @r{    a n@:    H b l   @:             @:     9  @:lsh@:(a,n,w)}
35439 @r{      a@:      b n   @:             @:     9  @:not@:(a,w)}
35440 @r{    a b@:      b o   @:             @:     9  @:or@:(a,b,w)}
35441 @r{      v@:      b p   @:             @:     1  @:vpack@:(v)}
35442 @r{      a@:      b r   @:             @:    10  @:rsh@:(a,n,w)}
35443 @r{    a n@:    H b r   @:             @:     9  @:rsh@:(a,n,w)}
35444 @r{      a@:      b t   @:             @:    10  @:rot@:(a,n,w)}
35445 @r{    a n@:    H b t   @:             @:     9  @:rot@:(a,n,w)}
35446 @r{      a@:      b u   @:             @:     1  @:vunpack@:(a)}
35447 @r{       @:      b w   @:w            @:  9,50  @:calc-word-size@:}
35448 @r{    a b@:      b x   @:             @:     9  @:xor@:(a,b,w)}
35451 @r{c s l p@:      b D   @:             @:        @:ddb@:(c,s,l,p)}
35452 @r{  r n p@:      b F   @:             @:        @:fv@:(r,n,p)}
35453 @r{  r n p@:    I b F   @:             @:        @:fvb@:(r,n,p)}
35454 @r{  r n p@:    H b F   @:             @:        @:fvl@:(r,n,p)}
35455 @r{      v@:      b I   @:             @:    19  @:irr@:(v)}
35456 @r{      v@:    I b I   @:             @:    19  @:irrb@:(v)}
35457 @r{      a@:      b L   @:             @:    10  @:ash@:(a,n,w)}
35458 @r{    a n@:    H b L   @:             @:     9  @:ash@:(a,n,w)}
35459 @r{  r n a@:      b M   @:             @:        @:pmt@:(r,n,a)}
35460 @r{  r n a@:    I b M   @:             @:        @:pmtb@:(r,n,a)}
35461 @r{  r n a@:    H b M   @:             @:        @:pmtl@:(r,n,a)}
35462 @r{    r v@:      b N   @:             @:    19  @:npv@:(r,v)}
35463 @r{    r v@:    I b N   @:             @:    19  @:npvb@:(r,v)}
35464 @r{  r n p@:      b P   @:             @:        @:pv@:(r,n,p)}
35465 @r{  r n p@:    I b P   @:             @:        @:pvb@:(r,n,p)}
35466 @r{  r n p@:    H b P   @:             @:        @:pvl@:(r,n,p)}
35467 @r{      a@:      b R   @:             @:    10  @:rash@:(a,n,w)}
35468 @r{    a n@:    H b R   @:             @:     9  @:rash@:(a,n,w)}
35469 @r{  c s l@:      b S   @:             @:        @:sln@:(c,s,l)}
35470 @r{  n p a@:      b T   @:             @:        @:rate@:(n,p,a)}
35471 @r{  n p a@:    I b T   @:             @:        @:rateb@:(n,p,a)}
35472 @r{  n p a@:    H b T   @:             @:        @:ratel@:(n,p,a)}
35473 @r{c s l p@:      b Y   @:             @:        @:syd@:(c,s,l,p)}
35475 @r{  r p a@:      b #   @:             @:        @:nper@:(r,p,a)}
35476 @r{  r p a@:    I b #   @:             @:        @:nperb@:(r,p,a)}
35477 @r{  r p a@:    H b #   @:             @:        @:nperl@:(r,p,a)}
35478 @r{    a b@:      b %   @:             @:        @:relch@:(a,b)}
35481 @r{      a@:      c c   @:             @:     5  @:pclean@:(a,p)}
35482 @r{      a@:      c 0-9 @:             @:        @:pclean@:(a,p)}
35483 @r{      a@:    H c c   @:             @:     5  @:clean@:(a,p)}
35484 @r{      a@:    H c 0-9 @:             @:        @:clean@:(a,p)}
35485 @r{      a@:      c d   @:             @:     1  @:deg@:(a)}
35486 @r{      a@:      c f   @:             @:     1  @:pfloat@:(a)}
35487 @r{      a@:    H c f   @:             @:     1  @:float@:(a)}
35488 @r{      a@:      c h   @:             @:     1  @:hms@:(a)}
35489 @r{      a@:      c p   @:             @:        @:polar@:(a)}
35490 @r{      a@:    I c p   @:             @:        @:rect@:(a)}
35491 @r{      a@:      c r   @:             @:     1  @:rad@:(a)}
35494 @r{      a@:      c F   @:             @:     5  @:pfrac@:(a,p)}
35495 @r{      a@:    H c F   @:             @:     5  @:frac@:(a,p)}
35498 @r{      a@:      c %   @:             @:        @:percent@:(a*100)}
35501 @r{       @:      d .   @:char         @:    50  @:calc-point-char@:}
35502 @r{       @:      d ,   @:char         @:    50  @:calc-group-char@:}
35503 @r{       @:      d <   @:             @: 13,50  @:calc-left-justify@:}
35504 @r{       @:      d =   @:             @: 13,50  @:calc-center-justify@:}
35505 @r{       @:      d >   @:             @: 13,50  @:calc-right-justify@:}
35506 @r{       @:      d @{   @:label        @:    50  @:calc-left-label@:}
35507 @r{       @:      d @}   @:label        @:    50  @:calc-right-label@:}
35508 @r{       @:      d [   @:             @:     4  @:calc-truncate-up@:}
35509 @r{       @:      d ]   @:             @:     4  @:calc-truncate-down@:}
35510 @r{       @:      d "   @:             @: 12,50  @:calc-display-strings@:}
35511 @r{       @:      d @key{SPC} @:             @:        @:calc-refresh@:}
35512 @r{       @:      d @key{RET} @:             @:     1  @:calc-refresh-top@:}
35515 @r{       @:      d 0   @:             @:    50  @:calc-decimal-radix@:}
35516 @r{       @:      d 2   @:             @:    50  @:calc-binary-radix@:}
35517 @r{       @:      d 6   @:             @:    50  @:calc-hex-radix@:}
35518 @r{       @:      d 8   @:             @:    50  @:calc-octal-radix@:}
35521 @r{       @:      d b   @:           @:12,13,50  @:calc-line-breaking@:}
35522 @r{       @:      d c   @:             @:    50  @:calc-complex-notation@:}
35523 @r{       @:      d d   @:format       @:    50  @:calc-date-notation@:}
35524 @r{       @:      d e   @:             @:  5,50  @:calc-eng-notation@:}
35525 @r{       @:      d f   @:num          @: 31,50  @:calc-fix-notation@:}
35526 @r{       @:      d g   @:           @:12,13,50  @:calc-group-digits@:}
35527 @r{       @:      d h   @:format       @:    50  @:calc-hms-notation@:}
35528 @r{       @:      d i   @:             @:    50  @:calc-i-notation@:}
35529 @r{       @:      d j   @:             @:    50  @:calc-j-notation@:}
35530 @r{       @:      d l   @:             @: 12,50  @:calc-line-numbering@:}
35531 @r{       @:      d n   @:             @:  5,50  @:calc-normal-notation@:}
35532 @r{       @:      d o   @:format       @:    50  @:calc-over-notation@:}
35533 @r{       @:      d p   @:             @: 12,50  @:calc-show-plain@:}
35534 @r{       @:      d r   @:radix        @: 31,50  @:calc-radix@:}
35535 @r{       @:      d s   @:             @:  5,50  @:calc-sci-notation@:}
35536 @r{       @:      d t   @:             @:    27  @:calc-truncate-stack@:}
35537 @r{       @:      d w   @:             @: 12,13  @:calc-auto-why@:}
35538 @r{       @:      d z   @:             @: 12,50  @:calc-leading-zeros@:}
35541 @r{       @:      d B   @:             @:    50  @:calc-big-language@:}
35542 @r{       @:      d C   @:             @:    50  @:calc-c-language@:}
35543 @r{       @:      d E   @:             @:    50  @:calc-eqn-language@:}
35544 @r{       @:      d F   @:             @:    50  @:calc-fortran-language@:}
35545 @r{       @:      d M   @:             @:    50  @:calc-mathematica-language@:}
35546 @r{       @:      d N   @:             @:    50  @:calc-normal-language@:}
35547 @r{       @:      d O   @:             @:    50  @:calc-flat-language@:}
35548 @r{       @:      d P   @:             @:    50  @:calc-pascal-language@:}
35549 @r{       @:      d T   @:             @:    50  @:calc-tex-language@:}
35550 @r{       @:      d L   @:             @:    50  @:calc-latex-language@:}
35551 @r{       @:      d U   @:             @:    50  @:calc-unformatted-language@:}
35552 @r{       @:      d W   @:             @:    50  @:calc-maple-language@:}
35555 @r{      a@:      f [   @:             @:     4  @:decr@:(a,n)}
35556 @r{      a@:      f ]   @:             @:     4  @:incr@:(a,n)}
35559 @r{    a b@:      f b   @:             @:     2  @:beta@:(a,b)}
35560 @r{      a@:      f e   @:             @:     1  @:erf@:(a)}
35561 @r{      a@:    I f e   @:             @:     1  @:erfc@:(a)}
35562 @r{      a@:      f g   @:             @:     1  @:gamma@:(a)}
35563 @r{    a b@:      f h   @:             @:     2  @:hypot@:(a,b)}
35564 @r{      a@:      f i   @:             @:     1  @:im@:(a)}
35565 @r{    n a@:      f j   @:             @:     2  @:besJ@:(n,a)}
35566 @r{    a b@:      f n   @:             @:     2  @:min@:(a,b)}
35567 @r{      a@:      f r   @:             @:     1  @:re@:(a)}
35568 @r{      a@:      f s   @:             @:     1  @:sign@:(a)}
35569 @r{    a b@:      f x   @:             @:     2  @:max@:(a,b)}
35570 @r{    n a@:      f y   @:             @:     2  @:besY@:(n,a)}
35573 @r{      a@:      f A   @:             @:     1  @:abssqr@:(a)}
35574 @r{  x a b@:      f B   @:             @:        @:betaI@:(x,a,b)}
35575 @r{  x a b@:    H f B   @:             @:        @:betaB@:(x,a,b)}
35576 @r{      a@:      f E   @:             @:     1  @:expm1@:(a)}
35577 @r{    a x@:      f G   @:             @:     2  @:gammaP@:(a,x)}
35578 @r{    a x@:    I f G   @:             @:     2  @:gammaQ@:(a,x)}
35579 @r{    a x@:    H f G   @:             @:     2  @:gammag@:(a,x)}
35580 @r{    a x@:  I H f G   @:             @:     2  @:gammaG@:(a,x)}
35581 @r{    a b@:      f I   @:             @:     2  @:ilog@:(a,b)}
35582 @r{    a b@:    I f I   @:             @:     2  @:alog@:(a,b)  b^a}
35583 @r{      a@:      f L   @:             @:     1  @:lnp1@:(a)}
35584 @r{      a@:      f M   @:             @:     1  @:mant@:(a)}
35585 @r{      a@:      f Q   @:             @:     1  @:isqrt@:(a)}
35586 @r{      a@:    I f Q   @:             @:     1  @:sqr@:(a)  a^2}
35587 @r{    a n@:      f S   @:             @:     2  @:scf@:(a,n)}
35588 @r{    y x@:      f T   @:             @:        @:arctan2@:(y,x)}
35589 @r{      a@:      f X   @:             @:     1  @:xpon@:(a)}
35592 @r{    x y@:      g a   @:             @: 28,40  @:calc-graph-add@:}
35593 @r{       @:      g b   @:             @:    12  @:calc-graph-border@:}
35594 @r{       @:      g c   @:             @:        @:calc-graph-clear@:}
35595 @r{       @:      g d   @:             @:    41  @:calc-graph-delete@:}
35596 @r{    x y@:      g f   @:             @: 28,40  @:calc-graph-fast@:}
35597 @r{       @:      g g   @:             @:    12  @:calc-graph-grid@:}
35598 @r{       @:      g h   @:title        @:        @:calc-graph-header@:}
35599 @r{       @:      g j   @:             @:     4  @:calc-graph-juggle@:}
35600 @r{       @:      g k   @:             @:    12  @:calc-graph-key@:}
35601 @r{       @:      g l   @:             @:    12  @:calc-graph-log-x@:}
35602 @r{       @:      g n   @:name         @:        @:calc-graph-name@:}
35603 @r{       @:      g p   @:             @:    42  @:calc-graph-plot@:}
35604 @r{       @:      g q   @:             @:        @:calc-graph-quit@:}
35605 @r{       @:      g r   @:range        @:        @:calc-graph-range-x@:}
35606 @r{       @:      g s   @:             @: 12,13  @:calc-graph-line-style@:}
35607 @r{       @:      g t   @:title        @:        @:calc-graph-title-x@:}
35608 @r{       @:      g v   @:             @:        @:calc-graph-view-commands@:}
35609 @r{       @:      g x   @:display      @:        @:calc-graph-display@:}
35610 @r{       @:      g z   @:             @:    12  @:calc-graph-zero-x@:}
35613 @r{  x y z@:      g A   @:             @: 28,40  @:calc-graph-add-3d@:}
35614 @r{       @:      g C   @:command      @:        @:calc-graph-command@:}
35615 @r{       @:      g D   @:device       @: 43,44  @:calc-graph-device@:}
35616 @r{  x y z@:      g F   @:             @: 28,40  @:calc-graph-fast-3d@:}
35617 @r{       @:      g H   @:             @:    12  @:calc-graph-hide@:}
35618 @r{       @:      g K   @:             @:        @:calc-graph-kill@:}
35619 @r{       @:      g L   @:             @:    12  @:calc-graph-log-y@:}
35620 @r{       @:      g N   @:number       @: 43,51  @:calc-graph-num-points@:}
35621 @r{       @:      g O   @:filename     @: 43,44  @:calc-graph-output@:}
35622 @r{       @:      g P   @:             @:    42  @:calc-graph-print@:}
35623 @r{       @:      g R   @:range        @:        @:calc-graph-range-y@:}
35624 @r{       @:      g S   @:             @: 12,13  @:calc-graph-point-style@:}
35625 @r{       @:      g T   @:title        @:        @:calc-graph-title-y@:}
35626 @r{       @:      g V   @:             @:        @:calc-graph-view-trail@:}
35627 @r{       @:      g X   @:format       @:        @:calc-graph-geometry@:}
35628 @r{       @:      g Z   @:             @:    12  @:calc-graph-zero-y@:}
35631 @r{       @:      g C-l @:             @:    12  @:calc-graph-log-z@:}
35632 @r{       @:      g C-r @:range        @:        @:calc-graph-range-z@:}
35633 @r{       @:      g C-t @:title        @:        @:calc-graph-title-z@:}
35636 @r{       @:      h b   @:             @:        @:calc-describe-bindings@:}
35637 @r{       @:      h c   @:key          @:        @:calc-describe-key-briefly@:}
35638 @r{       @:      h f   @:function     @:        @:calc-describe-function@:}
35639 @r{       @:      h h   @:             @:        @:calc-full-help@:}
35640 @r{       @:      h i   @:             @:        @:calc-info@:}
35641 @r{       @:      h k   @:key          @:        @:calc-describe-key@:}
35642 @r{       @:      h n   @:             @:        @:calc-view-news@:}
35643 @r{       @:      h s   @:             @:        @:calc-info-summary@:}
35644 @r{       @:      h t   @:             @:        @:calc-tutorial@:}
35645 @r{       @:      h v   @:var          @:        @:calc-describe-variable@:}
35648 @r{       @:      j 1-9 @:             @:        @:calc-select-part@:}
35649 @r{       @:      j @key{RET} @:             @:    27  @:calc-copy-selection@:}
35650 @r{       @:      j @key{DEL} @:             @:    27  @:calc-del-selection@:}
35651 @r{       @:      j '   @:formula      @:    27  @:calc-enter-selection@:}
35652 @r{       @:      j `   @:editing      @: 27,30  @:calc-edit-selection@:}
35653 @r{       @:      j "   @:             @:  7,27  @:calc-sel-expand-formula@:}
35656 @r{       @:      j +   @:formula      @:    27  @:calc-sel-add-both-sides@:}
35657 @r{       @:      j -   @:formula      @:    27  @:calc-sel-sub-both-sides@:}
35658 @r{       @:      j *   @:formula      @:    27  @:calc-sel-mul-both-sides@:}
35659 @r{       @:      j /   @:formula      @:    27  @:calc-sel-div-both-sides@:}
35660 @r{       @:      j &   @:             @:    27  @:calc-sel-invert@:}
35663 @r{       @:      j a   @:             @:    27  @:calc-select-additional@:}
35664 @r{       @:      j b   @:             @:    12  @:calc-break-selections@:}
35665 @r{       @:      j c   @:             @:        @:calc-clear-selections@:}
35666 @r{       @:      j d   @:             @: 12,50  @:calc-show-selections@:}
35667 @r{       @:      j e   @:             @:    12  @:calc-enable-selections@:}
35668 @r{       @:      j l   @:             @:  4,27  @:calc-select-less@:}
35669 @r{       @:      j m   @:             @:  4,27  @:calc-select-more@:}
35670 @r{       @:      j n   @:             @:     4  @:calc-select-next@:}
35671 @r{       @:      j o   @:             @:  4,27  @:calc-select-once@:}
35672 @r{       @:      j p   @:             @:     4  @:calc-select-previous@:}
35673 @r{       @:      j r   @:rules        @:4,8,27  @:calc-rewrite-selection@:}
35674 @r{       @:      j s   @:             @:  4,27  @:calc-select-here@:}
35675 @r{       @:      j u   @:             @:    27  @:calc-unselect@:}
35676 @r{       @:      j v   @:             @:  7,27  @:calc-sel-evaluate@:}
35679 @r{       @:      j C   @:             @:    27  @:calc-sel-commute@:}
35680 @r{       @:      j D   @:             @:  4,27  @:calc-sel-distribute@:}
35681 @r{       @:      j E   @:             @:    27  @:calc-sel-jump-equals@:}
35682 @r{       @:      j I   @:             @:    27  @:calc-sel-isolate@:}
35683 @r{       @:    H j I   @:             @:    27  @:calc-sel-isolate@: (full)}
35684 @r{       @:      j L   @:             @:  4,27  @:calc-commute-left@:}
35685 @r{       @:      j M   @:             @:    27  @:calc-sel-merge@:}
35686 @r{       @:      j N   @:             @:    27  @:calc-sel-negate@:}
35687 @r{       @:      j O   @:             @:  4,27  @:calc-select-once-maybe@:}
35688 @r{       @:      j R   @:             @:  4,27  @:calc-commute-right@:}
35689 @r{       @:      j S   @:             @:  4,27  @:calc-select-here-maybe@:}
35690 @r{       @:      j U   @:             @:    27  @:calc-sel-unpack@:}
35693 @r{       @:      k a   @:             @:        @:calc-random-again@:}
35694 @r{      n@:      k b   @:             @:     1  @:bern@:(n)}
35695 @r{    n x@:    H k b   @:             @:     2  @:bern@:(n,x)}
35696 @r{    n m@:      k c   @:             @:     2  @:choose@:(n,m)}
35697 @r{    n m@:    H k c   @:             @:     2  @:perm@:(n,m)}
35698 @r{      n@:      k d   @:             @:     1  @:dfact@:(n)  n!!}
35699 @r{      n@:      k e   @:             @:     1  @:euler@:(n)}
35700 @r{    n x@:    H k e   @:             @:     2  @:euler@:(n,x)}
35701 @r{      n@:      k f   @:             @:     4  @:prfac@:(n)}
35702 @r{    n m@:      k g   @:             @:     2  @:gcd@:(n,m)}
35703 @r{    m n@:      k h   @:             @:    14  @:shuffle@:(n,m)}
35704 @r{    n m@:      k l   @:             @:     2  @:lcm@:(n,m)}
35705 @r{      n@:      k m   @:             @:     1  @:moebius@:(n)}
35706 @r{      n@:      k n   @:             @:     4  @:nextprime@:(n)}
35707 @r{      n@:    I k n   @:             @:     4  @:prevprime@:(n)}
35708 @r{      n@:      k p   @:             @:  4,28  @:calc-prime-test@:}
35709 @r{      m@:      k r   @:             @:    14  @:random@:(m)}
35710 @r{    n m@:      k s   @:             @:     2  @:stir1@:(n,m)}
35711 @r{    n m@:    H k s   @:             @:     2  @:stir2@:(n,m)}
35712 @r{      n@:      k t   @:             @:     1  @:totient@:(n)}
35715 @r{  n p x@:      k B   @:             @:        @:utpb@:(x,n,p)}
35716 @r{  n p x@:    I k B   @:             @:        @:ltpb@:(x,n,p)}
35717 @r{    v x@:      k C   @:             @:        @:utpc@:(x,v)}
35718 @r{    v x@:    I k C   @:             @:        @:ltpc@:(x,v)}
35719 @r{    n m@:      k E   @:             @:        @:egcd@:(n,m)}
35720 @r{v1 v2 x@:      k F   @:             @:        @:utpf@:(x,v1,v2)}
35721 @r{v1 v2 x@:    I k F   @:             @:        @:ltpf@:(x,v1,v2)}
35722 @r{  m s x@:      k N   @:             @:        @:utpn@:(x,m,s)}
35723 @r{  m s x@:    I k N   @:             @:        @:ltpn@:(x,m,s)}
35724 @r{    m x@:      k P   @:             @:        @:utpp@:(x,m)}
35725 @r{    m x@:    I k P   @:             @:        @:ltpp@:(x,m)}
35726 @r{    v x@:      k T   @:             @:        @:utpt@:(x,v)}
35727 @r{    v x@:    I k T   @:             @:        @:ltpt@:(x,v)}
35730 @r{       @:      m a   @:             @: 12,13  @:calc-algebraic-mode@:}
35731 @r{       @:      m d   @:             @:        @:calc-degrees-mode@:}
35732 @r{       @:      m e   @:             @:        @:calc-embedded-preserve-modes@:}
35733 @r{       @:      m f   @:             @:    12  @:calc-frac-mode@:}
35734 @r{       @:      m g   @:             @:    52  @:calc-get-modes@:}
35735 @r{       @:      m h   @:             @:        @:calc-hms-mode@:}
35736 @r{       @:      m i   @:             @: 12,13  @:calc-infinite-mode@:}
35737 @r{       @:      m m   @:             @:        @:calc-save-modes@:}
35738 @r{       @:      m p   @:             @:    12  @:calc-polar-mode@:}
35739 @r{       @:      m r   @:             @:        @:calc-radians-mode@:}
35740 @r{       @:      m s   @:             @:    12  @:calc-symbolic-mode@:}
35741 @r{       @:      m t   @:             @:    12  @:calc-total-algebraic-mode@:}
35742 @r{       @:      m v   @:             @: 12,13  @:calc-matrix-mode@:}
35743 @r{       @:      m w   @:             @:    13  @:calc-working@:}
35744 @r{       @:      m x   @:             @:        @:calc-always-load-extensions@:}
35747 @r{       @:      m A   @:             @:    12  @:calc-alg-simplify-mode@:}
35748 @r{       @:      m B   @:             @:    12  @:calc-bin-simplify-mode@:}
35749 @r{       @:      m C   @:             @:    12  @:calc-auto-recompute@:}
35750 @r{       @:      m D   @:             @:        @:calc-default-simplify-mode@:}
35751 @r{       @:      m E   @:             @:    12  @:calc-ext-simplify-mode@:}
35752 @r{       @:      m F   @:filename     @:    13  @:calc-settings-file-name@:}
35753 @r{       @:      m N   @:             @:    12  @:calc-num-simplify-mode@:}
35754 @r{       @:      m O   @:             @:    12  @:calc-no-simplify-mode@:}
35755 @r{       @:      m R   @:             @: 12,13  @:calc-mode-record-mode@:}
35756 @r{       @:      m S   @:             @:    12  @:calc-shift-prefix@:}
35757 @r{       @:      m U   @:             @:    12  @:calc-units-simplify-mode@:}
35760 @r{       @:      s c   @:var1, var2   @:    29  @:calc-copy-variable@:}
35761 @r{       @:      s d   @:var, decl    @:        @:calc-declare-variable@:}
35762 @r{       @:      s e   @:var, editing @: 29,30  @:calc-edit-variable@:}
35763 @r{       @:      s i   @:buffer       @:        @:calc-insert-variables@:}
35764 @r{       @:      s k   @:const, var   @:    29  @:calc-copy-special-constant@:}
35765 @r{    a b@:      s l   @:var          @:    29  @:@:a  (letting var=b)}
35766 @r{  a ...@:      s m   @:op, var      @: 22,29  @:calc-store-map@:}
35767 @r{       @:      s n   @:var          @: 29,47  @:calc-store-neg@:  (v/-1)}
35768 @r{       @:      s p   @:var          @:    29  @:calc-permanent-variable@:}
35769 @r{       @:      s r   @:var          @:    29  @:@:v  (recalled value)}
35770 @r{       @:      r 0-9 @:             @:        @:calc-recall-quick@:}
35771 @r{      a@:      s s   @:var          @: 28,29  @:calc-store@:}
35772 @r{      a@:      s 0-9 @:             @:        @:calc-store-quick@:}
35773 @r{      a@:      s t   @:var          @:    29  @:calc-store-into@:}
35774 @r{      a@:      t 0-9 @:             @:        @:calc-store-into-quick@:}
35775 @r{       @:      s u   @:var          @:    29  @:calc-unstore@:}
35776 @r{      a@:      s x   @:var          @:    29  @:calc-store-exchange@:}
35779 @r{       @:      s A   @:editing      @:    30  @:calc-edit-AlgSimpRules@:}
35780 @r{       @:      s D   @:editing      @:    30  @:calc-edit-Decls@:}
35781 @r{       @:      s E   @:editing      @:    30  @:calc-edit-EvalRules@:}
35782 @r{       @:      s F   @:editing      @:    30  @:calc-edit-FitRules@:}
35783 @r{       @:      s G   @:editing      @:    30  @:calc-edit-GenCount@:}
35784 @r{       @:      s H   @:editing      @:    30  @:calc-edit-Holidays@:}
35785 @r{       @:      s I   @:editing      @:    30  @:calc-edit-IntegLimit@:}
35786 @r{       @:      s L   @:editing      @:    30  @:calc-edit-LineStyles@:}
35787 @r{       @:      s P   @:editing      @:    30  @:calc-edit-PointStyles@:}
35788 @r{       @:      s R   @:editing      @:    30  @:calc-edit-PlotRejects@:}
35789 @r{       @:      s T   @:editing      @:    30  @:calc-edit-TimeZone@:}
35790 @r{       @:      s U   @:editing      @:    30  @:calc-edit-Units@:}
35791 @r{       @:      s X   @:editing      @:    30  @:calc-edit-ExtSimpRules@:}
35794 @r{      a@:      s +   @:var          @: 29,47  @:calc-store-plus@:  (v+a)}
35795 @r{      a@:      s -   @:var          @: 29,47  @:calc-store-minus@:  (v-a)}
35796 @r{      a@:      s *   @:var          @: 29,47  @:calc-store-times@:  (v*a)}
35797 @r{      a@:      s /   @:var          @: 29,47  @:calc-store-div@:  (v/a)}
35798 @r{      a@:      s ^   @:var          @: 29,47  @:calc-store-power@:  (v^a)}
35799 @r{      a@:      s |   @:var          @: 29,47  @:calc-store-concat@:  (v|a)}
35800 @r{       @:      s &   @:var          @: 29,47  @:calc-store-inv@:  (v^-1)}
35801 @r{       @:      s [   @:var          @: 29,47  @:calc-store-decr@:  (v-1)}
35802 @r{       @:      s ]   @:var          @: 29,47  @:calc-store-incr@:  (v-(-1))}
35803 @r{    a b@:      s :   @:             @:     2  @:assign@:(a,b)  a @tfn{:=} b}
35804 @r{      a@:      s =   @:             @:     1  @:evalto@:(a,b)  a @tfn{=>}}
35807 @r{       @:      t [   @:             @:     4  @:calc-trail-first@:}
35808 @r{       @:      t ]   @:             @:     4  @:calc-trail-last@:}
35809 @r{       @:      t <   @:             @:     4  @:calc-trail-scroll-left@:}
35810 @r{       @:      t >   @:             @:     4  @:calc-trail-scroll-right@:}
35811 @r{       @:      t .   @:             @:    12  @:calc-full-trail-vectors@:}
35814 @r{       @:      t b   @:             @:     4  @:calc-trail-backward@:}
35815 @r{       @:      t d   @:             @: 12,50  @:calc-trail-display@:}
35816 @r{       @:      t f   @:             @:     4  @:calc-trail-forward@:}
35817 @r{       @:      t h   @:             @:        @:calc-trail-here@:}
35818 @r{       @:      t i   @:             @:        @:calc-trail-in@:}
35819 @r{       @:      t k   @:             @:     4  @:calc-trail-kill@:}
35820 @r{       @:      t m   @:string       @:        @:calc-trail-marker@:}
35821 @r{       @:      t n   @:             @:     4  @:calc-trail-next@:}
35822 @r{       @:      t o   @:             @:        @:calc-trail-out@:}
35823 @r{       @:      t p   @:             @:     4  @:calc-trail-previous@:}
35824 @r{       @:      t r   @:string       @:        @:calc-trail-isearch-backward@:}
35825 @r{       @:      t s   @:string       @:        @:calc-trail-isearch-forward@:}
35826 @r{       @:      t y   @:             @:     4  @:calc-trail-yank@:}
35829 @r{      d@:      t C   @:oz, nz       @:        @:tzconv@:(d,oz,nz)}
35830 @r{d oz nz@:      t C   @:$            @:        @:tzconv@:(d,oz,nz)}
35831 @r{      d@:      t D   @:             @:    15  @:date@:(d)}
35832 @r{      d@:      t I   @:             @:     4  @:incmonth@:(d,n)}
35833 @r{      d@:      t J   @:             @:    16  @:julian@:(d,z)}
35834 @r{      d@:      t M   @:             @:    17  @:newmonth@:(d,n)}
35835 @r{       @:      t N   @:             @:    16  @:now@:(z)}
35836 @r{      d@:      t P   @:1            @:    31  @:year@:(d)}
35837 @r{      d@:      t P   @:2            @:    31  @:month@:(d)}
35838 @r{      d@:      t P   @:3            @:    31  @:day@:(d)}
35839 @r{      d@:      t P   @:4            @:    31  @:hour@:(d)}
35840 @r{      d@:      t P   @:5            @:    31  @:minute@:(d)}
35841 @r{      d@:      t P   @:6            @:    31  @:second@:(d)}
35842 @r{      d@:      t P   @:7            @:    31  @:weekday@:(d)}
35843 @r{      d@:      t P   @:8            @:    31  @:yearday@:(d)}
35844 @r{      d@:      t P   @:9            @:    31  @:time@:(d)}
35845 @r{      d@:      t U   @:             @:    16  @:unixtime@:(d,z)}
35846 @r{      d@:      t W   @:             @:    17  @:newweek@:(d,w)}
35847 @r{      d@:      t Y   @:             @:    17  @:newyear@:(d,n)}
35850 @r{    a b@:      t +   @:             @:     2  @:badd@:(a,b)}
35851 @r{    a b@:      t -   @:             @:     2  @:bsub@:(a,b)}
35854 @r{       @:      u a   @:             @:    12  @:calc-autorange-units@:}
35855 @r{      a@:      u b   @:             @:        @:calc-base-units@:}
35856 @r{      a@:      u c   @:units        @:    18  @:calc-convert-units@:}
35857 @r{   defn@:      u d   @:unit, descr  @:        @:calc-define-unit@:}
35858 @r{       @:      u e   @:             @:        @:calc-explain-units@:}
35859 @r{       @:      u g   @:unit         @:        @:calc-get-unit-definition@:}
35860 @r{       @:      u p   @:             @:        @:calc-permanent-units@:}
35861 @r{      a@:      u r   @:             @:        @:calc-remove-units@:}
35862 @r{      a@:      u s   @:             @:        @:usimplify@:(a)}
35863 @r{      a@:      u t   @:units        @:    18  @:calc-convert-temperature@:}
35864 @r{       @:      u u   @:unit         @:        @:calc-undefine-unit@:}
35865 @r{       @:      u v   @:             @:        @:calc-enter-units-table@:}
35866 @r{      a@:      u x   @:             @:        @:calc-extract-units@:}
35867 @r{      a@:      u 0-9 @:             @:        @:calc-quick-units@:}
35870 @r{  v1 v2@:      u C   @:             @:    20  @:vcov@:(v1,v2)}
35871 @r{  v1 v2@:    I u C   @:             @:    20  @:vpcov@:(v1,v2)}
35872 @r{  v1 v2@:    H u C   @:             @:    20  @:vcorr@:(v1,v2)}
35873 @r{      v@:      u G   @:             @:    19  @:vgmean@:(v)}
35874 @r{    a b@:    H u G   @:             @:     2  @:agmean@:(a,b)}
35875 @r{      v@:      u M   @:             @:    19  @:vmean@:(v)}
35876 @r{      v@:    I u M   @:             @:    19  @:vmeane@:(v)}
35877 @r{      v@:    H u M   @:             @:    19  @:vmedian@:(v)}
35878 @r{      v@:  I H u M   @:             @:    19  @:vhmean@:(v)}
35879 @r{      v@:      u N   @:             @:    19  @:vmin@:(v)}
35880 @r{      v@:      u S   @:             @:    19  @:vsdev@:(v)}
35881 @r{      v@:    I u S   @:             @:    19  @:vpsdev@:(v)}
35882 @r{      v@:    H u S   @:             @:    19  @:vvar@:(v)}
35883 @r{      v@:  I H u S   @:             @:    19  @:vpvar@:(v)}
35884 @r{       @:      u V   @:             @:        @:calc-view-units-table@:}
35885 @r{      v@:      u X   @:             @:    19  @:vmax@:(v)}
35888 @r{      v@:      u +   @:             @:    19  @:vsum@:(v)}
35889 @r{      v@:      u *   @:             @:    19  @:vprod@:(v)}
35890 @r{      v@:      u #   @:             @:    19  @:vcount@:(v)}
35893 @r{       @:      V (   @:             @:    50  @:calc-vector-parens@:}
35894 @r{       @:      V @{   @:             @:    50  @:calc-vector-braces@:}
35895 @r{       @:      V [   @:             @:    50  @:calc-vector-brackets@:}
35896 @r{       @:      V ]   @:ROCP         @:    50  @:calc-matrix-brackets@:}
35897 @r{       @:      V ,   @:             @:    50  @:calc-vector-commas@:}
35898 @r{       @:      V <   @:             @:    50  @:calc-matrix-left-justify@:}
35899 @r{       @:      V =   @:             @:    50  @:calc-matrix-center-justify@:}
35900 @r{       @:      V >   @:             @:    50  @:calc-matrix-right-justify@:}
35901 @r{       @:      V /   @:             @: 12,50  @:calc-break-vectors@:}
35902 @r{       @:      V .   @:             @: 12,50  @:calc-full-vectors@:}
35905 @r{    s t@:      V ^   @:             @:     2  @:vint@:(s,t)}
35906 @r{    s t@:      V -   @:             @:     2  @:vdiff@:(s,t)}
35907 @r{      s@:      V ~   @:             @:     1  @:vcompl@:(s)}
35908 @r{      s@:      V #   @:             @:     1  @:vcard@:(s)}
35909 @r{      s@:      V :   @:             @:     1  @:vspan@:(s)}
35910 @r{      s@:      V +   @:             @:     1  @:rdup@:(s)}
35913 @r{      m@:      V &   @:             @:     1  @:inv@:(m)  1/m}
35916 @r{      v@:      v a   @:n            @:        @:arrange@:(v,n)}
35917 @r{      a@:      v b   @:n            @:        @:cvec@:(a,n)}
35918 @r{      v@:      v c   @:n >0         @: 21,31  @:mcol@:(v,n)}
35919 @r{      v@:      v c   @:n <0         @:    31  @:mrcol@:(v,-n)}
35920 @r{      m@:      v c   @:0            @:    31  @:getdiag@:(m)}
35921 @r{      v@:      v d   @:             @:    25  @:diag@:(v,n)}
35922 @r{    v m@:      v e   @:             @:     2  @:vexp@:(v,m)}
35923 @r{  v m f@:    H v e   @:             @:     2  @:vexp@:(v,m,f)}
35924 @r{    v a@:      v f   @:             @:    26  @:find@:(v,a,n)}
35925 @r{      v@:      v h   @:             @:     1  @:head@:(v)}
35926 @r{      v@:    I v h   @:             @:     1  @:tail@:(v)}
35927 @r{      v@:    H v h   @:             @:     1  @:rhead@:(v)}
35928 @r{      v@:  I H v h   @:             @:     1  @:rtail@:(v)}
35929 @r{       @:      v i   @:n            @:    31  @:idn@:(1,n)}
35930 @r{       @:      v i   @:0            @:    31  @:idn@:(1)}
35931 @r{    h t@:      v k   @:             @:     2  @:cons@:(h,t)}
35932 @r{    h t@:    H v k   @:             @:     2  @:rcons@:(h,t)}
35933 @r{      v@:      v l   @:             @:     1  @:vlen@:(v)}
35934 @r{      v@:    H v l   @:             @:     1  @:mdims@:(v)}
35935 @r{    v m@:      v m   @:             @:     2  @:vmask@:(v,m)}
35936 @r{      v@:      v n   @:             @:     1  @:rnorm@:(v)}
35937 @r{  a b c@:      v p   @:             @:    24  @:calc-pack@:}
35938 @r{      v@:      v r   @:n >0         @: 21,31  @:mrow@:(v,n)}
35939 @r{      v@:      v r   @:n <0         @:    31  @:mrrow@:(v,-n)}
35940 @r{      m@:      v r   @:0            @:    31  @:getdiag@:(m)}
35941 @r{  v i j@:      v s   @:             @:        @:subvec@:(v,i,j)}
35942 @r{  v i j@:    I v s   @:             @:        @:rsubvec@:(v,i,j)}
35943 @r{      m@:      v t   @:             @:     1  @:trn@:(m)}
35944 @r{      v@:      v u   @:             @:    24  @:calc-unpack@:}
35945 @r{      v@:      v v   @:             @:     1  @:rev@:(v)}
35946 @r{       @:      v x   @:n            @:    31  @:index@:(n)}
35947 @r{  n s i@:  C-u v x   @:             @:        @:index@:(n,s,i)}
35950 @r{      v@:      V A   @:op           @:    22  @:apply@:(op,v)}
35951 @r{  v1 v2@:      V C   @:             @:     2  @:cross@:(v1,v2)}
35952 @r{      m@:      V D   @:             @:     1  @:det@:(m)}
35953 @r{      s@:      V E   @:             @:     1  @:venum@:(s)}
35954 @r{      s@:      V F   @:             @:     1  @:vfloor@:(s)}
35955 @r{      v@:      V G   @:             @:        @:grade@:(v)}
35956 @r{      v@:    I V G   @:             @:        @:rgrade@:(v)}
35957 @r{      v@:      V H   @:n            @:    31  @:histogram@:(v,n)}
35958 @r{    v w@:    H V H   @:n            @:    31  @:histogram@:(v,w,n)}
35959 @r{  v1 v2@:      V I   @:mop aop      @:    22  @:inner@:(mop,aop,v1,v2)}
35960 @r{      m@:      V J   @:             @:     1  @:ctrn@:(m)}
35961 @r{      m@:      V L   @:             @:     1  @:lud@:(m)}
35962 @r{      v@:      V M   @:op           @: 22,23  @:map@:(op,v)}
35963 @r{      v@:      V N   @:             @:     1  @:cnorm@:(v)}
35964 @r{  v1 v2@:      V O   @:op           @:    22  @:outer@:(op,v1,v2)}
35965 @r{      v@:      V R   @:op           @: 22,23  @:reduce@:(op,v)}
35966 @r{      v@:    I V R   @:op           @: 22,23  @:rreduce@:(op,v)}
35967 @r{    a n@:    H V R   @:op           @:    22  @:nest@:(op,a,n)}
35968 @r{      a@:  I H V R   @:op           @:    22  @:fixp@:(op,a)}
35969 @r{      v@:      V S   @:             @:        @:sort@:(v)}
35970 @r{      v@:    I V S   @:             @:        @:rsort@:(v)}
35971 @r{      m@:      V T   @:             @:     1  @:tr@:(m)}
35972 @r{      v@:      V U   @:op           @:    22  @:accum@:(op,v)}
35973 @r{      v@:    I V U   @:op           @:    22  @:raccum@:(op,v)}
35974 @r{    a n@:    H V U   @:op           @:    22  @:anest@:(op,a,n)}
35975 @r{      a@:  I H V U   @:op           @:    22  @:afixp@:(op,a)}
35976 @r{    s t@:      V V   @:             @:     2  @:vunion@:(s,t)}
35977 @r{    s t@:      V X   @:             @:     2  @:vxor@:(s,t)}
35980 @r{       @:      Y     @:             @:        @:@:user commands}
35983 @r{       @:      z     @:             @:        @:@:user commands}
35986 @r{      c@:      Z [   @:             @:    45  @:calc-kbd-if@:}
35987 @r{      c@:      Z |   @:             @:    45  @:calc-kbd-else-if@:}
35988 @r{       @:      Z :   @:             @:        @:calc-kbd-else@:}
35989 @r{       @:      Z ]   @:             @:        @:calc-kbd-end-if@:}
35992 @r{       @:      Z @{   @:             @:     4  @:calc-kbd-loop@:}
35993 @r{      c@:      Z /   @:             @:    45  @:calc-kbd-break@:}
35994 @r{       @:      Z @}   @:             @:        @:calc-kbd-end-loop@:}
35995 @r{      n@:      Z <   @:             @:        @:calc-kbd-repeat@:}
35996 @r{       @:      Z >   @:             @:        @:calc-kbd-end-repeat@:}
35997 @r{    n m@:      Z (   @:             @:        @:calc-kbd-for@:}
35998 @r{      s@:      Z )   @:             @:        @:calc-kbd-end-for@:}
36001 @r{       @:      Z C-g @:             @:        @:@:cancel if/loop command}
36004 @r{       @:      Z `   @:             @:        @:calc-kbd-push@:}
36005 @r{       @:      Z '   @:             @:        @:calc-kbd-pop@:}
36006 @r{       @:      Z #   @:             @:        @:calc-kbd-query@:}
36009 @r{   comp@:      Z C   @:func, args   @:    50  @:calc-user-define-composition@:}
36010 @r{       @:      Z D   @:key, command @:        @:calc-user-define@:}
36011 @r{       @:      Z E   @:key, editing @:    30  @:calc-user-define-edit@:}
36012 @r{   defn@:      Z F   @:k, c, f, a, n@:    28  @:calc-user-define-formula@:}
36013 @r{       @:      Z G   @:key          @:        @:calc-get-user-defn@:}
36014 @r{       @:      Z I   @:             @:        @:calc-user-define-invocation@:}
36015 @r{       @:      Z K   @:key, command @:        @:calc-user-define-kbd-macro@:}
36016 @r{       @:      Z P   @:key          @:        @:calc-user-define-permanent@:}
36017 @r{       @:      Z S   @:             @:    30  @:calc-edit-user-syntax@:}
36018 @r{       @:      Z T   @:             @:    12  @:calc-timing@:}
36019 @r{       @:      Z U   @:key          @:        @:calc-user-undefine@:}
36021 @end format
36023 @noindent
36024 NOTES
36026 @enumerate
36027 @c 1
36028 @item
36029 Positive prefix arguments apply to @expr{n} stack entries.
36030 Negative prefix arguments apply to the @expr{-n}th stack entry.
36031 A prefix of zero applies to the entire stack.  (For @key{LFD} and
36032 @kbd{M-@key{DEL}}, the meaning of the sign is reversed.)
36034 @c 2
36035 @item
36036 Positive prefix arguments apply to @expr{n} stack entries.
36037 Negative prefix arguments apply to the top stack entry
36038 and the next @expr{-n} stack entries.
36040 @c 3
36041 @item
36042 Positive prefix arguments rotate top @expr{n} stack entries by one.
36043 Negative prefix arguments rotate the entire stack by @expr{-n}.
36044 A prefix of zero reverses the entire stack.
36046 @c 4
36047 @item
36048 Prefix argument specifies a repeat count or distance.
36050 @c 5
36051 @item
36052 Positive prefix arguments specify a precision @expr{p}.
36053 Negative prefix arguments reduce the current precision by @expr{-p}.
36055 @c 6
36056 @item
36057 A prefix argument is interpreted as an additional step-size parameter.
36058 A plain @kbd{C-u} prefix means to prompt for the step size.
36060 @c 7
36061 @item
36062 A prefix argument specifies simplification level and depth.
36063 1=Default, 2=like @kbd{a s}, 3=like @kbd{a e}.
36065 @c 8
36066 @item
36067 A negative prefix operates only on the top level of the input formula.
36069 @c 9
36070 @item
36071 Positive prefix arguments specify a word size of @expr{w} bits, unsigned.
36072 Negative prefix arguments specify a word size of @expr{w} bits, signed.
36074 @c 10
36075 @item
36076 Prefix arguments specify the shift amount @expr{n}.  The @expr{w} argument
36077 cannot be specified in the keyboard version of this command.
36079 @c 11
36080 @item
36081 From the keyboard, @expr{d} is omitted and defaults to zero.
36083 @c 12
36084 @item
36085 Mode is toggled; a positive prefix always sets the mode, and a negative
36086 prefix always clears the mode.
36088 @c 13
36089 @item
36090 Some prefix argument values provide special variations of the mode.
36092 @c 14
36093 @item
36094 A prefix argument, if any, is used for @expr{m} instead of taking
36095 @expr{m} from the stack.  @expr{M} may take any of these values:
36096 @iftex
36097 {@advance@tableindent10pt
36098 @end iftex
36099 @table @asis
36100 @item Integer
36101 Random integer in the interval @expr{[0 .. m)}.
36102 @item Float
36103 Random floating-point number in the interval @expr{[0 .. m)}.
36104 @item 0.0
36105 Gaussian with mean 1 and standard deviation 0.
36106 @item Error form
36107 Gaussian with specified mean and standard deviation.
36108 @item Interval
36109 Random integer or floating-point number in that interval.
36110 @item Vector
36111 Random element from the vector.
36112 @end table
36113 @iftex
36115 @end iftex
36117 @c 15
36118 @item
36119 A prefix argument from 1 to 6 specifies number of date components
36120 to remove from the stack.  @xref{Date Conversions}.
36122 @c 16
36123 @item
36124 A prefix argument specifies a time zone; @kbd{C-u} says to take the
36125 time zone number or name from the top of the stack.  @xref{Time Zones}.
36127 @c 17
36128 @item
36129 A prefix argument specifies a day number (0-6, 0-31, or 0-366).
36131 @c 18
36132 @item
36133 If the input has no units, you will be prompted for both the old and
36134 the new units.
36136 @c 19
36137 @item
36138 With a prefix argument, collect that many stack entries to form the
36139 input data set.  Each entry may be a single value or a vector of values.
36141 @c 20
36142 @item
36143 With a prefix argument of 1, take a single 
36144 @texline @var{n}@math{\times2}
36145 @infoline @mathit{@var{N}x2} 
36146 matrix from the stack instead of two separate data vectors.
36148 @c 21
36149 @item
36150 The row or column number @expr{n} may be given as a numeric prefix
36151 argument instead.  A plain @kbd{C-u} prefix says to take @expr{n}
36152 from the top of the stack.  If @expr{n} is a vector or interval,
36153 a subvector/submatrix of the input is created.
36155 @c 22
36156 @item
36157 The @expr{op} prompt can be answered with the key sequence for the
36158 desired function, or with @kbd{x} or @kbd{z} followed by a function name,
36159 or with @kbd{$} to take a formula from the top of the stack, or with
36160 @kbd{'} and a typed formula.  In the last two cases, the formula may
36161 be a nameless function like @samp{<#1+#2>} or @samp{<x, y : x+y>}, or it
36162 may include @kbd{$}, @kbd{$$}, etc. (where @kbd{$} will correspond to the
36163 last argument of the created function), or otherwise you will be
36164 prompted for an argument list.  The number of vectors popped from the
36165 stack by @kbd{V M} depends on the number of arguments of the function.
36167 @c 23
36168 @item
36169 One of the mapping direction keys @kbd{_} (horizontal, i.e., map
36170 by rows or reduce across), @kbd{:} (vertical, i.e., map by columns or
36171 reduce down), or @kbd{=} (map or reduce by rows) may be used before
36172 entering @expr{op}; these modify the function name by adding the letter
36173 @code{r} for ``rows,'' @code{c} for ``columns,'' @code{a} for ``across,''
36174 or @code{d} for ``down.''
36176 @c 24
36177 @item
36178 The prefix argument specifies a packing mode.  A nonnegative mode
36179 is the number of items (for @kbd{v p}) or the number of levels
36180 (for @kbd{v u}).  A negative mode is as described below.  With no
36181 prefix argument, the mode is taken from the top of the stack and
36182 may be an integer or a vector of integers.
36183 @iftex
36184 {@advance@tableindent-20pt
36185 @end iftex
36186 @table @cite
36187 @item -1
36188 (@var{2})  Rectangular complex number.
36189 @item -2
36190 (@var{2})  Polar complex number.
36191 @item -3
36192 (@var{3})  HMS form.
36193 @item -4
36194 (@var{2})  Error form.
36195 @item -5
36196 (@var{2})  Modulo form.
36197 @item -6
36198 (@var{2})  Closed interval.
36199 @item -7
36200 (@var{2})  Closed .. open interval.
36201 @item -8
36202 (@var{2})  Open .. closed interval.
36203 @item -9
36204 (@var{2})  Open interval.
36205 @item -10
36206 (@var{2})  Fraction.
36207 @item -11
36208 (@var{2})  Float with integer mantissa.
36209 @item -12
36210 (@var{2})  Float with mantissa in @expr{[1 .. 10)}.
36211 @item -13
36212 (@var{1})  Date form (using date numbers).
36213 @item -14
36214 (@var{3})  Date form (using year, month, day).
36215 @item -15
36216 (@var{6})  Date form (using year, month, day, hour, minute, second).
36217 @end table
36218 @iftex
36220 @end iftex
36222 @c 25
36223 @item
36224 A prefix argument specifies the size @expr{n} of the matrix.  With no
36225 prefix argument, @expr{n} is omitted and the size is inferred from
36226 the input vector.
36228 @c 26
36229 @item
36230 The prefix argument specifies the starting position @expr{n} (default 1).
36232 @c 27
36233 @item
36234 Cursor position within stack buffer affects this command.
36236 @c 28
36237 @item
36238 Arguments are not actually removed from the stack by this command.
36240 @c 29
36241 @item
36242 Variable name may be a single digit or a full name.
36244 @c 30
36245 @item
36246 Editing occurs in a separate buffer.  Press @kbd{C-c C-c} (or 
36247 @key{LFD}, or in some cases @key{RET}) to finish the edit, or kill the
36248 buffer with @kbd{C-x k} to cancel the edit.  The @key{LFD} key prevents evaluation
36249 of the result of the edit.
36251 @c 31
36252 @item
36253 The number prompted for can also be provided as a prefix argument.
36255 @c 32
36256 @item
36257 Press this key a second time to cancel the prefix.
36259 @c 33
36260 @item
36261 With a negative prefix, deactivate all formulas.  With a positive
36262 prefix, deactivate and then reactivate from scratch.
36264 @c 34
36265 @item
36266 Default is to scan for nearest formula delimiter symbols.  With a
36267 prefix of zero, formula is delimited by mark and point.  With a
36268 non-zero prefix, formula is delimited by scanning forward or
36269 backward by that many lines.
36271 @c 35
36272 @item
36273 Parse the region between point and mark as a vector.  A nonzero prefix
36274 parses @var{n} lines before or after point as a vector.  A zero prefix
36275 parses the current line as a vector.  A @kbd{C-u} prefix parses the
36276 region between point and mark as a single formula.
36278 @c 36
36279 @item
36280 Parse the rectangle defined by point and mark as a matrix.  A positive
36281 prefix @var{n} divides the rectangle into columns of width @var{n}.
36282 A zero or @kbd{C-u} prefix parses each line as one formula.  A negative
36283 prefix suppresses special treatment of bracketed portions of a line.
36285 @c 37
36286 @item
36287 A numeric prefix causes the current language mode to be ignored.
36289 @c 38
36290 @item
36291 Responding to a prompt with a blank line answers that and all
36292 later prompts by popping additional stack entries.
36294 @c 39
36295 @item
36296 Answer for @expr{v} may also be of the form @expr{v = v_0} or
36297 @expr{v - v_0}.
36299 @c 40
36300 @item
36301 With a positive prefix argument, stack contains many @expr{y}'s and one
36302 common @expr{x}.  With a zero prefix, stack contains a vector of
36303 @expr{y}s and a common @expr{x}.  With a negative prefix, stack
36304 contains many @expr{[x,y]} vectors.  (For 3D plots, substitute
36305 @expr{z} for @expr{y} and @expr{x,y} for @expr{x}.)
36307 @c 41
36308 @item
36309 With any prefix argument, all curves in the graph are deleted.
36311 @c 42
36312 @item
36313 With a positive prefix, refines an existing plot with more data points.
36314 With a negative prefix, forces recomputation of the plot data.
36316 @c 43
36317 @item
36318 With any prefix argument, set the default value instead of the
36319 value for this graph.
36321 @c 44
36322 @item
36323 With a negative prefix argument, set the value for the printer.
36325 @c 45
36326 @item
36327 Condition is considered ``true'' if it is a nonzero real or complex
36328 number, or a formula whose value is known to be nonzero; it is ``false''
36329 otherwise.
36331 @c 46
36332 @item
36333 Several formulas separated by commas are pushed as multiple stack
36334 entries.  Trailing @kbd{)}, @kbd{]}, @kbd{@}}, @kbd{>}, and @kbd{"}
36335 delimiters may be omitted.  The notation @kbd{$$$} refers to the value
36336 in stack level three, and causes the formula to replace the top three
36337 stack levels.  The notation @kbd{$3} refers to stack level three without
36338 causing that value to be removed from the stack.  Use @key{LFD} in place
36339 of @key{RET} to prevent evaluation; use @kbd{M-=} in place of @key{RET}
36340 to evaluate variables.
36342 @c 47
36343 @item
36344 The variable is replaced by the formula shown on the right.  The
36345 Inverse flag reverses the order of the operands, e.g., @kbd{I s - x}
36346 assigns 
36347 @texline @math{x \coloneq a-x}.
36348 @infoline @expr{x := a-x}.
36350 @c 48
36351 @item
36352 Press @kbd{?} repeatedly to see how to choose a model.  Answer the
36353 variables prompt with @expr{iv} or @expr{iv;pv} to specify
36354 independent and parameter variables.  A positive prefix argument
36355 takes @mathit{@var{n}+1} vectors from the stack; a zero prefix takes a matrix
36356 and a vector from the stack.
36358 @c 49
36359 @item
36360 With a plain @kbd{C-u} prefix, replace the current region of the
36361 destination buffer with the yanked text instead of inserting.
36363 @c 50
36364 @item
36365 All stack entries are reformatted; the @kbd{H} prefix inhibits this.
36366 The @kbd{I} prefix sets the mode temporarily, redraws the top stack
36367 entry, then restores the original setting of the mode.
36369 @c 51
36370 @item
36371 A negative prefix sets the default 3D resolution instead of the
36372 default 2D resolution.
36374 @c 52
36375 @item
36376 This grabs a vector of the form [@var{prec}, @var{wsize}, @var{ssize},
36377 @var{radix}, @var{flfmt}, @var{ang}, @var{frac}, @var{symb}, @var{polar},
36378 @var{matrix}, @var{simp}, @var{inf}].  A prefix argument from 1 to 12
36379 grabs the @var{n}th mode value only.
36380 @end enumerate
36382 @iftex
36383 (Space is provided below for you to keep your own written notes.)
36384 @page
36385 @endgroup
36386 @end iftex
36389 @c [end-summary]
36391 @node Key Index, Command Index, Summary, Top
36392 @unnumbered Index of Key Sequences
36394 @printindex ky
36396 @node Command Index, Function Index, Key Index, Top
36397 @unnumbered Index of Calculator Commands
36399 Since all Calculator commands begin with the prefix @samp{calc-}, the
36400 @kbd{x} key has been provided as a variant of @kbd{M-x} which automatically
36401 types @samp{calc-} for you.  Thus, @kbd{x last-args} is short for
36402 @kbd{M-x calc-last-args}.
36404 @printindex pg
36406 @node Function Index, Concept Index, Command Index, Top
36407 @unnumbered Index of Algebraic Functions
36409 This is a list of built-in functions and operators usable in algebraic
36410 expressions.  Their full Lisp names are derived by adding the prefix
36411 @samp{calcFunc-}, as in @code{calcFunc-sqrt}.
36412 @iftex
36413 All functions except those noted with ``*'' have corresponding
36414 Calc keystrokes and can also be found in the Calc Summary.
36415 @end iftex
36417 @printindex tp
36419 @node Concept Index, Variable Index, Function Index, Top
36420 @unnumbered Concept Index
36422 @printindex cp
36424 @node Variable Index, Lisp Function Index, Concept Index, Top
36425 @unnumbered Index of Variables
36427 The variables in this list that do not contain dashes are accessible
36428 as Calc variables.  Add a @samp{var-} prefix to get the name of the
36429 corresponding Lisp variable.
36431 The remaining variables are Lisp variables suitable for @code{setq}ing
36432 in your Calc init file or @file{.emacs} file.
36434 @printindex vr
36436 @node Lisp Function Index, , Variable Index, Top
36437 @unnumbered Index of Lisp Math Functions
36439 The following functions are meant to be used with @code{defmath}, not
36440 @code{defun} definitions.  For names that do not start with @samp{calc-},
36441 the corresponding full Lisp name is derived by adding a prefix of
36442 @samp{math-}.
36444 @printindex fn
36446 @summarycontents
36448 @c [end]
36450 @contents
36451 @bye
36454 @ignore
36455    arch-tag: 77a71809-fa4d-40be-b2cc-da3e8fb137c0
36456 @end ignore