From e0c6872cf40896c7be36b11dcc744620f10adf1d Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Mon, 2 Sep 2019 13:46:59 +0900 Subject: Initial commit --- macros/latex/contrib/program/README | 27 + macros/latex/contrib/program/gpl-3.0.txt | 674 +++++++++++++++++ macros/latex/contrib/program/plink.tex | 58 ++ macros/latex/contrib/program/program-demo.tex | 325 ++++++++ macros/latex/contrib/program/program-doc.pdf | Bin 0 -> 43768 bytes macros/latex/contrib/program/program-doc.tex | 76 ++ macros/latex/contrib/program/program.sty | 1010 +++++++++++++++++++++++++ 7 files changed, 2170 insertions(+) create mode 100644 macros/latex/contrib/program/README create mode 100644 macros/latex/contrib/program/gpl-3.0.txt create mode 100644 macros/latex/contrib/program/plink.tex create mode 100644 macros/latex/contrib/program/program-demo.tex create mode 100644 macros/latex/contrib/program/program-doc.pdf create mode 100644 macros/latex/contrib/program/program-doc.tex create mode 100644 macros/latex/contrib/program/program.sty (limited to 'macros/latex/contrib/program') diff --git a/macros/latex/contrib/program/README b/macros/latex/contrib/program/README new file mode 100644 index 0000000000..3a231c3a27 --- /dev/null +++ b/macros/latex/contrib/program/README @@ -0,0 +1,27 @@ + +Here's a copy of my LaTeX2e style file for typesetting programs +and algorithms in my favourite style without having to type +in endless tabbing commands. Each line is set in math mode +so all the indentation and spacing is done automatically. +The notation |variable_name| can be used within normal text, +maths expressions or programs to indicate a variable name. +Use \origbar to get a normal | symbol in a program. +The commands \A, \B, \R, \T and \Z typeset the corresponding bold +letter with the next object as a substript (eg \S1 typesets {\bf +S$_1$} etc). They now cope with primes as well, (eg $\S2'''$). The +program.sty file can be easily edited to reflect your favoured style. +Typesetting a program is as easy as: + +\(\IF x \ne 0 \THEN |long_name|_{123} = x^y \FI\) + +See the program-demo.tex file for examples. + +The file should work with or without AMSLaTeX. + +This work is released under the GPL version 3. + + Martin Ward. + +martin@gkc.org.uk http://www.cse.dmu.ac.uk/~mward/ Erdos number: 4 +G.K.Chesterton web site: http://www.cse.dmu.ac.uk/~mward/gkc/ + diff --git a/macros/latex/contrib/program/gpl-3.0.txt b/macros/latex/contrib/program/gpl-3.0.txt new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/macros/latex/contrib/program/gpl-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/macros/latex/contrib/program/plink.tex b/macros/latex/contrib/program/plink.tex new file mode 100644 index 0000000000..1144493ff3 --- /dev/null +++ b/macros/latex/contrib/program/plink.tex @@ -0,0 +1,58 @@ +\documentclass{article} + +\usepackage{program} + +\catcode`\!=\active % Make ! active +\let!=| % Set it to be the same as | +\let|=\origbar % Restore | to the old value +\catcode`\!=12 % These two lines make ! active +\mathcode`\!="8000 % only in maths mode. + +\makeatletter +\def\@svariable{% + \catcode`\!\active + \lccode`\~`\!% + \lowercase{\def~{\endgroup% if we were not in mmode, do italic corr: + \ifwasinmmode\let\next=\/% was \relax + \else\let\next=\variablefontend\fi + \next + \egroup}% + \let\@dovar~}% + \leavevmode\null} +\makeatother + +\begin{document} + +This document illustrates how to use the exclamation mark (!), or any other character, instead of vertical bar +as the variable name delimiter. This may useful of you are typesetting programs which use a lot of vertical bars. + +\[ \left|\frac{\partial \varphi (X)}{\partial g}\right| + = \max_{i\in R(X)} \nabla f_i(X) g^T +\] + +Testing! + +\[ !foo_bar! = x + y \] + +\[ !foo!_{!bar!} = x + y \] + +Note that the $!bar!$ subscript is not at a smaller size. If you want a small +subscript, write: + +\[ !foo!_{\scriptvar!bar!} = x + y \] + +\begin{program} +!choose ! choose X_0 ; +X := X_0 ; +\DO \textnormal{determine } |R(X)| + \textnormal{determine } |G(X)| + \textnormal{determine } |!foo_bar!(X)| + \textnormal{determine } |Z*| + \IF |Z*|=0 \THEN \EXIT \FI + \textnormal{determine direction of steepest descent } g=-|Z*|/{\parallel |Z*|\parallel} + \textnormal{determine }\alpha>0,\textnormal{ for which }\varphi(X+\alpha g)\textnormal{ is minimum} + X := X + \alpha g +\OD +\end{program} + +\end{document} diff --git a/macros/latex/contrib/program/program-demo.tex b/macros/latex/contrib/program/program-demo.tex new file mode 100644 index 0000000000..af7c3bcbe8 --- /dev/null +++ b/macros/latex/contrib/program/program-demo.tex @@ -0,0 +1,325 @@ +\documentclass{article} +\usepackage{amsmath} +\usepackage{amssymb} +\usepackage{newlfont} +\usepackage{program} +\setlength{\parskip}{1ex} + +% Number algorithms separately: +%\newtheorem{algorithm}{Algorithm} + +% Number algorithms within sections: +\newtheorem{algorithm}{Algorithm}[section] + +% For "floating" algorithms, use: +% \begin{figure} +% \begin{program} +% ... +% \end{program} +% \end{figure} + +% To use |foo_bar| in headings, set _ to be active. +% Not done by default as this clashes with \includegraphics +% if filenames have _ characters in them: + +\catcode`\_\active + +\begin{document} +\title{A demonstration of the {\tt program} environment} +\author{Martin Ward\\ +\tt{martin@gkc.org.uk}} +\maketitle + +\tableofcontents + +\section{Example with |first_set| and $|first_set|$.} + + +The {\tt program} style defines two environments, {\tt program} and {\tt +programbox} for typesetting programs and algorithms. Within the program +environment: +\begin{enumerate} + \item Newlines are significant; + \item Each line is in math mode, so for example spaces in the input +file are not significant; + \item The command \verb:\\: within a line causes an extra +linebreak in the output; + \item The indentation of each line is calculated automatically; + \item To cause extra indentation, use the commands \verb:\tab: to +set a new tab, and \verb:\untab: to remove it (see the examples below); + \item Vertical bars are used to delimit long variable names with +underscores (and other unusual characters). +\end{enumerate} + +\verb:testing | in verbatim: + +\begin{verbatim} +testing | and @ in verbatim +\end{verbatim} + + +Here is a small program: +\( |first_set|:= \set{x | x^2 + y_1 > 0 } \) +It shows how to typeset mathematics as part of a program. Since each line is +typeset in maths mode, all spacing is done automatically. The set brackets +expand automatically, for example in this program (which also demonstrates the +\verb:\tab: and \verb:\untab: commands): +\begin{program} +t := \set{x | \displaystyle\frac{x}{y} = z}; +t := t \setminus u; +z := a \tab {} + b + c + d + {} + e + f + g + {} + h + i + j; \untab +\IF x = 0 \THEN y :=0 \FI +\end{program} + +You can use |variable_names| in text or math mode: $|variable_name|^2 = 2$. +Names can have |odd_characters:!@#$%^&*:;_like_this!|. + +Note that \verb:\(: and \verb:\): are redefined to typeset a program in +a minipage. (This is useful in running text, or to keep a short program all on +one page). There is some notation for sequences: \( \seq{x_1,x_2,\dots,x_n} \) +and for universal and existential quantifiers: $ \Forall x. \Exists y. y>x $ +(yes, I use these in my programs!) + +I often use bold letters to represent program fragments, formulas etc. so +I have set up commands \S{}, \R{} etc. for the most common ones. The +commands have one argument (a subscript, eg \S1, \S2, \S{23}) or a +sequence of ``prime'' characters: \S', \S''''' etc. If you want both a +subscript and one or more primes, then you must use maths mode, eg $\S2'$ +Consider the difference between typing \verb:``\S2'': which gives ``\S2'' and +\verb:``$\S2''$'': which gives ``$\S2''$''. Outside maths mode, \verb:\S: +assumes any primes after a subscript are either closing quotes or apostrophes. + +Here are two program examples with different indentation styles. Note that +all indentation is calculated automatically in either style: + +\noindent +% programbox keeps the program on one page - like parbox +\begin{programbox} +\IF \T1 + \THEN \IF \T2 + \THEN \IF \T3 + \THEN \S4 + \ELSE \S3 + \FI + \ELSE \S2 + \FI + \ELSE \S1 +\FI; +% Blank lines are ignored, so you need a ~ on the line +% to get a blank line in the output: +~ +\IF \T1 \THEN \IF \T2 \THEN \IF \T3 \THEN \S4 + \ELSE \S3 \FI + \ELSE \S2 \FI + \ELSE \S1 \FI; +\end{programbox} + +Note that \keyword{then} and \keyword{else} should be at the {\em start} of +a line (as in the examples above), not at the end. This is so that you can +line them up in short \keyword{if} statements, for example: +\begin{program} +\IF x=1 \THEN |a_long_procedure_name|(|arg1|, |arg2|, \dots) + \ELSE |another_long_procedure_name|(|arg1|, |arg2|, \dots) \FI +\end{program} +If the test is long, then you probably want an extra linebreak: +\begin{program} +\IF |a_long_boolean_function_name?|(|arg1|, |arg2|, \dots) + \THEN |a_long_procedure_name|(|arg1|, |arg2|, \dots) + \ELSE |another_long_procedure_name|(|arg1|, |arg2|, \dots) \FI +\end{program} +Compare this with the following (which has linebreaks in the ``wrong'' places): +\begin{program} +\IF |a_long_boolean_function_name?|(|arg1|, |arg2|, \dots) \THEN + |a_long_procedure_name|(|arg1|, |arg2|, \dots) + \ELSE + |another_long_procedure_name|(|arg1|, |arg2|, \dots) \FI +\end{program} + + + +Just to show that {\tt\origbar} still works normally to indicate the +placing of vertical lines) in the preamble of a tabular +(or array) environment: + +\begin{tabular}{|r|l|} \hline +\bf Statement & \bf Conditions \\ +\hline +\S1 & \B1 \\ +\S2 & \B2 \\ +\hline +\end{tabular} + +\section{Procedures and Functions} + +Turning on line numbering here. Also using the algoritm enviroment to number +the algorithms within the sections. +\NumberProgramstrue +\begin{algorithm} +\begin{program} +\label{one}% +\mbox{A fast exponentiation function:} \\ % You can use \mbox for comments +\BEGIN % + \FOR i:=1 \TO 10 \STEP 1 \DO + |print|(|expt|(2,i)); \\ |newline|() \OD +\WHERE +\FUNCT |expt|(x,n) \BODY + \EXP z:=1; + \WHILE n \neq 0 \DO + \WHILE |even|(n) \DO + n:=n/2; x:=x*x \OD; \label{foo} + n:=n-1; z:=z*x \OD; + z \ENDEXP \ENDFUNCT +\END\label{last} +\end{program} +\end{algorithm} +First line is line~\ref{one}, last is line~\ref{last}. +Line~\ref{foo} is what makes this function fast! + +\begin{algorithm} +\begin{program} +\mbox{A fast exponentiation procedure:} +\BEGIN % + \FOR i:=1 \TO 10 \STEP 1 \DO + |expt|(2,i); \\ |newline|() \OD % +\rcomment{This text will be set flush to the right margin} +\WHERE +\PROC |expt|(x,n) \BODY + z:=1; + \DO \IF n=0 \THEN \EXIT \FI; + \DO \IF |odd|(n) \THEN \EXIT \FI; +\COMMENT{This is a comment statement}; + n:=n/2; x:=x*x \OD; + \{ n>0 \}; + n:=n-1; z:=z*x \OD; + |print|(z) \ENDPROC +\END +\end{program} +\end{algorithm} + +\noindent An action system equivalent to a \keyword{while} loop: +\[ +\( \ACTIONS A: + A \EQ \IF \B{} \THEN \S{}; \CALL A + \ELSE \CALL Z \FI \QE + \ENDACTIONS \) +\EQT +\( \WHILE \B{} \DO \S{} \OD \) +\] +Note the use of \verb:\(: and \verb:\): to enclose the two program boxes. +Turning off line numbers here. +\NumberProgramsfalse + +\noindent Dijkstra conditionals and loops: +\begin{program} +\IF x = 1 \AR y:=y+1 +\BAR x = 2 \AR y:=y^2 +\utdots +\BAR x = n \AR y:=\displaystyle\sum_{i=1}^n y_i \FI + +\DO 2 \origbar x \AND x>0 \AR x:= x/2 +\BAR \NOT 2 \origbar x \AR x:= \modbar{x+3} \OD +\end{program} + +\noindent Loops with multiple \keyword{exit}s: +\begin{program} +\DO \DO \IF \B1 \THEN \EXIT \FI; + \S1; + \IF \B2 \THEN \EXIT(2) \FI \OD; + \IF \B1 \THEN \EXIT \FI \OD +\end{program} + +\noindent I hope you get the idea! + +\section{A Reverse Engineering Example} + +Here's the original program: +\begin{algorithm} +\begin{program} + \VAR \seq{m := 0, p := 0, |last| := `` ''}; + \ACTIONS |prog|: +|prog| \ACTIONEQ % + \seq{|line| := `` '', m := 0, i := 1}; + \CALL |inhere| \ENDACTION +l \ACTIONEQ % + i := i+1; + \IF (i=(n+1)) \THEN \CALL |alldone| \FI ; + m := 1; + \IF |item|[i] \neq |last| + \THEN |write|(|line|); |line| := `` ''; m := 0; + \CALL |inhere| \FI ; + \CALL |more| \ENDACTION +|inhere| \ACTIONEQ % + p := |number|[i]; |line| := |item|[i]; + |line| := |line| \concat `` '' \concat p; + \CALL |more| \ENDACTION +|more| \ACTIONEQ % + \IF (m=1) \THEN p := |number|[i]; + |line| := |line| \concat ``, '' \concat p \FI ; + |last| := |item|[i]; + \CALL l \ENDACTION +|alldone| \ACTIONEQ |write|(|line|); \CALL Z \ENDACTION \ENDACTIONS \END +\end{program} +\end{algorithm} + +And here's the transformed and corrected version: +\begin{algorithm} +\begin{program} +\seq{|line| := `` '', i := 1}; +\WHILE i \neq n+1 \DO + |line| := |item|[i] \concat `` '' \concat |number|[i]; + i := i+1; + \WHILE i \neq n+1 \AND |item|[i] = |item|[i-1] \DO + |line| := |line| \concat ``, '' \concat |number|[i]); + i := i+1 \OD ; + |write|(|line|) \OD +\end{program} +\end{algorithm} + +Below are the same programs in a bold serif style with underlined keywords, using the command +\verb:\bfvariables:: +\bfvariables +\begin{program} + \VAR \seq{m := 0, p := 0, |last| := `` ''}; + \ACTIONS |prog|: +|prog| \ACTIONEQ % + \seq{|line| := `` '', m := 0, i := 1}; + \CALL |inhere| \ENDACTION +l \ACTIONEQ % + i := i+1; + \IF (i=(n+1)) \THEN \CALL |alldone| \FI ; + m := 1; + \IF |item|[i] \neq |last| + \THEN |write|(|line|); |line| := `` ''; m := 0; + \CALL |inhere| \FI ; + \CALL |more| \ENDACTION +|inhere| \ACTIONEQ % + p := |number|[i]; |line| := |item|[i]; + |line| := |line| \concat `` '' \concat p; + \CALL |more| \ENDACTION +|more| \ACTIONEQ % + \IF (m=1) \THEN p := |number|[i]; + |line| := |line| \concat ``, '' \concat p \FI ; + |last| := |item|[i]; + \CALL l \ENDACTION +|alldone| \ACTIONEQ |write|(|line|); \CALL Z \ENDACTION \ENDACTIONS \END +\end{program} + +\begin{program} +\seq{|line|:=`` '', i:=1}; +\WHILE i \neq n+1 \DO + |line| := |item|[i] \concat `` '' \concat |number|[i]; + i := i+1; + \WHILE i \neq n+1 \AND |item|[i] = |item|[i-1] \DO + |line| := |line| \concat ``, '' \concat |number|[i]); + i := i+1 \OD ; + |write|(|line|) \OD +\end{program} + +In my opinion, the \verb:\sfvariables: style looks much better. +The \verb:\bfvariables: style was the default, but this was changed with version 3.3.11. + + +\end{document} + diff --git a/macros/latex/contrib/program/program-doc.pdf b/macros/latex/contrib/program/program-doc.pdf new file mode 100644 index 0000000000..939c8285db Binary files /dev/null and b/macros/latex/contrib/program/program-doc.pdf differ diff --git a/macros/latex/contrib/program/program-doc.tex b/macros/latex/contrib/program/program-doc.tex new file mode 100644 index 0000000000..a761b39825 --- /dev/null +++ b/macros/latex/contrib/program/program-doc.tex @@ -0,0 +1,76 @@ +\documentclass[pagesize=auto]{scrartcl} + +\usepackage{fixltx2e} +\usepackage{etex} +\usepackage{lmodern} +\usepackage[T1]{fontenc} +\usepackage{textcomp} +\usepackage{upquote} +\usepackage{hologo} +\usepackage{microtype} +\usepackage{hyperref} + +\newcommand*{\mail}[1]{\href{mailto:#1}{\texttt{#1}}} +\newcommand*{\pkg}[1]{\textsf{#1}} +\newcommand*{\cs}[1]{\texttt{\textbackslash#1}} +\makeatletter +\newcommand*{\cmd}[1]{\cs{\expandafter\@gobble\string#1}} +\makeatother +\newcommand*{\env}[1]{\texttt{#1}} + +\addtokomafont{title}{\rmfamily} +\deffootnote{1em}{1em}{\textsuperscript{\thefootnotemark}} +\renewcommand*{\labelenumi}{(\theenumi)} + +\title{The \pkg{program} package\thanks{This manual corresponds to \pkg{program.sty}~v3.3.14, dated~May 5, 2017.}} +\author{Martin Ward\thanks{\mail{martin@gkc.org.uk}, \mail{Martin.Ward@smltd.com}\newline\url{http://www.gkc.org.uk/}}} +\date{May 5, 2017} + + +\begin{document} + +\maketitle + +\noindent +This is the ``\pkg{program}'' style option which sets up the +\env{program} and \env{programbox} environments, +keywords for programs and a few goodies. +\emph{Note:} Within the program environment: +% +\begin{enumerate} +\item Newlines are significant. +\item Each line is in math mode, so for example spaces in the input + file are not significant. +\item \cmd{\\} within a line causes a linebreak in the output. +\end{enumerate} + +We also define a ``\env{programbox}'' environment which typesets a program in a box. +Useful for keeping a pice of code on one page or for typesetting small +programs in running text. +We also redefine \cmd{\(} and \cmd{\)} as \verb+\begin{programbox}+ and \verb+\end{programbox}+. +The \cmd{\tab} and \cmd{\untab} commands are defined to have no effect while outside +a \env{program} environment, hence a single-line program can be typeset in +maths mode without the overhead associated with \env{programbox}. + +The notation \verb+|variable_name|+ can be used within normal text, +maths expressions or programs to indicate a variable name. +Use \cmd{\origbar} to get a normal \verb+|+ symbol in a program. +The commands \cmd{\A}, \cmd{\B}, \cmd{\R}, \cmd{\T} and \cmd{\Z} typeset the corresponding bold +letter with the next object as a substript (eg \verb+\S1+ typesets {\bf +S$_1$} etc). They now cope with primes as well, (eg \verb+$\S2'''$+)\@. The +\env{program.sty} file can be easily edited to reflect your favoured style. +Typesetting a program is as easy as: +% +\begin{verbatim} +\(\IF x \ne 0 \THEN |long_name|_{123} = x^y \FI\) +\end{verbatim} +% +See the \texttt{program-demo.tex} file for examples. + +\bigskip\noindent +The file should work with or without \hologo{AmSLaTeX}. + +\bigskip\noindent +This work is released under the GPL version 3. + +\end{document} diff --git a/macros/latex/contrib/program/program.sty b/macros/latex/contrib/program/program.sty new file mode 100644 index 0000000000..829141ceaa --- /dev/null +++ b/macros/latex/contrib/program/program.sty @@ -0,0 +1,1010 @@ +% program.sty, Version 3.3.14 +% Version History: +% 3.3.1: Fix name clash with new AmsTeX (\@prime) +% 3.3.2: Minor spacing tweaks. Added \sfvariables for a different style. +% 3.3.3: Added \| to the definition of \dospecials, so that | will +% still work in a verbatim environment. +% 3.3.4: Added \ifVBarOutsideProgram switch -- The command \normalbaroutside +% makes | to act normally outside the program environment +% 3.3.5: Bugfix (\lt was defined as > in maths mode!) +% 3.3.6: Minor bugfix: added \do\@ to \dospecials (for AmsTeX) +% 3.3.7: Restore catcode of _ (due to clash with \includegraphics) +% 3.3.8: Save/restore \@currentlabel when \ifNumberPrograms is true +% 3.3.9: Added \bigcaps command (submitted by Matteo Corti ) +% 3.3.10: Changed \www command to use normal text rather than typewriter +% Changed \FOREACH \ATEACH to use \@typename +% Added \boldsubm (uses \boldsymbol instead of text \bf) +% 3.3.11: Changed the default style to \sfvariables, old style is \bfvariables +% 3.3.12: Fixed the interaction with \index and \makeindex (which uses |) +% 3.3.13: Updated web site +% 3.3.14: Changed \chardef to \mathchardef to allow more dimen registers +% +% +% A LaTeX2e style file for typesetting algorithms. +% Copyright 1991, 2007 Martin Ward +% martin@gkc.org.uk, Martin.Ward@smltd.com +% http://www.gkc.org.uk/ +% +% This program is free software; you can redistribute it and/or modify +% it under the terms of the GNU General Public License as published by +% the Free Software Foundation; either version 3 of the License, or +% (at your option) any later version. +% +% This program is distributed in the hope that it will be useful, +% but WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +% GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License +% along with this program; if not, see . +% +% +% This is the "program" style option which sets up the +% program and programbox environments, +% keywords for programs and a few goodies. +% NOTE: Within the program environment: +% (1) Newlines are significant. +% (2) Each line is in math mode, so for example spaces in the input +% file are not significant. +% (3) \\ within a line causes a linebreak in the output. +% +% We also define a "programbox" environment which typesets a program in a box. +% Useful for keeping a pice of code on one page or for typesetting small +% programs in running text. +% We also redefine \( and \) as \begin{programbox} and \end{programbox}. +% The \tab and \untab commands are defined to have no effect while outside +% a program environment, hence a single-line program can be typeset in +% maths mode without the overhead associated with programbox. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% Section (1). The Keywords. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +% Set up ";" to add a thick maths space after it when active in math mode: +\let\@semicolon=; +\catcode`\;=12\relax +\mathcode`\;="8000 % Makes ; active in math mode +{\catcode`\;=\active \gdef;{\ifmmode\semicolon\;\else\@semicolon\fi}} +\mathchardef\semicolon="603B + +% Set up ` so that ``...'' typesets the string in tt (in math mode): +\mathcode`\`="8000 % Makes ` active in math mode only. +{%\catcode`\'=\active + \catcode`\`=\active + \gdef`{\startstring@} +} +\newif\ifMathsModeStrings \MathsModeStringsfalse +\def\startstring@`#1''{\ifMathsModeStrings + \mbox{``}#1\mbox{''}\else + \mbox{``{\tt #1}''}\fi} + +% Set up a larger array of tabs since programs set lots of tabs. +% This section can be extended if more tabs are needed: +\newdimen\@gtempa +\mathchardef\@firsttab=\the\allocationnumber +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa\newdimen\@gtempa +\newdimen\@gtempa +\mathchardef\@maxtab=\the\allocationnumber + +% NB: can't use \pushtabns and \poptabs to reduce the need for tabs +% since \@curtab, \@curtabmar and \@nxttabmar are global variables +% which would also need to be saved and restored. + +% The program environment. +% This is based on the tabbing environment with each line put in math mode, +% \obeylines in force and ";" as an active character. +\def\@programcr{$\@stopline\@startline\ignorespaces$} +\def\programnewpage{$\@stopline\newpage\@startline\ignorespaces$} + +% Line numbers on programs: +\newcounter{programline} +\newif\ifNumberPrograms +% Default is no line numbers: +\NumberProgramsfalse + +% Program text size hook: +\let\programsize=\relax + +% Set switch to false if you want | to act normally +% outside the program environment: +\newif\ifVBarOutsideProgram \VBarOutsideProgramtrue +\def\normalbaroutside{\catcode`\|=12 \VBarOutsideProgramfalse} + +\def\program{% + \ifNumberPrograms\setcounter{programline}{0}\let\@savecurrentlabel\@currentlabel\fi + \ifVBarOutsideProgram\else\catcode`\|=\active\fi %% added line + \if@minipage\else\leavevmode\fi + \normalshape + \obeycr %% added line + % activate tabbing commands: + \@tabcommandson %% added line + \global\let\DO=\@oldDO %% added line + \lineskip \z@\let\>\@rtab\let\<\@ltab\let\=\@settab + \let\+\@tabplus\let\-\@tabminus\let\`\@tabrj\let\'\@tablab + \let\\=\@programcr %% changed from \let\\=\tabcr + \global\@hightab\@firsttab + \global\@nxttabmar\@firsttab + \dimen\@firsttab\@totalleftmargin + \global\@tabpush0 \global\@rjfieldfalse + \trivlist \item[]%\if@minipage\else\vskip\parskip\fi + \programsize + \setbox\@tabfbox\hbox{\rlap{\indent\hskip\@totalleftmargin + \the\everypar}}\def\@itemfudge{\box\@tabfbox}\@startline\ignorespaces + $\@gobblecr %% added line +} + +\def\endprogram{$\@stopline\ifnum\@tabpush > 0 \@badpoptabs \fi\endtrivlist% + \restorecr \@tabcommandsoff %% added line + \ifVBarOutsideProgram\else\catcode`\|=12\fi %% added line + \ifNumberPrograms\global\let\@currentlabel\@savecurrentlabel\fi +\@gobblecr +} + +\def\smallprogram{% + \let\programsize=\small\program +} + +\def\endsmallprogram{% + \let\programsize=\relax\endprogram +} + +% - version which puts the whole program in a box. +\newif\if@programbox \@programboxfalse +\newenvironment{programbox}% + {\begin{minipage}[t]{\textwidth}% + \@programboxtrue + \begin{program}}% + {\end{program}% + \@programboxfalse + \end{minipage}% +} + +\def\({\begin{programbox}} +\def\){\end{programbox}} + +% A new version of @stopline which ignores blank lines (lines with +% width 0pt). To print a blank line, put "\ " on it! +% +\def\@stopline{% + \unskip\@stopfield + \if@rjfield + \global\@rjfieldfalse + \@tempdima\@totalleftmargin \advance\@tempdima\linewidth + \hbox to\@tempdima{\@itemfudge\@printlineno\hskip\dimen\@curtabmar + \box\@curline\hfil\box\@curfield}% + \else + \@addfield + \ifdim\wd\@curline=0pt\else + \hbox{\@itemfudge\@printlineno\hskip\dimen\@curtabmar\box\@curline}% + \fi +\fi +} + +\def\@printlineno{\ifNumberPrograms + \global\def\@currentlabel{\theprogramline}% + \hskip\leftmargini + \llap{{\prognumstyle(\theprogramline)}\hskip\labelsep}\fi} + +\def\prognumstyle{\scriptsize\em} + +\def\@startline{\global\@curtabmar\@nxttabmar + \ifNumberPrograms\grefstepcounter{programline}\fi % Added by M.Ward + \global\@curtab\@curtabmar\global\setbox\@curline\hbox % missing \global + {}\@startfield\strut} % added 17 Jun 86 + +\def\grefstepcounter#1{\stepcounter{#1}\let\@tempa\protect + \def\protect{\noexpand\protect\noexpand}% + \global\edef\@currentlabel{\csname p@#1\endcsname\csname the#1\endcsname}% + \let\protect\@tempa} + + + +% A switch to allow \BAR...\BAR without untabbing twice: +\newif\ifBarDone \BarDonefalse + +% a switch to allow \IF or \ELSIF with no \THEN (Grrr...): +\newif\ifTHEN + +% For saving and restoring tab numbers (if a structure may contain +% "unbalanced" \tab ... \untab pairs: +\newcount\old@nxttabmar + +% These are the commands used to set the tabs. +% They have different definitione inside and outside tebbing environments: + +\def\@tabcommandson{% activate tabbing commands: + % \tab sets a tab stop and adds one to the margin tab: + \def\tab{$\=\+$}% + % \qtab sets a tab stop at one quad of indentation: + \def\qtab{\quad$\=\+$\kern-1em}% + % \untab removes one tab stop and moves left if at the beginning of a line: + \def\untab{$\@finishfield\@ifatmargin\@ltab\else\relax\fi\-$}% + % Must finish current field before testing if at margin: + \def\@finishfield{\@stopfield\@addfield\@startfield}% + % \@marginspace adds an extra space unless there is no text on the line: + \def\@marginspace{$\@finishfield$\@ifatmargin\relax\else\ \fi}% + % \rcomment{...} provides a comment flush to the right margin: + \def\rcomment##1{$\`##1$}% + % \llapm{...} is like \llap{...} but also leaves and re-enters math + % mode so that "\llapm{stuff}(" does not put any space between the stuff + % and the "(". This means it will line up with "\llapm{stuff}X" + % Note this is only used when \@tabcommandson is in force so we are in + % normal math mode, not display math mode. + % The 1sp space is so that a line with just an \llapm item on it is not + % considered to be empty! + \def\llapm##1{\@ifatmargin + \llap{$##1$}$\hskip 1sp$% + \else ##1 \fi}% + \def\savetab{\global\old@nxttabmar\@nxttabmar} + \def\restoretab{\global\@nxttabmar\old@nxttabmar} + % Use this to typeset "..." at a higher tab position: + \def\utdots{$\@finishfield\@ifatmargin\@ltab\@ltab\else\relax\fi$\dots} + % For typesetting a relation: + \def\llapr##1{\@ifatmargin + \llap{$\ ##1\ $}${}$% + \else\ ##1\ \fi}% +} + +\def\@tabcommandsoff{% deactivate tabbing commands: + \let\tab=\relax% + \let\qtab=\relax% + \let\@finishfield=\relax% + \let\untab=\relax% + \let\@marginspace=\ % never at margin thus always a space + \def\rcomment##1{\qquad\mbox{##1}}% + \let\savetab=\relax% + \let\restoretab=\relax% + \let\utdots=\dots% + \def\llapm##1{##1}% + \def\llapr##1{##1}% +} + + +%% Now for the keywords: + +\def\IF{\keyword{if}\global\THENfalse\ \tab} +\def\THEN{\@marginspace\keyword{then}\global\THENtrue\ \tab} +% else has the same width as then and lines up with it on right: +\def\ELSE{\@marginspace\llapm{\keyword{else}\ }}% +% elsf lines up with the if: +\def\ELSF{\@marginspace\untab\ifTHEN\untab\fi% + \global\THENfalse\keyword{elsf}\ \tab} +\def\ELSIF{\@marginspace\untab\ifTHEN\untab\fi% + \global\THENfalse\keyword{elsif}\ \tab} +% \AR is the arrow for Dijkstra if and do: +% \AR* starts a newline with one quad indentation: +\def\AR{\@marginspace\rightarrow\global\THENtrue\@ifstar% + {\\\quad\tab\global\BarDonefalse\@gobblecr}% + {\ \tab\global\BarDonefalse}}% +% bar lines up on right with if or do keyword: +\def\BAR{\@marginspace\ifBarDone\else\untab\fi\global\BarDonetrue + \llapm{\barsymbol\ }}% +\def\FI{\@marginspace\untab\ifTHEN\untab\fi\keyword{fi}} +\def\AWAIT{\keyword{await}\ }% \THEN provides the \tab +\def\DO{\keyword{do}\ \tab} +\let\@oldDO=\DO +\def\OD{\@marginspace\untab\keyword{od}} +% \WHILE, \FOR, \FOREACH and \ATEACH temporarily change \DO to not set a tab: +\def\WHILE{\keyword{while}\ \tab + \gdef\DO{\@marginspace\keyword{do}\ \global\let\DO=\@oldDO}} +\def\FOR{\keyword{for}\ \tab + \gdef\DO{\@marginspace\keyword{do}\ \global\let\DO=\@oldDO}} +\def\FOREACH{\qtab\keyword{foreach}% + \gdef\DO{\keyword{do}\ \global\let\DO=\@oldDO}% + \ \@typename} +\def\ATEACH{\qtab\keyword{ateach}% + \gdef\DO{\keyword{do}\ \global\let\DO=\@oldDO}% + \ \@typename} +\def\STEP{\@marginspace\keyword{step}\ } +\def\TO{\@marginspace\keyword{to}\ } +% \BEGIN, \REP, \ACTIONEQ and \WHERE +% make sure next statement starts on a new line +% with one quad of indentation: +\def\BEGIN{\qtab\hbox{\keyword{begin}}\ }% +\def\REP{\qtab\hbox{\keyword{rep}}\ }% +\def\ACTIONEQ{\ \equiv\\\quad\tab}% +\def\WHERE{\@marginspace\untab\qtab\hbox{\keyword{where}}\ }% +\def\IFMATCH{\qtab\keyword{ifmatch}\ \@typename} +\def\FILL{\keyword{fill}\ \tab\savetab\@typename} +\def\ENDFILL{\@marginspace\restoretab\untab\keyword{endfill}} +\def\EDIT{\keyword{edit}\ \tab} +\def\EDITPARENT{\qtab\keyword{editparent}\ } +\def\ENDEDIT{\@marginspace\untab\keyword{endedit}} +\def\ENDMATCH{\@marginspace\untab\untab\keyword{endmatch}} +\def\EXIT{\keyword{exit}} +% Generalised expression brackets: +\def\EXP{\openexp\tab} +\def\ENDEXP{\untab\closexp} +\def\VAR{\qtab\keyword{var}\ } +\def\var{\ \keyword{var}\ } +\def\END{\@marginspace\untab\keyword{end}} +\def\ENDVAR{\@marginspace\untab\keyword{end}} +\def\ENDREP{\@marginspace\untab\keyword{endrep}} +\def\WHERE{\@marginspace\untab\tab\keyword{where}\ } +\def\WITHIN{\@marginspace\untab\keyword{within}\ } +\def\PROC{\qtab\keyword{proc}\ + \gdef\EQ{\EQsymbol\global\let\EQ=\@oldEQ}} +\def\ENDPROC{\fullstop} +\def\FUNCT{\qtab\keyword{funct}\ + \gdef\EQ{\EQsymbol\global\let\EQ=\@oldEQ}} +\def\ENDFUNCT{\fullstop\global\let\EQ=\@oldEQ} +\def\JOIN{\keyword{join}\ \tab} +\def\NIOJ{\@marginspace\untab\keyword{nioj}} +\let\ENDJOIN=\NIOJ +\def\ONEOF{\keyword{oneof}\ \tab} +\def\FOENO{\@marginspace\untab\keyword{foeno}} + +\def\ACTIONS{\tab\keyword{actions}\ \global\let\EQ=\@oldEQ} +\def\ENDACTIONS{\@marginspace\untab\keyword{endactions}} +\def\ENDACTION{\fullstop} +\def\CALL{\keyword{call}\ } +\def\LLAC{} +\let\ENDCALL=\LLAC +\def\COMMENT#1{\keyword{comment}\mbox{: #1}} +\def\C#1{\keyword{C}:\ \mbox{#1}} +\def\ARRAY{\keyword{array}\ } +\def\LIKE{\@marginspace\keyword{array}\ } +\def\TYPEDEF{\@marginspace\keyword{typedef}\ } + +\def\@typename#1{\mbox{#1}\ } + +% The symbols used in programs: +\def\BODY{\EQsymbol} +\def\QE{\fullstop} % end of == definition. + +% Expression brackets: +\def\openexp{\mathopen {\mbox{\rule[-0.5ex]{0.04em}{2.3ex}% + \rule[1.7ex]{0.4em}{0.1ex}}}} +\def\closexp{\mathclose{\mbox{\rule[-0.5ex]{0.4em}{0.1ex}% + \rule[-0.5ex]{0.04em}{2.3ex}}}} + +% \fullstop ends an action, proc or funct definition: +\def\fullstop{\untab{\mbox{\bf .}}} +\def\barsymbol{{\rlap{$\sqcap$}\sqcup}} + +% \join and \choice symbols: +\def\join{\@marginspace\llapm{\sqcup\ }}% +\def\choice{\@marginspace\llapm{\sqcap\ }}% +% \EQ puts more space around symbol in program environment: +% (this gets redefined by \PROC and \FUNCT): +\def\EQ{\EQsymbol\tab}% +\def\@oldEQ{\EQsymbol\tab}% +\def\EQsymbol{\mathrel{\EQspace\equiv\EQspace}} + +% default is tab commands deactivated: +\@tabcommandsoff + +% define \normalshape if not present: +\@ifundefined{normalshape} + {\def\normalshape{\rm}} + {\relax} + +% Underline through descenders: +\let\undertext=\underbar +\def\lowundertext#1{\ifmmode\underline{\vphantom{y}\mbox{#1}}\else + $\underline{\vphantom{y}\mbox{#1}}$\fi} + +% The Boolean values: +\def\true{\boldvar{true}} +\def\false{\boldvar{false}} + +% The simple programs: +\def\ABORT{\boldvar{abort}} +\def\SKIP{\boldvar{skip}} +\def\NULL{\boldvar{null}} + +% An abbreviation: +\def\aeq{\ACTIONEQ} + +%% Draw a box round something in a program: +\def\progbox#1{% + % Set #1 in a box, with no tab settings, and restore horizontal position: + \rlap{\kern-\fboxsep\kern-0.4pt% + \fbox{$\@tabcommandsoff\phantom{#1}$}}% + % Then set it again as normal: + #1\ } + +%% For a larger box, covering several lines, put \tl at the top left +%% corner, and \br at the bottom right. THIS REQUIRES pstricks AND pst-node +\def\tl{\llap{\rnode{tl}{\strut}\hspace{2pt}}} +\def\br{\rlap{\hspace{2pt}\rnode{br}{\strut}}% + \ncangles[linewidth=0.4pt, linearc=0pt, nodesep=0pt, angle=90,% + armA=1.5ex, armB=1.5ex]{-}{tl}{br}% + \ncangles[linewidth=0.4pt, linearc=0pt, nodesep=0pt, angle=-90,% + armA=1.4ex, armB=1.4ex]{-}{br}{tl}} + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% Section (2). |Variable_Names| +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +%%% We use an idea from Rainer Schopf's verbatim style +%%% This allows !@#$%^&*() in variable names as well as _ +%%% This version should cope better with missing | delimiters: + +% First we define the default \variablefont, \variablefontend and \keyword: + +\newif\if@corr +\def\no@corr{\do{.}\do{,}} +\def\@corr{\def\do##1{\ifx\temp##1\@corrfalse\fi}\@corrtrue\no@corr + \if@corr\/\else\fi\endgroup\egroup} % put back the \egroup + +% The old default keyword style is bold underlined: +% The old default variable font is slanted, so \variablefontend adds italic correction: +\def\bfvariables{% + \let\variablefont=\sl% + \def\variablefontend##1{\begingroup\futurelet\temp\@corr}% gobble the \egroup + \def\keyword##1{\mbox{\underbar{\normalshape\bf ##1}}} + \def\boldvar##1{{\mbox{\normalshape\bf ##1}}} +} + +% For sans-serif variables and keywords (no underbar): +\def\sfvariables{% + \def\variablefont{\normalshape\sf}% + \def\variablefontend{}% + \def\keyword##1{\mbox{\normalshape\bf\sf ##1}}% + \def\boldvar##1{\mbox{\normalshape\bf\sf ##1}}% +} + +% For sans-serif variables and keywords in CAPITALS +% (As required for Oberon and Modula) +% This command was submitted by Matteo Corti : +\def\bigcaps{% + \def\variablefont{\normalshape\sf}% + \def\variablefontend{}% + \def\keyword##1{\mbox{\uppercase{##1}}}% + \def\boldvar##1{\mbox{\normalshape\bf\sf ##1}}% +} + + +% The new default is \sfvariables: + +\sfvariables + + +% Use \scriptvar|foo| for sub/super-script variables: +\def\scriptvariablefont{\scriptsize\@variablefont}% +\def\scriptvar{\let\@variablefont=\variablefont% + \let\variablefont=\scriptvariablefont% + \let\@variablefontend=\variablefontend% + \def\variablefontend{\let\variablefont=\@variablefont% + \let\variablefontend=\@variablefontend% + \@variablefontend}} + +% This section is modified from verbatim.sty: +\newif\ifwasinmmode \wasinmmodefalse +\begingroup + \lccode`\~=`\^^M + \lccode`\V=`\V + \lowercase{% + \gdef\variable{% first save mmode status: + \ifmmode\wasinmmodetrue\else\wasinmmodefalse\fi + \mbox\bgroup\begingroup + \variablefont + \catcode`\^^M\active + \safeat + \def~{\endgroup\egroup\\ + \@latexerr{Variable name ended by end of line.}\@ehc}% + \catcode`\_\active + \let\do\@makeother + \do\{\do\}\do\$\do\&% + \do\#\do\^\do\^^K\do\^^A\do\%\do\~\do\@\@svariable}} +\endgroup +\def\@svariable{% + \catcode`\|\active + \lccode`\~`\|% + \lowercase{\def~{\endgroup% if we were not in mmode, do italic corr: + \ifwasinmmode\let\next=\/% was \relax + \else\let\next=\variablefontend\fi + \next + \egroup}% + \let\@dovar~}% + \leavevmode\null} + +\catcode`\|=12\relax +\let\origbar=| +\catcode`\|\active + +% Make @ active and equal to \char 64: +\begingroup + \catcode`\@=\active + \gdef\safeat{\catcode`\@=\active\def@{\char64\relax}}% +\endgroup + +\def|{\ifx\@sharp\relax\origbar\else\relax\p@dovar\fi} +\def\p@dovar#1{#1\protect\@dovar\null} +\def\@dovar{\variable} % #1 = \fi from defn of | + +%% Set up _ as \_ outside math mode and \sb in math mode: +%% (in case you use _ outside math mode) +\catcode`\_=\active \def_{\ifmmode\sb\else\p@sb\fi} +\def\p@sb{\protect\@sb} +\def\@sb{\_} +% Restore catcode of _ (due to clash with \includegraphics): +\catcode`\_=8 + + +%% Make sure | still works in \verb and verbatim (it is now a "special"): +\def\dospecials{\do\ \do\\\do\{\do\}\do\$\do\&% + \do\#\do\^\do\_\do\%\do\~\do\|\do\@} + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% Section (3). Program Schemas. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +% Definitions for bold subscripted symbols, eg: +% \B1 or \B{} or \B{12} ... etc. +% We check for ' so \B', \S''' etc will work as expected. +\def\A{\boldsub{A}} +\def\B{\boldsub{B}} +\def\P{\boldsub{P}} +\def\Q{\boldsub{Q}} +\def\R{\boldsub{R}} +\def\S{\boldsub{S}} +\def\T{\boldsub{T}} +\def\Z{\boldsub{Z}} + +% some bold letters: +\def\d{\boldsub{d}} +\def\e{\boldsub{e}} +\def\t{\boldsub{t}} +\def\w{\boldsub{w}} +\def\x{\boldsub{x}} +\def\y{\boldsub{y}} +\def\z{\boldsub{z}} + +\newif\ifMmode \Mmodefalse + +\def\boldsub#1{% + \relax% to fool array and other alignments + \ifmmode + \Mmodetrue + \else + $\Mmodefalse + \fi + \mbox{\normalshape\bf #1}% + \@boldsub +} + +\def\boldsubm#1{% + \relax% to fool array and other alignments + \ifmmode + \Mmodetrue + \else + $\Mmodefalse + \fi + \boldsymbol{#1}% + \@boldsub +} + + % Use \mathchoice (typesets all 4) if this is needed for + % subscripts or superscripts (costs ~0.5 seconds per symbol!): + % NB use of \text should fix this with AMSLaTeX. + %\mathchoice{\mbox{\series{bx}\shape{n}\selectfont #1}}% + % {\mbox{\series{bx}\shape{n}\selectfont #1}}% + % {\mbox{\normalshape\bf\scriptsize #1}}% + % {\mbox{\normalshape\bf\tiny #1}}% + +\def\@nothing{} \def\prog@prime{'} +\def\@boldsub#1{% + \def\@boldsubthing{#1}% subscript + \ifx\@boldsubthing\@nothing% empty + \let\@boldsubnext\@boldsubfinish + \else + \ifx\@boldsubthing\prog@prime% + \def\@boldsubnext{^\bgroup\prime\@absorbprimes}% + \else + \def\@boldsubnext{_{#1}\@boldsubfinish}\fi + \fi + \@boldsubnext +} + +\def\@absorbprimes{\futurelet\@boldsubnext\@seeifprime} +\def\@seeifprime{% + \ifx\@boldsubnext'% + \def\@boldsubnext{\@getprime}% + \else + \def\@boldsubnext{\egroup\@boldsubfinish}% + \fi + \@boldsubnext +} +\def\@getprime'{\prime\@absorbprimes} +\def\@boldsubfinish{\ifMmode\else$\fi} + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% Section (4). Maths notation used in programs +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +% Notation for sets of the form {...|...} : +% Eg: \set{x \in N | x>0} becomes: +% \left\{\left.\, x \in N \:\right\origbar\: x>0 \,\right\} +% set brackets and | grow to fit the size if their contents. +% Also: \bigset{...|...} becomes: +% \bigl\{\, ... \mathrel{\bigm\origbar} ... \, \bigr\} +% \bigset is in an aligned environment, so it can include \\ +% (AMSLaTeX only) +% +\def\set#1{\@@set#1\@end} % strip of the {} and pass to \@@set +\def\@@set#1|#2\@end{\left\{\left.\, #1 \:\right\origbar\: + #2 \,\right\} } +\def\bigset#1{\@bigset#1\@end} % strip of the {} and pass to \@bigset +\@ifundefined{aligned} +{% Not AMSLaTeX: + \def\@bigset#1|#2\@end{\bigl\{\, #1 {\:\bigm\origbar\:} + #2 \,\bigr\} } +}{% With AMSLaTeX: + \def\@bigset#1|#2\@end{\begin{aligned}[t]\bigl\{\, #1 {\:\bigm\origbar\:}& + \let\@oldcr=\\\def\\{\@oldcr&{}} + #2 \,\bigr\} \end{aligned} } +} + +% Notation for substitution in programs: +\def\sub[#1/#2|#3]{\left[\left.#1\,/\,#2\,\right\origbar\,#3\,\right]} +\def\bigsub[#1/#2|#3]{\bigl[#1\,\bigm/\,#2\,\bigm\origbar\,#3\,\bigr]} +% Use \modbar{x} for |x|: +\def\modbar#1{\left\origbar #1\right\origbar} + +% Notation for a sequence in angle brackets: +% \bigseq uses big size of brackets: +% \def\seq#1{\left< #1 \right>} +\def\seq#1{\langle #1 \rangle} +\def\bigseq#1{\bigl< #1 \bigr>} + +% Notation for subsequences analogous to set notation: +\def\subseq#1{\@@subseq#1\@end} % strip of the {} and pass to \@@subseq +\def\@@subseq#1|#2\@end{\left<\left.\, #1 \:\right\origbar\: + #2 \,\right>} +\def\bigsubseq#1{\@bigsubseq#1\@end} % strip of the {} and pass to \@bigsubseq +\@ifundefined{aligned} +{% Not AMSLaTeX: + \def\@bigsubseq#1|#2\@end{\bigl<\, #1 {\:\bigm\origbar\:} + #2 \,\bigr> } +}{% With AMSLaTeX: + \def\@bigsubseq#1|#2\@end{\begin{aligned}[t]\bigl<\, #1 {\:\bigm\origbar\:}& + \let\@oldcr=\\\def\\{\@oldcr&{}} + #2 \,\bigr> \end{aligned} } +} + +% range dots, like \ldots but with two dots only (for 1..n etc.): +\def\rdots{\mathinner{\ldotp\ldotp}} + +% Atomic Specification statement: for eg /.Q use: \atspec x/y. Q +% This uses "/" and "." as argument delimiters: +% \def\atspec #1/#2.{\seq{#1}\!/\!\seq{#2}\!.} +\def\atspec #1/#2.{\seq{#1}/\seq{#2}.} + +% \Forall vars.formula and \Exists vars.formula: +\def\Forall#1.{\forall #1.\,} +\def\Exists#1.{\exists #1.\,} + +\let\EQspace=\ % default space around \EQ \EQT and \LE +\def\EQT{\mathrel{\EQspace\approx\EQspace}} % program equivalence. +\def\LE{\mathrel{\EQspace\le\EQspace}} % program refinement. +\def\SLE{\mathrel{\EQspace\preccurlyeq\EQspace}} % semi-refinement. +\def\NOT{\neg} +% \AND and \OR relations have an extra thin space around them: +\def\AND{\mathrel{\,\wedge\,}} +\def\OR{\mathrel{\,\vee\,}} +\def\EOR{\mathrel{\,\oplus\,}} +\def\sbs{\subseteq} +\def\im{\Rightarrow} +% (use \iff and \implies for the "long" arrows) +\def\union{\cup} +\def\intersect{\cap} +\def\lar{\leftarrow} +\def\rar{\rightarrow} +\def\wflt{\prec} +\def\wfle{\preccurlyeq} +\def\succstar{\mathrel{\succ\!\!^*}} +\def\succeqstar{\mathrel{\succeq\!^*}} +\def\gt{\ifmmode>\else{$>$}\fi} +\def\lt{\ifmmode<\else{$<$}\fi} +\def\tw{\ifmmode{}^\sim\else{${}^\sim$}\fi} + + +% map and reduce operators: +\def\bstar{\mathrel{\boldsymbol{*}}} % for * +\def\bdiv{\boldsymbol{/}} % for / + + +% Various arrows (taken from oz.sty): +\let \rel \leftrightarrow +\let \tfun \rightarrow +\let \tinj \rightarrowtail +\def \tsur {\mathrel{\ooalign{$\tfun$\hfil\cr$\mkern4mu\tfun$}}} +\def \pfun {\p\tfun} +\def \pinj {\p\tinj} +\def \psur {\p\tsur} +\def \ffun {\f\tfun} +\def \finj {\f\tinj} +\def \bij {\mathrel{\ooalign{$\tinj$\hfil\cr$\mkern5mu\tfun$}}} +\def\p#1{\mathrel{\ooalign{\hfil$\mapstochar\mkern 5mu$\hfil\cr$#1$}}} +\def\f#1{\mathrel{\ooalign{\hfil + $\mapstochar\mkern 3mu\mapstochar\mkern 5mu$\hfil\cr$#1$}}} + +%% Logical exclusive or: +\def\exor{\oplus} + +%% Sequence concatenation: +\def\concat{\mathrel{+\!\!\!+}} + +\def\rmtiny{\normalshape\rm\tiny} + +%% Stack operations: +\def\push{\mathrel{\overset{\mbox{\rmtiny push}}{\longleftarrow}}} +\def\pop {\mathrel{\overset{\mbox{\rmtiny pop}}{\longleftarrow}}} +\def\pick{\mathrel{\overset{\mbox{\rmtiny pick}}{\longleftarrow}}} +\def\last{\mathrel{\overset{\mbox{\rmtiny last}}{\longleftarrow}}} + +%% bitwise operators +\def\bitand {\mathrel{\overset{\mbox{\tiny bit}}{\wedge}}} +\def\bitor {\mathrel{\overset{\mbox{\tiny bit}}{\vee}}} +\def\bitexor{\mathrel{\overset{\mbox{\tiny bit}}{\vphantom\vee\smash\oplus}}} +\def\bitnot{{\overset{\mbox{\tiny bit}}{\vphantom\vee\neg}}} + +%% Logical, decimal and floating point operators: +\def\lplus {\mathrel{\overset{\mbox{\tiny log}}{+}}} +\def\lminus{\mathrel{\overset{\mbox{\tiny log}}{-}}} +\def\lmult {\mathrel{\overset{\mbox{\tiny log}}{\times}}} +\def\ldiv {\mathrel{\overset{\mbox{\tiny log}}{\div}}} +\def\lequ {\mathrel{\overset{\mbox{\tiny log}}{=}}} +\def\lneq {\mathrel{\overset{\mbox{\tiny log}}{\neq}}} +\def\lless {\mathrel{\overset{\mbox{\tiny log}}{<}}} +\def\lgreat{\mathrel{\overset{\mbox{\tiny log}}{>}}} +\def\lleq {\mathrel{\overset{\mbox{\tiny log}}{\leq}}} +\def\lgreq {\mathrel{\overset{\mbox{\tiny log}}{\geq}}} +\def\dplus {\mathrel{\overset{\mbox{\tiny dec}}{+}}} +\def\dminus{\mathrel{\overset{\mbox{\tiny dec}}{-}}} +\def\dmult {\mathrel{\overset{\mbox{\tiny dec}}{\times}}} +\def\ddiv {\mathrel{\overset{\mbox{\tiny dec}}{\div}}} +\def\deq {\mathrel{\overset{\mbox{\tiny dec}}{=}}} +\def\dneq {\mathrel{\overset{\mbox{\tiny dec}}{\neq}}} +\def\dless {\mathrel{\overset{\mbox{\tiny dec}}{<}}} +\def\dgreat{\mathrel{\overset{\mbox{\tiny dec}}{>}}} +\def\dleq {\mathrel{\overset{\mbox{\tiny dec}}{\leq}}} +\def\dgreq {\mathrel{\overset{\mbox{\tiny dec}}{\geq}}} +\def\fplus {\mathrel{\overset{\mbox{\tiny fpt}}{+}}} +\def\fminus{\mathrel{\overset{\mbox{\tiny fpt}}{-}}} +\def\fmult {\mathrel{\overset{\mbox{\tiny fpt}}{\times}}} +\def\fdiv {\mathrel{\overset{\mbox{\tiny fpt}}{\div}}} +\def\feq {\mathrel{\overset{\mbox{\tiny fpt}}{=}}} +\def\fneq {\mathrel{\overset{\mbox{\tiny fpt}}{\neq}}} +\def\fless {\mathrel{\overset{\mbox{\tiny fpt}}{<}}} +\def\fgreat{\mathrel{\overset{\mbox{\tiny fpt}}{>}}} +\def\fleq {\mathrel{\overset{\mbox{\tiny fpt}}{\leq}}} +\def\fgreq {\mathrel{\overset{\mbox{\tiny fpt}}{\geq}}} + +%% mod and div: +\def\MOD{\mathrel{\text{mod}}} +\def\DIV{\mathrel{\text{div}}} + +%% add the definition of overset if not present: +\@ifundefined{overset}% + {\def\overset#1#2{\binrel@{#2}% + \binrel@@{\mathop{\kern\z@#2}\limits^{#1}}} + \def\binrel@#1{\setboxz@h{\thinmuskip0mu + \medmuskip\m@ne mu\thickmuskip\@ne mu$#1\m@th$}% + \setbox@ne\hbox{\thinmuskip0mu\medmuskip\m@ne mu\thickmuskip + \@ne mu${}#1{}\m@th$}% + \setbox\tw@\hbox{\hskip\wd@ne\hskip-\wdz@}} + \def\binrel@@#1{\ifdim\wd2<\z@\mathbin{#1}\else\ifdim\wd\tw@>\z@ + \mathrel{#1}\else{#1}\fi\fi}% + \def\setboxz@h{\setbox\z@\hbox}% + \def\setbox@ne{\setbox\@ne}% + \def\wd@ne{\wd\@ne}% + \def\wdz@{\wd\z@}% + }{} + +%% =df symbol (with thick space around it): +\def\edf{\mathrel{\;=_{{}_{\mbox{\rmtiny DF}}}\;}} + +%% empty set symbol: (use \varnothing if available) +\@ifundefined{varnothing}% + {\let\nullset=\emptyset}% + {\let\nullset=\varnothing}% + +%% Powerset symbol: +\@ifundefined{DeclareMathSymbol}{% +%% check if \teurm defined - if not then use \oldwp (Large and raised): +\@ifundefined{teurm}% + {\def\powerset{\raisebox{0.5ex}{\Large$\oldwp$}}}% no \eurm + {\def\powerset{\raisebox{0.5ex}{\Large\teurm\char"7D}}}% Use Euler roman p +}{% +\DeclareSymbolFont{eulerletters}{U}{eur}{m}{n}% +\DeclareMathSymbol{\powersetsymbol}{\mathord}{eulerletters}{"7D}% +\newsavebox{\powersetbox} +\sbox{\powersetbox}{\raisebox{0.5ex}{\mbox{\Large$\powersetsymbol$}}} +\def\powerset{\usebox{\powersetbox}} +% old defn -- with amslatex this makes the whole maths item \Large! +%\def\powerset{\raisebox{0.5ex}{\Large$\powersetsymbol$}} +}% + + +%% The stmaryrd style and fonts include \bigsqcap, but if you don't have +%% it, here is an alternative using rules (only works at standard size): +\@ifundefined{bigsqcap} + {\def\bigsqcap{\mathop{% + \rule[-0.2ex]{.07em}{2.17ex}% + \rule[1.8ex]{0.5em}{.17ex}% + \rule[-0.2ex]{.07em}{2.17ex}}}} + {\relax} + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% Section (5). Miscellaneous bits and pieces +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +%% Substitute for some AMSLaTeX things if they are missing: +\@ifundefined{text}{\let\text=\mbox}{} +\@ifundefined{boldsymbol}{\def\boldsymbol#1{\mbox{\bf #1}}}{} +\@ifundefined{implies}{\def\implies{\;\Longrightarrow\;}}{} +\@ifundefined{operatorname}{\def\operatorname#1{\mathop{#1}}}{} + + +% \snugbox is by Victor Eijhout, eijkhout@cs.utk.edu, TUGboat 13, 1, 1992. +% It sets a box containing paragraphs as wide ``as it really is'' +\def\snugbox{\mbox\bgroup +% ^^^^^ changed from \hbox by M.Ward + \setbox\z@\vbox\bgroup + \leftskip\z@ + \bgroup\aftergroup\make@snug + \let\next=} +\def\make@snug{\par\sn@gify\egroup + \box\z@\egroup} +\def\sn@gify + {\skip\z@=\lastskip \unskip + \advance\skip\z@\lastskip \unskip + \unpenalty + \setbox\z@\lastbox + \ifvoid\z@ \nointerlineskip + \else {\sn@gify} \fi + \hbox{\unhbox\z@}\nointerlineskip + \vskip\skip\z@ + } +% To vertically centre the box: +\def\textvcenter{\hbox\bgroup$ + \everyvbox{\everyvbox{}% + \aftergroup$% + \aftergroup\egroup} + \vcenter} + + +%% Cases environment: +%% based on description environment with numbering: +\def\Cases{ + \ifnum \@enumdepth >3 \@toodeep\else + \advance\@enumdepth \@ne + \edef\@enumctr{enum\romannumeral\the\@enumdepth}% + \@ifundefined{mathindent} + {\list{\kern-1em\hbox{\normalshape\bf Case \arabic{\@enumctr}:}}% + {\usecounter{\@enumctr}% + \def\makelabel##1{##1}}}% + {\list{\kern-1em\hbox{\normalshape\bf Case \arabic{\@enumctr}:}}% + {\mathindent 0pt \usecounter{\@enumctr}% + \def\makelabel##1{##1}}}% + \fi} + +\let\endCases=\endlist + +%% \CASES is redundant with amstex.sty +\def\CASES#1{\left\{\,\vcenter{{\let\\=\cr\normalbaselines\m@th + \ialign{$##\hfil$&\quad##\hfil\crcr#1\crcr}}}\right.} + +%% Environment romanenumerate for lists numbered by roman numerals: +\def\romanenumerate{\begingroup + \def\theenumi{\normalshape(\myroman{enumi})}% + \def\p@enumi{}% + \def\labelenumi{\theenumi}% + \enumerate} +\def\endromanenumerate{\endenumerate\endgroup} + +%% A fix to get lower case Roman numerals for use as labels: +\def\myroman#1{\@myroman{\@nameuse{c@#1}}} +\def\@myroman#1{\expandafter{\romannumeral #1}} + +%% \proof macro for theorems and lemmas: +\def\proof{\normalshape{\setlength{\parskip}{0pt}\par\addvspace\medskipamount + \noindent{\bf Proof: }}\ignorespaces} + +%% require the {...} for \wp and \WP +\let\oldwp=\wp % save old \wp (curly p character) +%\def\wp#{\@wp} +%\def\@wp#1{\mbox{\normalshape wp}(#1)} +%\def\WP#{\@WP} +%\def\@WP#1{\mbox{\normalshape WP}(#1)} +%% Don't require {...}, ie use normal parentheses where required: +\def\wp{\mbox{\normalshape wp}} +\def\WP{\mbox{\normalshape WP}} + + +%% Two line displayed equation, eg: +%% \[ \twoline{ a_very_long_left_hand_side \\ +%% {} = a_fairly_long_right_hand_side } \] +%% Use in displayed maths mode. +%% NB this is superseded by AMSLaTeX's multline environment. +\def\twoline#1{\def\\{\hfill\cr\hfill}% \def only lasts to end of display + \displaylines{\quad #1 \quad\cr}} + +%% Add a definition of \Bbb if not present: +% We use poor man's bold to give an ``extra bold'' letter: +\@ifundefined{Bbb} + {\def\Bbb{\protect\pBbb} + \def\pBbb#1{\setbox0=\hbox{\bf #1} + \kern-.025em\copy0\kern-\wd0 + \kern.05em\copy0\kern-\wd0 + \kern-.025em\raise.0433em\box0 }} + {\relax} + +%% Add a definition of cases environment if not present: +\@ifundefined{endcases} + {\def\cases{\left\{\def\arraystretch{1.2}\hskip-\arraycolsep + \array{l@{\quad}l}} + \def\endcases{\endarray\hskip-\arraycolsep\right.}} + {\relax} + +%% draw a line across the page: +\def\dashes{$\makebox[6in]{\hrulefill}$} + +%% A \qed command for the end of a proof: +\@ifundefined{blacksquare} + {\def\qedsymbol{\vrule width.6em height.5em depth.1em\relax}} + {\let\qedsymbol=\blacksquare} +\def\qed{\ifx\\\@eqncr\let\next\eqnarrayqed\else + \ifmmode\let\next\eqnqed\else + \let\next\textqed\fi\fi\next} +%\def\eqnqed#1\]{\belowdisplayskip\z@\belowdisplayshortskip\z@ +% \postdisplaypenalty\@M\relax#1 +% \]\par{\lineskip\z@\baselineskip\z@\vbox to\z@{\vss\noindent\textqed}}} +%% simpler version from ROGERS@se.physto.vana using the primitive \eqno: +\def\eqnqed#1\]{\relax#1\eqno\qedsymbol$$\ignorespaces} +\def\textqed{{\unskip\nobreak\hfil\penalty50\hskip2em\null\nobreak\hfil + $\qedsymbol$\parfillskip\z@\finalhyphendemerits0\par}} +\def\eqnarrayqed{\\\noalign{\vspace{-\jot}% + {\lineskip\z@\baselineskip\z@% + \vbox to\z@{\vss\noindent\textqed}}% + \vspace{-\baselineskip}}} + + +%% A crude method of allowing URLs to break across lines: sprinkle ~'s +%% inside your \www{...} command, eg: +%% \www{http://~ws-mj3.~dur.~ac.~uk/~martin/~papers/~ref-ws-5.ps.gz} + +\def\www{\bgroup\def~{\hskip 1pt plus 3pt minus 1pt\relax}\www@} +\def\www@#1{$\langle$#1$\rangle$\egroup} + +%% Fix the use of | in \index: + +\def\makeindex{% + \newwrite\@indexfile + \immediate\openout\@indexfile=\jobname.idx + \def\index{\@bsphack\begingroup + \catcode`\|=12 + \@sanitize + \@wrindex}\typeout + {Writing index file \jobname.idx}% + \let\makeindex\@empty +} +\def\index{\@bsphack\begingroup\catcode`\|=12\@sanitize\@index} + -- cgit v1.2.3