diff --git a/core/.gitignore b/core/.gitignore new file mode 100644 index 00000000..7a511723 --- /dev/null +++ b/core/.gitignore @@ -0,0 +1,7 @@ +# when core is built +*.xmlo +*.xmle +*.js +*.dep +*.tmp +*.html diff --git a/core/COPYING b/core/COPYING new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/core/COPYING @@ -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/core/README.md b/core/README.md new file mode 100644 index 00000000..9a253152 --- /dev/null +++ b/core/README.md @@ -0,0 +1,57 @@ +# TAME Core +Core library for TAME, providing generic abstractions for common +operations. + +This library has accumulated a bit of cruft, is disorganized, and has +not been substantially refactored to take advantage of new language +features. It is a work in progress. + + +## Features +- BDD abstraction; +- Classification match manipulation; +- Common operations on numbers; +- Conditional evaluation helpers; +- Core primitive declarations; +- Interpolation; +- Interval mapping; +- Matrix and vector manipulation; +- Query matrices as data tables; +- Value mappings; and +- Other miscellaneous stuff. + + +## What is TAME? +TAME is The Adaptive Metalanguage, a programming language and system of tools +designed to aid in the development, understanding, and maintenance of systems +performing numerous calculations on a complex graph of dependencies, +conditions, and a large number of inputs. + +This system was developed at R-T Specialty Buffalo to handle the complexity of +comparative insurance rating systems. It is a domain-specific language (DSL) +that itself encourages, through the use of templates, the creation of sub-DSLs. +TAME itself is at heart a calculator—processing only numerical input and +output—driven by quantifiers as predicates. Calculations and quantifiers are +written declaratively without concern for order of execution. + +The system has powerful dependency resolution and data flow capabilities. + +TAME consists of a macro processor (implementing a metalanguage), numerous +compilers for various targets (JavaScript, HTML documentation and debugging +environment, LaTeX, and others), linkers, and supporting tools. The input +grammar is XML, and the majority of the project (including the macro processor, +compilers, and linkers) are written in XSLT. There is a reason for that odd +choice; until an explanation is provided, know that someone is perverted enough +to implement a full compiler stack in XSLT. + + +## License +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. + diff --git a/core/aggregate.xml b/core/aggregate.xml new file mode 100644 index 00000000..e6f94e2a --- /dev/null +++ b/core/aggregate.xml @@ -0,0 +1,154 @@ + + + + + + + + + Aggregate templates simplify aggregating values through various means. + Unless otherwise specified, + the default means of aggregation is summation. + + +
+ For large numbers of values, + the most convenient way to aggregate is by matching on symbol names. + Note that symbols must be available for a match to occur. + All imported symbols are immediately available, + but \tt{expand-sequence} may need to be used for symbols produced by + the same package. + + + \ref{_aggregate-rate-each_} aggregates values of generators (usually + referred to by \tt{rate-each}) through summation. + A \tt{rate-each} block is generated to perform the summation. + + Since \tt{rate-each} multiplies its body by \tt{_CMATCH_}, + zero symbols would normally result in the summation of \tt{_CMATCH_} + itself, which is not desirable; + this template always includes \ref{ZERO} in the body to defend + against this, + causing a yield of~$0.00$ if there are no symbol matches. + + + + + \ref{_aggregate-rate_} is analgous to \ref{_aggregate-rate-each_}, + handling only scalar~\tt{@yields@}. + A \tt{rate} block is generated to aggregate by summation. + + To prevent an empty rate block from being generated if there are no + symbol matches, + \ref{ZERO} is always included as part of the summation. + + + + + \ref{_aggregate-classify_} aggregates classifications. + Keep in mind that classifications act as universal quantifiers by default, + meaning zero symbol matches will produce a match and a scalar~$1$; + existential quantifiers (\tt{@any@} set to \tt{true}) will \emph{not} + match and will produce the scalar~$0$. + + +
+
diff --git a/core/alias.xml b/core/alias.xml new file mode 100644 index 00000000..7564f1ac --- /dev/null +++ b/core/alias.xml @@ -0,0 +1,100 @@ + + + + + These alias templates allow giving a new name to existing values. + They are most useful for avoiding too many template-generated variables. + + If an alias name matches the name of the source, + then no alias will be generated; + this behavior is useful when generating aliases in templates where the + caller may or may not choose a name that would otherwise conflict with + its internal representation. + + If no description is provided, + aliases will inherit the description from the source symbol. + + + + + + + + + diff --git a/core/assert.xml b/core/assert.xml new file mode 100644 index 00000000..726ee7d6 --- /dev/null +++ b/core/assert.xml @@ -0,0 +1,110 @@ + + + + + + + + + This package is young; + the intent is to provide basic assertions to ensure data + integrity. + + \emph{N.B. The behavior of this package changed in version 1.0.0---% + \ref{_assert_} now properly fails on non-match, + not match.} + + The \ref{_assert_} template generates a~generic assertion using the + provided predicates. + If the predicates provided to the assertion fail (yields $\bot$), + the system immediately terminates.\footnote{ + Beacuse the system stops processing once a terminating classification + yields~$\top$, + only one assertion will ever match, + even if others would match if execution were to continue.} + \tt{@class@} may optionally be used to predicate the asseriton itself---% + the assertion will be performed only on respective class matches. + + \ref{_assert_} implements assertions by genearting two classifications---% + one to perform the actual assertion, + and a terminating classification to ensure that the assertion + yields~$\top$. + + The param \ref{assert_ignore} will suppress assertion failures at runtime. + + + + + + diff --git a/core/base.xml b/core/base.xml new file mode 100644 index 00000000..099055b4 --- /dev/null +++ b/core/base.xml @@ -0,0 +1,220 @@ + + + + + The \pkgself~package exposes common and internal + defintions. Ideally, this package will be included automatically by + the compiler to remove repetitive, boilerplate imports. Importing + this package isn't necessary if none of these definitions are + needed. + + + +
+ \ref{_CMATCH_} is a magic constant that contains the result of + a~classification match. This is used implicity by + \ref{rate-each}.\footnote{The symbol is \Xi~because it looks like + a sideways array.} + + \todo{Remove in favor of a local variable or generated + classification; there is no need (anymore) for this to be magic.} + + + + + + + The runtime is responsible for populating \ref{__DATE_YEAR__} with + a proper value representing the current year. + + \todo{TAME is deterministic with this one exception; remove it and + have users use the params from {\tt datetime} instead if they need this + datum.} + + +
+ + + +
+ Primitives are defined internally; these definitions simply + provide symbols to permit their use. + + + + + + + + + + + + \ref{empty} does not have much use outside of the compiler. + + + + +
+ + +
+ \ref{boolean} contains the boolean \ref{TRUE} and~\ref{FALSE} values, + which map to~$1$ and~$0$ respectively. + The \ref{maybe} type is the union of \ref{boolean} and \ref{NOTHING}, + with a value of~$-1$;\footnote{ + This is similar in spirit to the Haskell \tt{Maybe} type, + or the OCaml \tt{Option} type. + }this is commonly used to represent an unknown state or missing + value.\footnote{ + The \ref{nothing}~type is used for the sake of the union; + it should not be used directly.} + + + + + + + + + + + + + + + + + + + The constant \ref{UNKNOWN} is also defined as~$-1$ to serve as an + alternative to the term~``nothing''. + + +
+ + + +
+ $0$~is a~common value. Where a value is required (such + as a~template argument), \ref{ZERO} may be used. TAME now + supports a~constant-scalar syntax ({\tt #0}; \todo{reference this + in documentation}), making this largely unnecessary. + + This is declared as a float to provide compatibility with all + types of expressions. + + + + + In the case where classifications are required, but a~static + assumption about the applicability of the subject can be made, we + have values that are always~true and always~false. The use + of~\ref{never} may very well be a~code smell, but let us not rush + to judgment.\footnote{\ref{never} has been added as an analog + to~\ref{always}; its author has never had use for it. Oh, look, + we just used ``never''.} + + + + +
+ + + +
+ \ref{_todo_} formalizes TODO items and may optionally yield a + value~\tt{@value@} for use within calculations.% + \footnote{This is different than its previous behavior of always + yielding a scalar~$0$.} + All uses of the \ref{_todo_} template will produce a warning composed of + its description~\tt{@desc@}. + + + + + The \ref{_ignore_} template serves as a~block + comment.\footnote{This is useful since XML does not support nested + comments, which makes it difficult to comment out code that + already has XML comments.} It may be useful for debugging, but is + discouraged for use otherwise. The \ref{_ignore_/@desc@} param + should be used to describe intent. + + +
+
+ diff --git a/core/cond.xml b/core/cond.xml new file mode 100644 index 00000000..1b301998 --- /dev/null +++ b/core/cond.xml @@ -0,0 +1,169 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/convention.xml b/core/convention.xml new file mode 100644 index 00000000..76618881 --- /dev/null +++ b/core/convention.xml @@ -0,0 +1,59 @@ + + + + + + \ref{_naming-convention_} defines a naming convention for a parameter that + is enforced at compile-time. + Conventions may have prefixes, suffixes, or both. + If violated, + the compiler will abort in error. + + + diff --git a/core/datetime.xml b/core/datetime.xml new file mode 100644 index 00000000..76d0bb35 --- /dev/null +++ b/core/datetime.xml @@ -0,0 +1,135 @@ + + + + + + + + + + + Providing the current timestamp externally allows the system to be + wholly deterministic. + It also captures the state of the data in time, + so re-calculating in the future (e.g. using the summary pages) + will yield the same result. + + + + + + + + + This system does not handle its own arthiemtic to figure out the + current date components from the given timestamp. + + + + + + + + + + + + diff --git a/core/dummy.xml b/core/dummy.xml new file mode 100644 index 00000000..2f1dd47d --- /dev/null +++ b/core/dummy.xml @@ -0,0 +1,87 @@ + + + + + These are dummy values created primarily for testing. + + Vectors are required for iteration; + the below generate values useful for doing so in constant, + calculation, and classification form. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/extern.xml b/core/extern.xml new file mode 100644 index 00000000..868d590e --- /dev/null +++ b/core/extern.xml @@ -0,0 +1,80 @@ + + + + + Externs are symbols that are expected to be defined by package importers + before linking. + Rather than explicitly declaring extern symbols, + these templates provide more human-readable abstractions. + + + Note that when defining extern classifications with + \ref{_classify-extern_}, + if specifying a yield, + the dimensionality is~$1$ unless otherwise provided. + + + + + + + + + diff --git a/core/insurance.xml b/core/insurance.xml new file mode 100644 index 00000000..64f93dc9 --- /dev/null +++ b/core/insurance.xml @@ -0,0 +1,423 @@ + + + + + + + + + + + + + These are primitive abstractions for insurance that will be + improved upon over time. + + Some notable TODOs: + + \begin{enumerate} + \item Enforce naming convention; + \item Support scalar results; + \item Fail on zero premium unless explicitly stated; + \item Fail on negative premium (use a credit template); + \item Rounding direction (currently only nearest); and + \item Credit and surcharge. + \end{enumerate} + + \todo{Template to abstract these {\tt rate-each} generation + templates.} + + + + + + \ref{_factor_} defines a calculation that results in a factor + which will later be used in a product. + There are special considerations for these types of values---% + generally, they should not have a value of~$0$ if some sort of calculation + condition or lookup is not met, + as that would have the effect of wiping out premium.\footnote{ + Note that every generator index can be non-zero but still sum up + to a zero yield, + which would trigger this error.} + If zero is desired, + \tt{@allow-zero@} must be set to \tt{true} to explicitly permit it. + + + + + The \ref{_credit_} and \ref{_debit_} templates define factors that are + intended to introduce, respectively, credits and surcharges. + Each name defined using these templates must be prefixed with ``credit'' + and ``debit'' respectively. + Credits must never exceed a value of~$1$, + as they would then be treated as if they were surcharges. + Similarly, debits must never have a value less than~$1$. + Both must have values greater than~$0$. + + If a value can be either a credit or a debit, + it is sometimes called an ``adjustment''. + In reality it is just another factor, + so just use \ref{_factor_} in such a~case. + + + + + + diff --git a/core/map.xml b/core/map.xml new file mode 100644 index 00000000..1bc0ac29 --- /dev/null +++ b/core/map.xml @@ -0,0 +1,188 @@ + + + + + + + + The problem with \texttt{case} statements is that they are very + verbose, which is greatly distracting for smaller cases, and~can + take away from the actual intent of the~code. Map~sets make simple + cases simple by allowing concise map definitions. + + If \ref{_map-set_/@name@} is provided, then each map implicitly + operates on that reference as its input, unless overridden using + \ref{_map_/@name@}. \ref{_map-set_/@default@} can be used to + provide a constant default if no mapping is otherwise available; see + also~\ref{_map-else_}. + + + + + + Mappings are defined using \ref{_map_}. The input defaults to + the~reference declared by~\ref{_map-set_/@name@}, + if~provided. \ref{_map_/@name@} takes precedence, even if + the~former is provided. Just like \texttt{case}~statements, + multiple inputs can be provided by specifying multiple references; + this means that each \ref{_map_/@name@} can differ.\footnote{This + isn't particularly intuitive or recommended, but it does simplify + certain tasks enough to maybe justify this type of use.} + + Just like \texttt{case}~statements themselves, maps are + surjective---the codomain implicitly includes $0$~to handle all + default cases, unless a default is provided. + + + + + + The default condition can be handled in two different ways: via + \ref{_map-set_/@default@}, or using \ref{_map-else_}; the latter + provides more flexibility and generally reads better. Both cannot + be used together. + + + + + diff --git a/core/numeric.xml b/core/numeric.xml new file mode 100644 index 00000000..2a50888e --- /dev/null +++ b/core/numeric.xml @@ -0,0 +1,33 @@ + + + + + + + + + + + + + diff --git a/core/numeric/boolean.xml b/core/numeric/boolean.xml new file mode 100644 index 00000000..b2ef7004 --- /dev/null +++ b/core/numeric/boolean.xml @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + diff --git a/core/numeric/common.xml b/core/numeric/common.xml new file mode 100644 index 00000000..4b8bdcf4 --- /dev/null +++ b/core/numeric/common.xml @@ -0,0 +1,162 @@ + + + + + + + + +
+ Due to the declarative nature of~TAME, recursive operations + needing to step are~not all that common. These operations are + useful when converting between 1-indexed and 0-indexed data. + + \ref{_inc_} increments a value by a~single step (default~1). + + + + + \ref{_dec_} decrements a value by a~single step (default~1). + + +
+ + + +
+ Negation is a common task and it was tedious in older versions of + TAME\footnote{Before it was even called TAME, actually.} For + these situations, \ref{NEGATE} is provided to avoid having to use + a~\ref{const} expression. To avoid a {\tt product} expression + altogether, use~\ref{_negate_}. + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ diff --git a/core/numeric/convert.xml b/core/numeric/convert.xml new file mode 100644 index 00000000..4ba5c62f --- /dev/null +++ b/core/numeric/convert.xml @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/numeric/minmax.xml b/core/numeric/minmax.xml new file mode 100644 index 00000000..aa6178fa --- /dev/null +++ b/core/numeric/minmax.xml @@ -0,0 +1,344 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/numeric/percent.xml b/core/numeric/percent.xml new file mode 100644 index 00000000..c1614220 --- /dev/null +++ b/core/numeric/percent.xml @@ -0,0 +1,367 @@ + + + + + + + + Converting between real and~percent is trivial: + + $$ + \begin{align} + r &= p\over100; + p &= 100r. + \end{align} + $$ + + ^[Percent difference] (also called ^[relative change]) describes + the~change in value as a~percentage (for example: $10$~is $50%$ + of~$20$, and is~$100%$ of~$5$). ^[Percent change] recognizes the + direction of the change (that is---$10$ is~$20$ reduced by~$50%$, so + $p=-50$). + + Since ``change'' sounds like a~verb eclarative contexts, we use + the~term ^[percent difference] to mean ^[relative change]; it is + defined as: + + $$\delta \over x = {{x_\beta - x_\alpha}\over{x_\alpha}} \times 100 = p.$$ + + Notice that this preserves the direction of the change. So, in the + context of the previous example, we can say that $10$ + \emph{reduces}~$20$ by~$50%$, giving~$p=-50%$. + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/numeric/round.xml b/core/numeric/round.xml new file mode 100644 index 00000000..319c683d --- /dev/null +++ b/core/numeric/round.xml @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/state.xml b/core/state.xml new file mode 100644 index 00000000..a7a5522c --- /dev/null +++ b/core/state.xml @@ -0,0 +1,195 @@ + + + + + + + + +
+ The type \ref{State} contains each of the States in the United~States, + with the addition of Washington~DC. + The States are 1-indexed and sorted by \emph{abbreviation}\footnote{ + States are sorted by abbreviation rather than the State name beacuse + they are most frequently referenced as such.}. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ For operations that involve taking values of all states where order + matters (e.g. for index alignment), + querying the symbol table isn't appropriate, + as it does not guarantee order. + \ref{_for-each-state_} can be used for that purpose; + it exposes the following template values to its body: + + \begin{enumerate} + \item \tt{@state_const@} contains the State constant; + \item \tt{@state_upper@} contains the uppercase two-letter State + abbreviation; + \item \tt{@state_lower@} contains the lowercase two-letter State + abbreviation; and + \item \tt{@state_name@} contains the full state name. + \end{enumerate} + + This can be used to generate a ^[State vector] by mapping an iteration + index to the State constant~\tt{@state_const@}. + Note that \ref{STATE_NONE} is not in the list. + + + + + To ease iteration though ^[State vector]s generated with + \ref{_for-each-state_}, + a 52~vector \ref{NVEC_STATE_ALL} and classification \ref{state-all} + are provided. + + + + + + +
+
diff --git a/core/states.xml b/core/states.xml new file mode 120000 index 00000000..35a1a26c --- /dev/null +++ b/core/states.xml @@ -0,0 +1 @@ +state.xml \ No newline at end of file diff --git a/core/symbol.xml b/core/symbol.xml new file mode 100644 index 00000000..bef7e17d --- /dev/null +++ b/core/symbol.xml @@ -0,0 +1,92 @@ + + + + + TAME provides powerful symbol table introspection features to assist + with metaprogramming. + This package provides templates to abstract some of those features and + make them easier to use. + + If introspecting on symbols that are defined within the same package, + be aware that the symbols may not be available until a future pass; + \tt{expand-sequence} may be helpful in that situation. + + + \ref{_if-symbol_} is a general-purpose template to conditionally expand a + body if a symbol matches a given predicate. + The predicates currently supported are \tt{type} and \tt{dim}. + If no predicate is provided, + then the body will be expanded if the symbol exists.\footnote{ + This is equivalent to \tt{type=""}.} + + + + + \ref{_if-defined_} is the same as \ref{_if-symbol_} with no predicates; + it provides more comfortable terminology for a common use case. + + + diff --git a/core/tdat.xml b/core/tdat.xml new file mode 100644 index 00000000..f9444204 --- /dev/null +++ b/core/tdat.xml @@ -0,0 +1,44 @@ + + + + + + + + + + diff --git a/core/test/core/aggregate.xml b/core/test/core/aggregate.xml new file mode 100644 index 00000000..f5e78607 --- /dev/null +++ b/core/test/core/aggregate.xml @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/insurance.xml b/core/test/core/insurance.xml new file mode 100644 index 00000000..cf052c2a --- /dev/null +++ b/core/test/core/insurance.xml @@ -0,0 +1,208 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/numeric/convert.xml b/core/test/core/numeric/convert.xml new file mode 100644 index 00000000..35998c0c --- /dev/null +++ b/core/test/core/numeric/convert.xml @@ -0,0 +1,209 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/numeric/percent.xml b/core/test/core/numeric/percent.xml new file mode 100644 index 00000000..6ea987db --- /dev/null +++ b/core/test/core/numeric/percent.xml @@ -0,0 +1,178 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + These tests are similar to the above, except that they represent + the~percent difference between two values. That is, given the + values $5$~and $15$, we arrive at a~$200%$ increase. So + if~$p=200$, then we want $5r=15, r=3=\((15-5)/5\)+1$. + + + + + + + + + + + + + + + + + Similarly, if we go from~$10$ to~$5$, we have~$p=-100$ + and~$10r=5$; then~$r=1/2=0.5$. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ref{_rtop_} provides a way to negate the result using a + short-hand form for convenience and conciseness. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/numeric/round.xml b/core/test/core/numeric/round.xml new file mode 100644 index 00000000..dc707781 --- /dev/null +++ b/core/test/core/numeric/round.xml @@ -0,0 +1,315 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/suite.xml b/core/test/core/suite.xml new file mode 100644 index 00000000..f64aed63 --- /dev/null +++ b/core/test/core/suite.xml @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/symbol.xml b/core/test/core/symbol.xml new file mode 100644 index 00000000..11347b00 --- /dev/null +++ b/core/test/core/symbol.xml @@ -0,0 +1,171 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/tplgen.xml b/core/test/core/tplgen.xml new file mode 100644 index 00000000..1eca4aa6 --- /dev/null +++ b/core/test/core/tplgen.xml @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/ui.xml b/core/test/core/ui.xml new file mode 100644 index 00000000..54d9e992 --- /dev/null +++ b/core/test/core/ui.xml @@ -0,0 +1,83 @@ + + + + + + + + + + + The UI package generator will produce classifications of the form + {\tt --vis-FIELD}, where {\tt FIELD} has all underscores converted + into dashes. Others aren't supposed to know that, of course. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/vector/fold.xml b/core/test/core/vector/fold.xml new file mode 100644 index 00000000..38264761 --- /dev/null +++ b/core/test/core/vector/fold.xml @@ -0,0 +1,115 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/vector/interpolate.xml b/core/test/core/vector/interpolate.xml new file mode 100644 index 00000000..91b5b2e3 --- /dev/null +++ b/core/test/core/vector/interpolate.xml @@ -0,0 +1,336 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/core/test/core/vector/length.xml b/core/test/core/vector/length.xml new file mode 100644 index 00000000..607d0eb6 --- /dev/null +++ b/core/test/core/vector/length.xml @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/core/vector/stub.xml b/core/test/core/vector/stub.xml new file mode 100644 index 00000000..0d9c5469 --- /dev/null +++ b/core/test/core/vector/stub.xml @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/test/spec.xml b/core/test/spec.xml new file mode 100644 index 00000000..abb029d4 --- /dev/null +++ b/core/test/spec.xml @@ -0,0 +1,355 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/tplgen.xml b/core/tplgen.xml new file mode 100644 index 00000000..ce0d699a --- /dev/null +++ b/core/tplgen.xml @@ -0,0 +1,77 @@ + + + + + + This package provides various templates for generating templates and + iterating using templates. + In essense, + this package is intended to abstract away certain implementation details + and complexities that make groking code more difficult; + they should be used when possible to improve code maintenance. + + +
+ \ref{_for-each-n_} recurisvely produces the body~\tt{@values@} given a + numeric range and step. + This can also be used to generate sequences at compile-time rather than + using functions, + provided that the sequence data are static. + + +
+
diff --git a/core/ui.xml b/core/ui.xml new file mode 100644 index 00000000..a2b45d20 --- /dev/null +++ b/core/ui.xml @@ -0,0 +1,93 @@ + + + + + + + + + + + This package provides elementary integration with the UI through + mystical knowledge of the naming conventions that the compiler uses + when generating the UI package. + + You should \emph{never} reference generated values yourself without + an abstraction. + + +
+ An object in the UI is considered to be \dfn{applicable} if the + predicate defined by its {\tt @when} attribute matches. These + predicates are generated, and should not be referenced directly; + instead, \ref{_match-ui-applicable_} should be used with the + question id. + + The term ``applicable'' is used instead of ``visible'' because + object can be hidden by other means; a predicate might be true + while a field is actually hidden. Further, a non-matching + predicate inhibits other behavior, like running of assertions. + + Note that this template will only be useful with an object + (question, display, static, etc) that has a predicate defined; + otherwise, compilation will fail. + + + + + \ref{_match-ui-set_} determines whether a UI field has a truthful value, + which is non-empty and non-zero. + + +
+
diff --git a/core/vector.xml b/core/vector.xml new file mode 100644 index 00000000..ab01b0c1 --- /dev/null +++ b/core/vector.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + diff --git a/core/vector/arithmetic.xml b/core/vector/arithmetic.xml new file mode 100644 index 00000000..99b84ef8 --- /dev/null +++ b/core/vector/arithmetic.xml @@ -0,0 +1,174 @@ + + + + + + + + + + + +
+ + + + + + + + \ref{_vproduct_} produces the product of two vectors: + $V_k = A_k B_k$. + + + + + \ref{_vproduct} is its helper function for recursion. + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ \ref{_mproduct_} produces the product of two matrices: + $M_{ij} = A_{ij} B_{ij}$. + + + + + \ref{_mproduct} is its helper function for recursion. + \ref{_vproduct_} is used to reduce the problem to the product of + and array of~vectors. + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ diff --git a/core/vector/cmatch.xml b/core/vector/cmatch.xml new file mode 100644 index 00000000..ff7c961c --- /dev/null +++ b/core/vector/cmatch.xml @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + In cases where a classification needs to be based on a result that + has been reduced to a scalar, \ref{_cmatch_to-scalar_} does not + solve the whole problem: for this, \ref{_classify-scalar_} may be + used. In addition to performing the action of the former (if {\tt + @yields} is provided), the resulting classification itself will + match on the scalar result. While this is not strictly + necessary---the predicate itself is already scalar---this is + important for systems or templates that derive the classification + result from the name of the classification. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ref{_vector-to-class_} converts a vector into a classification. + + + + diff --git a/core/vector/common.xml b/core/vector/common.xml new file mode 100644 index 00000000..4cb69e68 --- /dev/null +++ b/core/vector/common.xml @@ -0,0 +1,205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The template \ref{_repeat-value_} will generate a vector from the + given value for each class match. + + + + + + + + + + diff --git a/core/vector/convert.xml b/core/vector/convert.xml new file mode 100644 index 00000000..68d67a23 --- /dev/null +++ b/core/vector/convert.xml @@ -0,0 +1,26 @@ + + + + + + diff --git a/core/vector/count.xml b/core/vector/count.xml new file mode 100644 index 00000000..447624ce --- /dev/null +++ b/core/vector/count.xml @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/vector/filter.xml b/core/vector/filter.xml new file mode 100644 index 00000000..2b8f150e --- /dev/null +++ b/core/vector/filter.xml @@ -0,0 +1,540 @@ + + + + + + + + +
+ + + + + + + + + + +
+ + +
+ \ref{mfilter} handles complex filtering of matrices. + If the requested column~\tt{@col@} is marked as sequential with~\tt{@seq@}, + a~$O(lg n)$ bisect algorithm will be used; + otherwise, + it will undergo a~$O(n)$ linear scan. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Perform an~$O(lg n)$ bisect on a data set. + + This is intended to limit recursion on very large data sets (and + consequently will increase performance). + This will bisect up until a certain point (the gap), + unless it finds the value in question. + After finding the value, + it will perform an~$O(n)$ linear backward search to find the first + occurrence of the value. + If the value is not found, + it will halt at the gap and return the first index of the gap, + which we will consider its "best guess", + at which point a linear search can be performed by the caller to + determine if the value does in fact exist at all. + + (The reason this operates so oddly is because of its caller; + we could rid the gap and make this a general-purpose function if need be. + Technically, + the gap is useless and saves $lg g$ steps, + which may be very small.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
diff --git a/core/vector/fold.xml b/core/vector/fold.xml new file mode 100644 index 00000000..35821989 --- /dev/null +++ b/core/vector/fold.xml @@ -0,0 +1,131 @@ + + + + + + + + + The term ``fold'' is also referred to as ``reduce''---% + they are synonymous. + Unless otherwise specified, + folding occurs left-to-right. + + \emph{Unfolding} is the opposite of a reduction---% + it \emph{generates} values from existing values. + + +
+ \ref{_fold-matrix_} folds a matrix into a vector by summing each of + the~rows. + + +
+ + +
+ \ref{_unfold-vector-grouped_} generates a matrix from a vector---% + that is, it generates vectors within a vector---% + by grouping values. + + The \tt{@class@} is used both as a predicate and as a determination of + the resulting vector's length + (the~number of rows in the resulting matrix). + If non-matching, + no columns will be produced for that respective row. + + \tt{@src@} is the vector to be unfolded, + containing the raw values to be grouped. + + \tt{@grouping@} \should be the same length as~\ref{@src@} and determines + the group~(row) in which the respective value should appear. + + \ref{@generates@} names the resulting matrix and~\ref{@desc@} provides + its description. + + +
+
diff --git a/core/vector/interpolate.xml b/core/vector/interpolate.xml new file mode 100644 index 00000000..d12d6c3e --- /dev/null +++ b/core/vector/interpolate.xml @@ -0,0 +1,402 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/vector/length.xml b/core/vector/length.xml new file mode 100644 index 00000000..68637c9c --- /dev/null +++ b/core/vector/length.xml @@ -0,0 +1,137 @@ + + + + + + + + + See the respective test specification for examples. + + +
+ \ref{_first-nonempty_} will yield the result of the first toplevel + expression that is not an empty vector. + This template yields an empty vector if no non-empty vectors are found. + + + + + Its helper function is \ref{_first_nonempty}, + which recurses through each vector element until a non-empty vector is + encountered. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
diff --git a/core/vector/list.xml b/core/vector/list.xml new file mode 100644 index 00000000..eafbbdca --- /dev/null +++ b/core/vector/list.xml @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/vector/matrix.xml b/core/vector/matrix.xml new file mode 100644 index 00000000..894dd89b --- /dev/null +++ b/core/vector/matrix.xml @@ -0,0 +1,108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/vector/minmax.xml b/core/vector/minmax.xml new file mode 100644 index 00000000..5fa12395 --- /dev/null +++ b/core/vector/minmax.xml @@ -0,0 +1,236 @@ + + + + + + + + + +
+ Core currently only offers a~maximum reduction on + a~vector. \todo{Add a~minimum reduction.} \ref{_maxreduce_} + provides a convenient template-based abstraction. + + + + + \ref{maxreduce} is the~function encapsulated by the template and + may be applied directly. + + \todo{This function was originally written before TAME supported + let~expressions and other convenience templates. It has since + been refactored slightly, but can be made to be more concise.} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ref{_maxreduce} is a~helper function that recursively determines + the maximum value of the given set. It should not be invoked + directly; use \ref{maxreduce} or~\ref{_maxreduce_} instead. + + For example, given the vector~\vector{2,4,3,1}, here's the + recursive application: + + \begingroup + \def\max{\textrm{max}} + + \begin{equation} + \max( 1, \max( 3, max( 4, 2 ) ) ) + \\ \yield \max( 1, \max( 3, 4 ) ) + \\ \yield \max( 1, 4 ) + \\ \yield 4 + \end{equation} + \endgroup + + \todo{If we eventually support first-class functions, then this + can simply be a~generic reduce function that accepts max/min/etc.} + + \todo{This function was written before local variables generated + their own unique symbols; strip the prefixes.} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
diff --git a/core/vector/stub.xml b/core/vector/stub.xml new file mode 100644 index 00000000..718a14c3 --- /dev/null +++ b/core/vector/stub.xml @@ -0,0 +1,95 @@ + + + + + + + + + Stub vectors and classifications of various lengths---% + as well as the means of producing arbitrary lengths---% + are provided for convenience and testing. + + +
+ Ten n-vectors with each element containing the value~$0$ are + provided. + + + + + + +
+ Sequence n-vectors are of length~$n$ and have a sequence of values + from~$0$ to~$n-1$. + + + + +
+
+ + + +
+ Ten n-classes generated from the respective n-vectors are provided. + + + + + + +
+ + + +
+ \ref{_n-vector_} generates vector constants of length~$n$ where each + element is assigned the provided value (or~$0$ if unspecified). + + +
+
diff --git a/core/vector/table.xml b/core/vector/table.xml new file mode 100644 index 00000000..38dc0f7b --- /dev/null +++ b/core/vector/table.xml @@ -0,0 +1,494 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/core/when.xml b/core/when.xml new file mode 100644 index 00000000..a5a647e6 --- /dev/null +++ b/core/when.xml @@ -0,0 +1,76 @@ + + + + + + + + This package deals with matching in calculations (such as case statements + or values); + for classifications, see \tt{vector/cmatch}. + + + + + + + + + + + + + + + +