diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/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/Hjugement.hs b/Hjugement.hs new file mode 100644 --- /dev/null +++ b/Hjugement.hs @@ -0,0 +1,7 @@ +module Hjugement + ( module Hjugement.Majority + , IsList(..) + ) where + +import Hjugement.Majority +import GHC.Exts (IsList(..)) diff --git a/Hjugement/Majority.hs b/Hjugement/Majority.hs new file mode 100644 --- /dev/null +++ b/Hjugement/Majority.hs @@ -0,0 +1,223 @@ +{-# LANGUAGE TypeFamilies #-} +module Hjugement.Majority where + +import Data.Function (on) +import Data.List +import Data.Map.Strict (Map) +import Data.Maybe (fromMaybe) +import Data.Ord (Down(..)) +import Data.Semigroup (Semigroup(..)) +import Data.Set (Set) +import GHC.Exts (IsList(..)) +import qualified Data.Map.Strict as Map +import qualified Data.Set as Set + +-- * Type 'Choices' +type Choices prop = Set prop + +-- | Return a set of 'Choices' by enumerating the alternatives of its type. Useful on sum types. +choices :: (Bounded prop , Enum prop , Ord prop) => Choices prop +choices = Set.fromList (enumFrom minBound) + +-- * Type 'Scale' +data Scale grade + = Scale + { scaleGrades :: Set grade + -- ^ How many 'grade's should be used? + -- A greater number of 'grade's permits a finer distinction but demands + -- a higher degree of expertise and discernment. + -- The optimal number is the highest number of 'grade's that constitutes a common language, + -- that is, that allows 'judge's to make absolute judgments. + -- Too little 'grade's may lead too often to ties. + -- + -- Note, however, that if the inputs or grades depend on the set of choices, + -- i.e. if judges change their grades when choices are added or dropped, + -- then the Arrow paradox cannot be avoided. + -- To avoid this the scale must be fixed and absolute + -- so that more or fewer choices does not change + -- the inputs or messages of other choices. + , scaleDefault :: grade + -- ^ For instance, when a 'judge' gives no 'grade' or has “no opinion”, + -- 'scaleDefault' could mean that the 'judge' chooses “To Reject” the choice: + -- the rationale being that a 'judge' having “no opinion” + -- concerning a choice has not even taken the time to evaluate it + -- and thus has implicitly rejected it. + } deriving (Eq, Show) + +-- | Return a 'Scale' by enumerating the alternatives of its type. Useful on sum types. +scale :: (Bounded grade, Enum grade, Ord grade) => Scale grade +scale = Scale { scaleGrades = Set.fromList (enumFrom minBound) + , scaleDefault = toEnum 0 + } + +-- | Return a 'Scale' from a list of 'grade's and a default 'grade'. +-- Useful with 'grade's whose type has no 'Ord' instance +-- or a different one than the one wanted. +scaleOfList :: Eq a => [a] -> a -> Scale Int +scaleOfList gs dg = Scale is di + where + is = fromList $ findIndices (const True) gs + di = fromMaybe (error "default grade not in the scale") $ dg`elemIndex`gs + +gradeOfScale :: [a] -> Int -> a +gradeOfScale = (!!) + +-- * Type 'Jury' +type Jury judge = Set judge + +-- | Return a 'Jury' by enumerating the alternatives of its type. Useful on sum types. +jury :: (Bounded judge , Enum judge , Ord judge) => Jury judge +jury = Set.fromList (enumFrom minBound) + +-- * Type 'Opinion' +-- | Profile of opinions of one single 'judge' about some 'prop'ositions. +type Opinion prop grade = Map prop grade + +-- | Construct the 'Opinion' of a 'judge' about some 'prop'ositions implicit from their type. +opinion :: (Enum prop, Bounded prop, Ord prop) => + judge -> [grade] -> + (judge, Opinion prop grade) +opinion j gs = (j, Map.fromList (zip (enumFrom minBound) gs)) + +-- ** Type 'Opinions' +-- | Profile of opinions of some 'judge's about some 'prop'ositions. +newtype Opinions prop grade judge = Opinions (Map judge (Opinion prop grade)) + deriving (Eq, Show) +instance (Ord judge, Show judge) => IsList (Opinions prop grade judge) where + type Item (Opinions prop grade judge) = (judge, Opinion prop grade) + fromList = Opinions . Map.fromListWithKey + (\k _x _y -> error $ "duplicate opinion for judge: " <> show k) + toList (Opinions os) = toList os + +-- * Type 'Merit' +-- | Profile of merits about a choice. +newtype Merit grade = Merit (Map grade Count) + deriving (Eq, Show) +type Count = Int + +instance Ord grade => Semigroup (Merit grade) where + Merit x <> Merit y = Merit (Map.unionWith (+) x y) +instance Ord grade => Ord (Merit grade) where + compare = compare `on` majorityValue +instance (Ord grade, Show grade) => IsList (Merit grade) where + type Item (Merit grade) = (grade, Count) + fromList = Merit . Map.fromListWithKey + (\g _x _y -> error $ "duplicate grade in merit: " <> show g) + toList (Merit cs) = toList cs + +-- | @merit grad@ returns the 'Merit' +-- of a single 'choice' by some 'judge's. +merit :: (Ord grade, Ord prop) => + Scale grade -> prop -> Opinions prop grade judge -> + Merit grade +merit scal prop (Opinions os) = foldr insertOpinion defaultMerit os + where + insertOpinion op (Merit m) = Merit (Map.insertWith (+) g 1 m) + where g = Map.findWithDefault (scaleDefault scal) prop op + defaultMerit = Merit (const 0 `Map.fromSet` scaleGrades scal) + +-- ** Type 'Merits' +-- | Profile of merits about some choices. +newtype Merits prop grade = Merits (Map prop (Merit grade)) + deriving (Eq, Show) +instance (Ord grade, Ord prop) => Semigroup (Merits prop grade) where + Merits x <> Merits y = Merits (Map.unionWith (<>) x y) +instance (Ord prop, Show prop) => IsList (Merits prop grade) where + type Item (Merits prop grade) = (prop, Merit grade) + fromList = Merits . Map.fromListWithKey + (\p _x _y -> error $ "duplicate choice in merits: " <> show p) + toList (Merits cs) = toList cs + +-- | @merit scal props opins@ returns the 'Merits' +-- of the 'Choices' 'props' +-- as judged by the 'Opinions' 'opins' +-- on the 'Scale' 'scal'. +merits :: (Ord grade, Ord prop) => + Scale grade -> Choices prop -> Opinions prop grade judge -> + Merits prop grade +merits scal props (Opinions os) = foldr ((<>) . meritsFromOpinion) defaultMerits os + where + meritsFromOpinion = Merits . (Merit . (`Map.singleton` 1) <$>) . (<> defaultOpinion) + defaultOpinion = const (scaleDefault scal) `Map.fromSet` props + defaultMerits = Merits (const defaultMerit `Map.fromSet` props) + defaultMerit = Merit (const 0 `Map.fromSet` scaleGrades scal) + +-- * Type 'Value' +-- | A 'Value' is a compressed list of 'grade's, +-- where each 'grade' is associated with the 'Count' +-- by which it would be replicated in situ if decompressed. +newtype Value grade = Value [(grade,Count)] + deriving (Eq, Show) +-- | 'compare' lexicographically as if the 'Value's +-- were decompressed. +instance Ord grade => Ord (Value grade) where + Value []`compare`Value [] = EQ + Value []`compare`Value ys | all ((==0) . snd) ys = EQ + | otherwise = LT + Value xs`compare`Value [] | all ((==0) . snd) xs = EQ + | otherwise = GT + sx@(Value ((x,cx):xs)) `compare` sy@(Value ((y,cy):ys)) = + case cx`compare`cy of + _ | cx == 0 && cy == 0 -> Value xs`compare`Value ys + _ | cx <= 0 -> Value xs`compare`sy + _ | cy <= 0 -> sx`compare`Value ys + EQ -> x`compare`y <> Value xs`compare`Value ys + LT -> x`compare`y <> Value xs`compare`Value((y,cy-cx):ys) + GT -> x`compare`y <> Value((x,cx-cy):xs)`compare`Value ys + +-- | The 'majorityValue' is the list of the 'majorityGrade's +-- of a choice, each one replicated their associated 'Count' times, +-- from the most consensual to the least, +-- ie. by removing the 'grade' of the previous 'majorityGrade' +-- to compute the next. +majorityValue :: Ord grade => Merit grade -> Value grade +majorityValue (Merit m) = Value (go m) + where + go gs = case snd (Map.foldlWithKey untilMajGrade (0,[]) gs) of + [] -> [] + gw@(g,_):_ -> gw:go (Map.delete g gs) + where + tot = sum gs + untilMajGrade (t,[]) g c | 2*tc >= tot = (tc,[(g,c)]) + | otherwise = (tc,[]) + where tc = t+c + untilMajGrade acc _g _c = acc + +-- | The 'majorityGrade' is the lower middlemost +-- (also known as median by experts) of the 'grade's +-- given to a choice by the 'judge's. +-- +-- It is the highest 'grade' approved by an absolute majority of the 'judge's: +-- more than 50% of the 'judge's give the choice at least a 'grade' of 'majorityGrade', +-- but every 'grade' lower than 'majorityGrade' is rejected by an absolute majority +-- Thus the 'majorityGrade' of a choice +-- is the final 'grade' wished by the majority. +-- +-- The 'majorityGrade' is necessarily a word that belongs to 'grades', +-- and it has an absolute meaning. +-- +-- When the number of 'judge's is even, there is a middle-interval +-- (which can, of course, be reduced to a single 'grade' +-- if the two middle 'grade's are the same), +-- then the 'majorityGrade' is the lowest 'grade' of the middle-interval +-- (the “lower middlemost” when there are two in the middle), +-- which is the only one which respects consensus: +-- any other choice whose grades are all within this middle-interval, +-- has a 'majorityGrade' which is greater or equal to this lower middlemost. +majorityGrade :: Ord grade => Merit grade -> grade +majorityGrade m = fst (head gs) where Value gs = majorityValue m + +-- * Type 'Ranking' + +type Ranking prop = [prop] + +-- | The 'majorityRanking' ranks all the choices on the basis of their 'grade's. +-- +-- Choice A ranks higher than choice B in the 'majorityRanking' +-- if and only if A’s 'majorityValue' is lexicographically above B’s. +-- There can be no tie unless two choices have precisely the same 'majorityValue's. +majorityRanking :: Ord grade => Merits prop grade -> Ranking prop +majorityRanking = map fst . sortBy (compare `on` Down . snd) . majorityValueByChoice + +majorityValueByChoice :: Ord grade => Merits prop grade -> [(prop, Value grade)] +majorityValueByChoice (Merits ms) = Map.toAscList (majorityValue <$> ms) diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,123 @@ +# Majority Judgment + +## Common language + +The Majority Judgment asks us to judge each choice in an absolute way +(i.e. such that the removal or addition of choices +does not change our evaluation of the other choices) +by giving them a grade (or level) on a common scale. + +This common scale contains as many grades as our supposed common expertise +is able to distinguish, in order to faithfully represent +the properties of the attribute it tries to measure. +Hence, a common scale should be crafted for each different attribute. +The inter-subjective meaning of each grade +being reinforced by the practice of judgments. + +### Examples + +Examples of common scales could be: +- [“No”, “No, but”, “Yes, but”, “Yes”] for adhesion, +- [“None”, “Not Enough”, “Enough”, “Much”, “Too Much”] for quantity, +- [“To Do”, “Prioritized”, “Blocking”, “Urgent”, “Too Urgent”] for priority, +- [“Useless”, “Interesting”, “Useful”, “Indispensable”, “Enslaving”] for utility, +- [“To Reject”, “Insufficient”, “Acceptable”, “Good”, “Very Good”, “Too Good”] for quality. + +## Judging one choice + +For each choice taken separately, +the initial common scale (whose grades are all of equal length 1) +is dilated such that the length of each grade is multiplied +by the number of individual judgments of this grade obtained by this choice. +Like this, the only level which is defended by an absolute majority +begining from one side of the scale, +without being rejected by an absolute majority +beginning from the other side of the scale, +is the one which spans over the middle of this dilated scale. +This is the most consensual majority grade for this choice. + +If the number of individual judgments is small and even, +there is however a probability that two different grades +border the middle of this dilated scale, +but only the lower grade rewards consensus, +and thus is considered to be the most consensual. +Indeed, if any other choice obtains less scattered judgments +all enclosed to this two grades, +it will obtain a most consensual majoritary grade +greater or egal to the one of this choice. +Which would not necessarily be the case with the greater grade. + +## Ranking many choices + +To sort many choices means being able to compare them two-by-two, +which is done according to their most consensual majority grade. +In case of equality, the minimum individual judgments of this grade +are removed from both dilated scales so that one of them has no longer any, +then the comparison goes on with the new most consensual majority grades. +Like this, either a choice is judged higher than the other, +by the geatest number of judgments which differenciate them according +to a most consensual majoritary grade, +or both choices precisely have the same distribution of individual judgments. + +One can see that the farest an individual judgment is +from the most consensual majoritary grade, +the less impact it has on the result. +This rewards honest individual judgments, +by ignoring as near as may be the most cranky or strategic judgements. + +## Properties + +The Majority Judgment is: + +- allowing anonymity: + interchanging the names of judges does not change the outcome: + all judges are given an equal power. + +- neutral: + interchanging the names of choices does not change the outcome: + all choices are treated equally. + +- complete: + every choice is either superior or inferior + to any other choice, or both when equal. + Hence the Majority Judgement is not subject + to Condorcet's paradox. + +- monotone: + if a choice is superior or egal to another one, + and a judge increases its grade for it, + it becomes strictly superior. + +- transitive: + if a first choice is superior to a second one, + and this second one is superior to a third, + then the first is superior to the third). + +- coherent: + it is independent of irrelevant alternatives as formulated by Nash-Chernoff: + removal or addition of choices does not change + the judges’ evaluations of the other choices. + Hence the Majority Judgement is not subject + to Arrow's paradox. + +- strategy-proof-in-grading: + judging a choice higher or lower + than our intimate judgement has the opposite impact + on its most consensual majority grade. + +- partially strategy-proof-in-ranking: + increasing (resp. decreasing) the rank of a choice with respect to another choice, + can not decrease (resp. increase) the rank of this other choice. + +- not Condorcet-consistent except when the electorate is “polarized” + (when the higher (resp. the lower) a judge evaluates one choice the lower (resp. the higher) + she/he evaluates the other, so there can be no consensus) + hence when judges are most tempted to manipulate. + +- not excluding the no-show paradox (when it is better for a judge not to judge + than to express her/his opinion sincerely because her/his vote + can tip the scales against his favorite choice). + + This property is judged insignificant, by Michel Balinski and Rida Laraki, + when compared with the serious problems of methods of election, + the Arrow and Condorcet paradoxes and strategic manipulation. diff --git a/hjugement.cabal b/hjugement.cabal new file mode 100644 --- /dev/null +++ b/hjugement.cabal @@ -0,0 +1,72 @@ +author: Julien Moutinho +build-type: Simple +cabal-version: >= 1.18 +category: Language +description: + A library for the . + . + The Majority Judgment is + to be “superior to any known method of voting + and to any known method of judging competitions, + in theory and in practice”. + . + For introductory explanations, you can read: + the README.md (en) and/or + Marjolaine Leray's comic: (fr) + . + Or watch: Rida Laraki's conference: (fr) + . + For comprehensive studies, you can read Michel Balinski and Rida Laraki's: + . + * textbook: (en) + * cahier: (en) + * paper: (en) + * article: (fr) +extra-source-files: +extra-doc-files: README.md +extra-tmp-files: +license: GPL-3 +license-file: COPYING +maintainer: Julien Moutinho +name: hjugement +stability: experimental +synopsis: Majority Judgment. +tested-with: GHC==8.0.2 +version: 1.0.0.20170804 + +Source-Repository head + location: git://git.autogeree.net/hjugement + type: git + +Library + exposed-modules: + Hjugement + Hjugement.Majority + default-language: Haskell2010 + default-extensions: + ghc-options: -Wall -fno-warn-tabs + build-depends: + base >= 4.6 && < 5 + , containers > 0.5 + +Test-Suite hjugement-test + type: exitcode-stdio-1.0 + default-language: Haskell2010 + default-extensions: + ghc-options: -Wall -fno-warn-tabs + hs-source-dirs: test + main-is: Main.hs + other-modules: + HUnit + QuickCheck + Types + build-depends: + base >= 4.6 && < 5 + , containers >= 0.5 && < 0.6 + , hjugement + , QuickCheck >= 2.0 + , tasty >= 0.11 + , tasty-hunit + , tasty-quickcheck + , text + , transformers >= 0.4 && < 0.6 diff --git a/test/HUnit.hs b/test/HUnit.hs new file mode 100644 --- /dev/null +++ b/test/HUnit.hs @@ -0,0 +1,180 @@ +{-# LANGUAGE OverloadedLists #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +module HUnit where + +import Test.Tasty +import Test.Tasty.HUnit + +import Control.Arrow (second) +import qualified Data.Map.Strict as Map + +import Hjugement +import Types + +hunits :: TestTree +hunits = + testGroup "HUnit" + [ testGroup "Value" $ + [ testCompareValue + [(3,15), (2,7), (1,3), (0::Int,2)] + [(3,16), (2,6), (1,2), (0,3)] + , testGroup "OfMerits" + [ let m = mkMerit ['A'..'F'] in + testValueOfMerits + [ (The, m [136,307,251,148,84,74]) + ] + [ (The, [('C',251),('B',307),('D',148),('E',84),('A',136),('F',74)]) + ] + , let m = mkMerit [ToReject .. TooGood] in + testValueOfMerits + [ (This, m [12,10,21,5,5,5,2]) + , (That, m [12,16,22,3,3,3,1]) + ] + [ (This, [(Acceptable,21),(Insufficient,10),(Good,5),(ToReject,12),(Perfect,5),(VeryGood,5),(TooGood,2)]) + , (That, [(Acceptable,22),(Insufficient,16),(ToReject,12),(VeryGood,3),(Perfect,3),(Good,3),(TooGood,1)]) + ] + ] + , testGroup "OfOpinions" + [ testValueOfOpinions [No,Yes] + [The] + [ [No ] + , [No ] + , [No ] + , [No ] + , [Yes] + , [Yes] + ] + [ (The, [(No,4),(Yes,2)]) + ] + , testValueOfOpinions [No,Yes] + [The] + [ [No ] + , [No ] + , [No ] + , [Yes] + , [Yes] + , [Yes] + ] + [ (The, [(No,3),(Yes,3)]) + ] + , testValueOfOpinions [No,Yes] + [This, That] + [ [No , No ] + , [No , Yes] + , [No , Yes] + , [No , Yes] + , [Yes , Yes] + , [Yes , Yes] + ] + [ (This, [(No,4),(Yes,2)]) + , (That, [(Yes,5),(No,1)]) + ] + , testValueOfOpinions [No,Yes] + [This, That] + [ [No , No ] + , [No , No ] + , [No , No ] + , [No , Yes] + , [No , Yes] + , [No , Yes] + ] + [ (This, [(No,6),(Yes,0)]) + , (That, [(No,3),(Yes,3)]) + ] + , testValueOfOpinions [No,Yes] + [This, That] + [ [Yes , No ] + , [Yes , No ] + , [Yes , No ] + , [Yes , Yes] + , [Yes , Yes] + , [Yes , Yes] + ] + [ (This, [(Yes,6),(No,0)]) + , (That, [(No,3),(Yes,3)]) + ] + , testValueOfOpinions [No,Yes] + [This, That] + [ [No , No ] + , [No , No ] + , [Yes , No ] + , [Yes , Yes] + , [Yes , Yes] + , [Yes , Yes] + ] + [ (This, [(Yes,4),(No,2)]) + , (That, [(No,3),(Yes,3)]) + ] + , testValueOfOpinions [ToReject,Insufficient,Acceptable,Good,VeryGood,Perfect] + [1::Int ..6] + [ [Perfect,Perfect,Acceptable,VeryGood,Good,VeryGood] + , [Perfect,VeryGood,Perfect,Good,Acceptable,Acceptable] + , [VeryGood,VeryGood,Good,Acceptable,VeryGood,Insufficient] + , [Perfect,VeryGood,VeryGood,Good,Good,Acceptable] + , [Perfect,Good,VeryGood,Good,Good,Acceptable] + , [Perfect,VeryGood,Perfect,Good,Good,Good] + ] + [ (1, [(Perfect,5),(VeryGood,1),(ToReject,0),(Insufficient,0),(Acceptable,0),(Good,0)]) + , (2, [(VeryGood,4),(Good,1),(Perfect,1),(ToReject,0),(Insufficient,0),(Acceptable,0)]) + , (3, [(VeryGood,2),(Good,1),(Perfect,2),(Acceptable,1),(ToReject,0),(Insufficient,0)]) + , (4, [(Good,4),(Acceptable,1),(VeryGood,1),(ToReject,0),(Insufficient,0),(Perfect,0)]) + , (5, [(Good,4),(Acceptable,1),(VeryGood,1),(ToReject,0),(Insufficient,0),(Perfect,0)]) + , (6, [(Acceptable,3),(Good,1),(Insufficient,1),(VeryGood,1),(ToReject,0),(Perfect,0)]) + ] + ] + ] + ] + + +elide :: String -> String +elide s | length s > 42 = take 42 s ++ ['…'] + | otherwise = s + +mkOpinion :: Ord prop => + Choices prop -> judge -> [grade] -> + (judge, Opinion prop grade) +mkOpinion props j gs = (j, Map.fromList $ toList props `zip` gs) + +mkMerit :: (Ord grade, Show grade) => [grade] -> [Count] -> Merit grade +mkMerit scal = fromList . (scal`zip`) + +mkMerits :: (Ord prop, Ord grade) => + [grade] -> Choices prop -> [[grade]] -> + Merits prop grade +mkMerits scal props opins = + merits (Scale (fromList scal) (head scal)) props $ fromList $ + zipWith (mkOpinion props) [1::Int ..] opins + + +testCompareValue :: (Ord grade, Show grade) => + [(grade, Count)] -> [(grade, Count)] -> TestTree +testCompareValue x y = + testGroup (elide $ show (x,y)) + [ testCase "x == x" $ Value x`compare`Value x @?= EQ + , testCase "y == y" $ Value y`compare`Value y @?= EQ + , testCase "x < y" $ Value x`compare`Value y @?= LT + , testCase "y > x" $ Value y`compare`Value x @?= GT + ] + +testRanking :: (Ord prop, Ord grade, Show grade, Show prop) => + [grade] -> Choices prop -> [[grade]] -> + Ranking prop -> TestTree +testRanking scal props opins expect = + testCase (elide $ show (toList props,opins)) $ + majorityRanking (mkMerits scal props opins) @?= expect + +testValueOfOpinions :: (Show grade, Show prop, Ord grade, Ord prop) => + [grade] -> Choices prop -> [[grade]] -> + [(prop, [(grade,Count)])] -> TestTree +testValueOfOpinions scal props opins expect = + testCase (elide $ show (toList props,opins)) $ + majorityValueByChoice (mkMerits scal props opins) + @?= ((Value`second`)<$>expect) + +testValueOfMerits :: (Show grade, Show prop, Ord grade, Ord prop) => + Merits prop grade -> + [(prop, [(grade,Count)])] -> TestTree +testValueOfMerits ms expect = + testCase (elide $ show ms) $ + majorityValueByChoice ms + @?= ((Value`second`)<$>expect) diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,13 @@ +module Main where + +import Test.Tasty +import QuickCheck +import HUnit + +main :: IO () +main = + defaultMain $ + testGroup "Hjugement" + [ hunits + , quickchecks + ] diff --git a/test/QuickCheck.hs b/test/QuickCheck.hs new file mode 100644 --- /dev/null +++ b/test/QuickCheck.hs @@ -0,0 +1,134 @@ +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +module QuickCheck where + +import Test.QuickCheck +import Test.Tasty +import Test.Tasty.QuickCheck + +import Control.Monad (replicateM) +import qualified Data.Set as Set + +import Hjugement +import Types + +quickchecks :: TestTree +quickchecks = + testGroup "QuickCheck" + [ testProperty "arbitraryJudgments" $ \(SameLength (x::[(G6,Count)],y)) -> + let (gx, cx) = unzip x in + let (gy, cy) = unzip y in + gx == gy && sum cx == sum cy + , testGroup "Value" + [ testProperty "compare" $ \(SameLength (x::Value G6,y)) -> + expandValue x`compare` expandValue y == x`compare`y + ] + {- + , testProperty "majorityGauge and majorityValue consistency" $ + \(SameLength (x@(Merit xs)::Merit G6,y@(Merit ys))) -> + not (all (==0) xs || all (==0) ys) ==> + case majorityGauge x`compare`majorityGauge y of + LT -> majorityValue x < majorityValue y + GT -> majorityValue x > majorityValue y + EQ -> True + -} + ] + +-- | Decompress a 'Value'. +expandValue :: Value a -> [a] +expandValue (Value []) = [] +expandValue (Value ((x,c):xs)) = replicate c x ++ expandValue (Value xs) + +-- | @arbitraryJudgments n@ arbitrarily generates 'n' lists of pairs of grade and 'Count' +-- for the same arbitrary grades, +-- and with the same total 'Count' of individual judgments. +arbitraryJudgments :: forall g. (Bounded g, Enum g) => Int -> Gen [[(g, Count)]] +arbitraryJudgments n = sized $ \s -> do + minG <- choose (fromEnum(minBound::g), fromEnum(maxBound::g)) + maxG <- choose (minG, fromEnum(maxBound::g)) + let gs::[g] = toEnum minG`enumFromTo`toEnum maxG + let lg = maxG - minG + 1 + replicateM n $ do + cs <- resize s $ arbitrarySizedNaturalSum lg + cs' <- arbitraryPad (lg - length cs) (return 0) cs + return $ zip gs cs' + +-- | @arbitrarySizedNaturalSum maxLen@ +-- arbitrarily chooses a list of 'length' at most 'maxLen', +-- containing 'Int's summing up to 'sized'. +arbitrarySizedNaturalSum :: Int -> Gen [Int] +arbitrarySizedNaturalSum maxLen = sized (go maxLen) + where + go :: Int -> Int -> Gen [Int] + go len tot | len <= 0 = return [] + | len == 1 = return [tot] + | tot <= 0 = return [tot] + go len tot = do + d <- choose (0, tot) + (d:) <$> go (len-1) (tot - d) + +-- | @arbitraryPad n pad xs@ +-- arbitrarily grows list 'xs' with 'pad' elements +-- up to length 'n'. +arbitraryPad :: Int -> Gen a -> [a] -> Gen [a] +arbitraryPad n pad [] = replicateM n pad +arbitraryPad n pad xs = do + (r, xs') <- go n xs + if r > 0 + then arbitraryPad r pad xs' + else return xs' + where + go r xs' | r <= 0 = return (0,xs') + go r [] = arbitrary >>= \b -> + if b then pad >>= \p -> ((p:)<$>) <$> go (r-1) [] + else return (r,[]) + go r (x:xs') = arbitrary >>= \b -> + if b then pad >>= \p -> (([p,x]++)<$>) <$> go (r-1) xs' + else ((x:)<$>) <$> go r xs' + +-- | Like 'nub', but O(n * log n). +nubList :: Ord a => [a] -> [a] +nubList = go Set.empty where + go _ [] = [] + go s (x:xs) | x`Set.member`s = go s xs + | otherwise = x:go (Set.insert x s) xs + +instance Arbitrary G6 where + arbitrary = arbitraryBoundedEnum +instance (Arbitrary g, Bounded g, Enum g, Ord g, Show g) => Arbitrary (Merit g) where + arbitrary = fromList . head <$> arbitraryJudgments 1 + shrink (Merit m) = Merit <$> shrink m +instance + ( Arbitrary p, Bounded p, Enum p, Ord p, Show p + , Arbitrary g, Bounded g, Enum g, Ord g, Show g + ) => Arbitrary (Merits p g) where + arbitrary = do + minP <- choose (fromEnum(minBound::p), fromEnum(maxBound::p)) + maxP <- choose (minP, fromEnum(maxBound::p)) + let ps = toEnum minP`enumFromTo`toEnum maxP + let ms = (fromList <$>) <$> arbitraryJudgments (maxP - minP + 1) + fromList . zip ps <$> ms +instance (Bounded g, Eq g, Integral g, Arbitrary g) => Arbitrary (Value g) where + arbitrary = head . (Value <$>) <$> arbitraryJudgments 1 + shrink (Value vs) = Value <$> shrink vs + +-- * Type 'SameLength' +newtype SameLength a = SameLength a + deriving (Eq, Show) +instance Functor SameLength where + fmap f (SameLength x) = SameLength (f x) +instance (Arbitrary g, Bounded g, Enum g) => Arbitrary (SameLength (Value g, Value g)) where + arbitrary = do + SameLength (x,y) <- arbitrary + return $ SameLength (Value x, Value y) +instance (Arbitrary g, Bounded g, Enum g, Ord g, Show g) => Arbitrary (SameLength (Merit g, Merit g)) where + arbitrary = do + SameLength (x,y) <- arbitrary + return $ SameLength (fromList x, fromList y) +instance (Arbitrary g, Bounded g, Enum g) => Arbitrary (SameLength ([(g,Count)], [(g,Count)])) where + arbitrary = do + vs <- arbitraryJudgments 2 + case vs of + [x,y] -> return $ SameLength (x,y) + _ -> undefined diff --git a/test/Types.hs b/test/Types.hs new file mode 100644 --- /dev/null +++ b/test/Types.hs @@ -0,0 +1,27 @@ +module Types where + +data G2 = No | Yes + deriving (Eq, Ord, Show) + +data P1 = The + deriving (Eq, Ord, Show) + +data P2 = This | That + deriving (Eq, Ord, Show) + +data G6 = ToReject | Insufficient | Acceptable | Good | VeryGood | Perfect | TooGood + deriving (Bounded, Enum, Eq, Ord, Show) + +-- | Note that the grades 1, 2, 4, and 12 are absent. +data DanishSchoolGrade + = D0 -- ^ the completely unacceptable performance + | D3 -- ^ the very hesitant, very insufficient, and unsatisfactory performance + | D5 -- ^ the hesitant and not satisfactory performance + | D6 -- ^ the just acceptable performance + | D7 -- ^ the mediocre performance, slightly below average + | D8 -- ^ the average performance + | D9 -- ^ the good performance, a little above average + | D10 -- ^ the excellent but not particularly independent performance + | D11 -- ^ the independent and excellent performance + | D13 -- ^ the exceptionally independent and excellent performance + deriving (Bounded, Enum, Eq, Ord, Show)