diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/hahp-example/Main.hs b/hahp-example/Main.hs new file mode 100644 --- /dev/null +++ b/hahp-example/Main.hs @@ -0,0 +1,32 @@ +module Main where + +import Data.Time +import HAHP.Algorithm +import HAHP.Data +import HAHP.Reporting +import HAHP.Sample.Config1 +import HAHP.Sample.Config2 +import HAHP.Sample.Config3 +import HAHP.Sample.CarChoice +import HAHP.Sample.LeaderChoice +import HAHP.Sample.SquareMatrixError + +main :: IO () +main = do + let title = "HAHP library testing" + author = "Jean-Pierre Prunaret, Yves Dubromelle" + inputDataSets = [ --(sampleAHPConfig1, sampleAlternatives1) + --, (sampleAHPConfig2, sampleAlternatives2) + --, (sampleAHPConfig3, sampleAlternatives3) + --, (smeConfig, smeAlternatives) + (leaderChoiceTree, leaderChoiceAlternatives) + , (carChoiceTree, carChoiceAlternatives) + ] + + time <- getCurrentTime + putStrLn $ reportHeader title author time + putStrLn "" + mapM_ (putStrLn . simpleAHPSummary) inputDataSets + +simpleAHPSummary :: (AHPTree, [Alternative]) -> String +simpleAHPSummary (ahpTree, alts) = simpleSummary $ simpleAHP ahpTree alts diff --git a/hahp.cabal b/hahp.cabal new file mode 100644 --- /dev/null +++ b/hahp.cabal @@ -0,0 +1,51 @@ +-- Initial HAHP.cabal generated by cabal init. For further documentation, +-- see http://haskell.org/cabal/users-guide/ + +name: hahp +version: 0.1.0 +synopsis: Analytic Hierarchy Process +description: Analytic Hierarchy Process implementation. +license: AGPL-3 +license-file: LICENSE +author: Yves Dubromelle +maintainer: yves+hackage@dubronetwork.fr +-- copyright: +category: Math +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/Taeradan/hahp + +library + -- other-modules: + -- other-extensions: + build-depends: base >=4.7 && <5 , containers, hmatrix, parallel, time + hs-source-dirs: src + default-language: Haskell2010 + exposed-modules: + HAHP.Algorithm + HAHP.Algorithm.Consistency + HAHP.Algorithm.PriorityVector + HAHP.Algorithm.Ranking + HAHP.Data + HAHP.Reporting + HAHP.Sample.Config1 + HAHP.Sample.Config2 + HAHP.Sample.Config3 + HAHP.Sample.CarChoice + HAHP.Sample.LeaderChoice + HAHP.Sample.SquareMatrixError + HAHP.Validation.Alternatives + HAHP.Validation.Tree + +executable hahp-example + main-is: Main.hs + -- other-modules: + -- other-extensions: + build-depends: base >=4.7 && <5, hahp, time + hs-source-dirs: hahp-example + default-language: Haskell2010 + ghc-options: -rtsopts -eventlog -threaded diff --git a/src/HAHP/Algorithm.hs b/src/HAHP/Algorithm.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Algorithm.hs @@ -0,0 +1,62 @@ +module HAHP.Algorithm where + +import Data.List +import Data.Maybe +import Data.Ord (comparing) +import HAHP.Algorithm.Consistency +import HAHP.Algorithm.PriorityVector +import HAHP.Algorithm.Ranking +import HAHP.Data +import HAHP.Validation.Alternatives +import HAHP.Validation.Tree +import Numeric.LinearAlgebra.HMatrix + +-- |This function is a quick way to rank a set of alternatives with AHP algorithm. +-- This function call everithing required to configure an execute AHP process. +-- If something goes wrong, an error is raised. +simpleAHP :: AHPTree + -> [Alternative] + -> (AHPTree, [Alternative], [TreeError], [AlternativesError]) +simpleAHP ahpTree alts = + if null inputTreeErrors && null altsErrors + then (completeTree, ranking, treeErrors, []) + else (ahpTree, alts, inputTreeErrors ++ treeErrors, altsErrors) + where initializedTree = initAHP ahpTree + (completeTree, ranking) = rankAlternatives initializedTree alts + --- + inputTreeErrors = validateInputAHPTree ahpTree + altsErrors = validateAlternatives ahpTree alts + treeErrors = if null inputTreeErrors + then validateAHPTree initializedTree + else [] + +-- * Part 1 = static part + +initAHP :: AHPTree + -> AHPTree +initAHP ahpTree = computeTreePriorityVectors . computeTreeConsistencies $ ahpTree + +-- * Part 2 = dynamic part + +rankAlternatives :: AHPTree + -> [Alternative] + -> (AHPTree, [Alternative]) +rankAlternatives ahpTree alts = (rankedAhpTree, reverse sortedRankedAlternatives) + where ranks = concat . toLists . fromJust $ alternativesPriority rankedAhpTree + rankedAhpTree = computeTreeAlternativesPriorities alts ahpTree + sortedRankedAlternatives = map fst . sortOn' snd $ zip alts ranks + +-- | Sort a list by comparing the results of a key function applied to each +-- element. @sortOn f@ is equivalent to @sortBy . comparing f@, but has the +-- performance advantage of only evaluating @f@ once for each element in the +-- input list. This is called the decorate-sort-undecorate paradigm, or +-- Schwartzian transform. +-- see https://hackage.haskell.org/package/base-4.8.1.0/docs/src/Data.OldList.html#sortOn +-- +-- TODO : Remote this function and use default haskell sortOn. +-- Note: Compilation issues on mac. sortOn is not provided. +-- +-- @since 4.8.0.0 +sortOn' :: Ord b => (a -> b) -> [a] -> [a] +sortOn' f = + map snd . sortBy (comparing fst) . map (\x -> let y = f x in y `seq` (y, x)) diff --git a/src/HAHP/Algorithm/Consistency.hs b/src/HAHP/Algorithm/Consistency.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Algorithm/Consistency.hs @@ -0,0 +1,50 @@ +module HAHP.Algorithm.Consistency + ( + computeTreeConsistencies + ) where + +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +-- trick : http://stackoverflow.com/a/7897595 +-- trick2 : https://wiki.haskell.org/Default_values_in_records +computeTreeConsistencies :: AHPTree -> AHPTree +computeTreeConsistencies ahpTree = + case ahpTree of + (AHPTree _ prefMat _ _ _ children) -> ahpTree + { consistencyValue = Just $ matrixConsistency prefMat + , children = map computeTreeConsistencies children + } + AHPLeaf {} -> ahpTree + +-- |A matrix with consistency=0 is consistent. +matrixConsistency :: PairwiseMatrix -> Double +matrixConsistency prefMat + | matrixSize <= 2 = 0 + | otherwise = consistencyIndicator / randomIndexValue + where randomIndexValue = randomIndex matrixSize + consistencyIndicator = (lambdaMax - matrixSize) / (matrixSize - 1) + lambdaMax = maxEigenValue prefMat + matrixSize = fromIntegral . rows $ prefMat + +maxEigenValue :: PairwiseMatrix -> Double +maxEigenValue prefMat = realPart . maxElement . eigenvalues $ prefMat + +randomIndex :: Double -> Double +randomIndex size + | size <= 15 = randomIndexSaaty size + | otherwise = randomIndexCalculated size + +randomIndexSaaty :: Double -> Double +randomIndexSaaty matrixSize = saatyTable !! (round matrixSize - 1) + where saatyTable = [0.00, 0.00, 0.58, 0.90, 1.12, 1.24, 1.32, 1.41, 1.45, 1.49, 1.51, 1.48, 1.56, 1.57, 1.59] + +-- |Random Index estimation function taken from : +-- "Consistency in the AHP : A new approach" +-- José Antonio ALONSO and Teresa LAMATA, +-- IJUFKBS 2006 +randomIndexCalculated :: Double -> Double +randomIndexCalculated matrixSize = ( 0.00149 * (matrixSize^3)) + + (- 0.05121) * (matrixSize^2) + + ( 0.59150 * matrixSize) + + (- 0.79124) diff --git a/src/HAHP/Algorithm/PriorityVector.hs b/src/HAHP/Algorithm/PriorityVector.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Algorithm/PriorityVector.hs @@ -0,0 +1,42 @@ +module HAHP.Algorithm.PriorityVector + ( + computeTreePriorityVectors, + priorityVector + ) where + +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +computeTreePriorityVectors :: AHPTree -> AHPTree +computeTreePriorityVectors ahpTree = + case ahpTree of + (AHPTree _ prefMat _ _ _ children) -> ahpTree + { childrenPriority = Just $ priorityVector prefMat + , children = map computeTreePriorityVectors children + } + AHPLeaf {} -> ahpTree + +priorityVector :: PairwiseMatrix -> PriorityVector +priorityVector prefMat = + priorityVectorRefining prefMat prefMat (priorityVectorBase prefMat) + +priorityVectorRefining :: PairwiseMatrix -> PairwiseMatrix -> PriorityVector -> PriorityVector +priorityVectorRefining origPrefMat powPrefMat oldPrioVect = + if compareMatrixItems newPrioVect oldPrioVect threshold + then newPrioVect + else priorityVectorRefining origPrefMat (powPrefMat <> origPrefMat) newPrioVect + where newPrioVect = priorityVectorBase powPrefMat + threshold = 1.11e-16 + +compareMatrixItems :: Matrix Double -> Matrix Double -> Double -> Bool +compareMatrixItems matrixA matrixB threshold = + all (\(x,y) -> abs(x - y) < threshold ) list + where list = zip (toList . flatten $ matrixA) (toList . flatten $ matrixB) + +priorityVectorBase :: PairwiseMatrix -> PriorityVector +priorityVectorBase prefMat = numerator <> inv denominator + where numerator = prefMat <> eT + denominator = e <> prefMat <> eT + e = (1 >< matrixSize )[1, 1..] + eT = (matrixSize >< 1 )[1, 1..] + matrixSize = fromIntegral . rows $ prefMat diff --git a/src/HAHP/Algorithm/Ranking.hs b/src/HAHP/Algorithm/Ranking.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Algorithm/Ranking.hs @@ -0,0 +1,61 @@ +module HAHP.Algorithm.Ranking where + +import Data.List +import qualified Data.Map as M +import Data.Maybe +import Debug.Trace +import HAHP.Algorithm.PriorityVector +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +computeTreeAlternativesPriorities :: [Alternative] -> AHPTree -> AHPTree +computeTreeAlternativesPriorities alts ahpTree = + case ahpTree of + AHPTree {} -> agregateTreeAlternativesPriorities . computeChildrenTreeAlternativesPriorities alts $ ahpTree + AHPLeaf {} -> ahpTree + { alternativesPriority = Just $ computeAlternativesPriority ahpTree alts + } + +-- * Helper function. + +agregateTreeAlternativesPriorities :: AHPTree -> AHPTree +agregateTreeAlternativesPriorities ahpTree = ahpTree { + alternativesPriority = Just . agregatePriorities $ ahpTree + } + +computeChildrenTreeAlternativesPriorities :: [Alternative] -> AHPTree -> AHPTree +computeChildrenTreeAlternativesPriorities alts ahpTree = ahpTree { + children = map (computeTreeAlternativesPriorities alts) (children ahpTree) + } + +-- * Computation function + +agregatePriorities :: AHPTree -> PriorityVector +agregatePriorities ahpTree = catChildVectors <> childPriorities + where childVectors = map (fromJust . alternativesPriority) (children ahpTree) + catChildVectors = foldl1 (|||) childVectors + childPriorities = fromJust . childrenPriority $ ahpTree + +computeAlternativesPriority :: AHPTree -> [Alternative] -> PriorityVector +computeAlternativesPriority ahpTree alts = result + where pairwiseAlternatives = buildAlternativePairwiseMatrix ahpTree alts + result = priorityVector pairwiseAlternatives + +buildAlternativePairwiseMatrix :: AHPTree -> [Alternative] -> Matrix Double +buildAlternativePairwiseMatrix ahpTree alts = (length alts >< length alts) matrix + where vals = map (selectIndValue (name ahpTree)) alts + cartesianProduct = [(x, y) | x <- vals, y <- vals] + matrix = map operator cartesianProduct + operator = if maximize ahpTree + -- `uncurry` permit the use of an operator on a pair + then uncurry (/) + -- `flip` revert the arguments + else uncurry (flip (/)) + +-- * Extract data from data stuctures + +selectIndValue :: IndicatorName -> Alternative -> Double +selectIndValue name alt = selectIndValue' name (M.toList . indValues $ alt) + +selectIndValue' :: IndicatorName -> [(IndicatorName, Double)] -> Double +selectIndValue' name values = fromJust (lookup name values) diff --git a/src/HAHP/Data.hs b/src/HAHP/Data.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Data.hs @@ -0,0 +1,76 @@ +module HAHP.Data where + +import Data.Map (Map) +import Numeric.LinearAlgebra.HMatrix + +-- * AHP tree definition + +data AHPTree = AHPTree { name :: String + , preferenceMatrix :: PairwiseMatrix + , consistencyValue :: Maybe Double + , childrenPriority :: Maybe PriorityVector + , alternativesPriority :: Maybe PriorityVector + , children :: [AHPTree] + } + | AHPLeaf { name :: IndicatorName + , maximize :: Bool + , alternativesPriority :: Maybe PriorityVector + } + deriving (Show) + +type IndicatorName = String + +type PairwiseMatrix = Matrix Double + +type PriorityVector = Matrix Double + +-- * Alternatives definition + +data Alternative = Alternative { altName :: String + , indValues :: IndicatorValues + } + deriving (Show) + +type IndicatorValues = Map IndicatorName Double + +-- * Errors definition + +data TreeError = ConsistencyError { ahpTree :: AHPTree + , consistencyThreshold :: Double + , consistency :: Double + } + | ChildrenUnicityError { ahpTree :: AHPTree + , repeatedChildrenNames :: [String] + } + | InverseError { ahpTree :: AHPTree } + | LeavesUnicityError { ahpTree :: AHPTree + , repeatedLeavesNames :: [String] + } + | NotComputedConsistencyError { ahpTree :: AHPTree} + | NotUnitaryDiagError { ahpTree :: AHPTree } + | NullDivisionError { ahpTree :: AHPTree} + | ParentChildrenSizeMismatchError {ahpTree :: AHPTree + , errorParentSize :: Int + , errorChildrenSize :: Int + } + | PositivePreferenceError { ahpTree :: AHPTree + } + | SquareMatrixError { ahpTree :: AHPTree + , errorRows :: Int + , errorCols :: Int + } + deriving (Show) + +data AlternativesError = NoAlternativesError {} + | AlternativesUnicityError {repeatedAlternativesNames :: [String]} + | IndicatorsValuesExistenceError { indValuesErrors :: [(Alternative, String)] } + deriving (Show) + +-- * Data retrieve functions + +getTreeLeaves :: AHPTree -- ^ Input tree + -> [AHPTree] -- ^ List of the leaves +getTreeLeaves ahpTree = + case ahpTree of + AHPTree {} -> concatMap getTreeLeaves (children ahpTree) + AHPLeaf {} -> [ahpTree] diff --git a/src/HAHP/Reporting.hs b/src/HAHP/Reporting.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Reporting.hs @@ -0,0 +1,207 @@ +module HAHP.Reporting where + +import Data.List +import qualified Data.Map as M +import Data.Time +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix +import Text.Printf + +-- * Report making + +-- | Given a title, an author and a timestamp, builds a Pandoc Markdown document header +reportHeader :: String -- ^ Report title + -> String -- ^ Report author + -> UTCTime -- ^ Report timestamp + -> String -- ^ Report header +reportHeader title author time = unlines + [ "% " ++ title + , "% " ++ author + , "% " ++ showGregorian(utctDay time) + ] + +-- | Print a simple report about an AHP tree and ranking result +simpleSummary :: (AHPTree, [Alternative], [TreeError], [AlternativesError]) -- ^ AHP tree, some alternatives and the result of tree validation + -> String -- ^ Report build from input +simpleSummary (ahpTree, alts, treeErrors, altsErrors) = treeSummary ++ altSummary ++ errorSummary ++ "\\newpage \n" + where treeSummary = showConfiguration ahpTree + altSummary = showAlternatives alts + errorSummary = showErrors treeErrors altsErrors + +-- | Print an AHP tree and some additional information about it +showConfiguration :: AHPTree -- ^ AHP tree + -> String -- ^ Report about the AHP tree +showConfiguration ahpTree = unlines $ + [ "# Configuration \"" ++ name ahpTree ++ "\"" + , "" + , "## AHP tree preview" + , "" + ] + ++ + lines (showAhpTree ahpTree) + +-- * Errors + +showErrors :: [TreeError] -- ^ List of errors + -> [AlternativesError] -- ^ List of errors + -> String -- ^ Report errors +showErrors treeErrors altsErrors = unlines $ + [ "" + , "## Input data validation" + , "" + , "### Summary" + , "" + , if null treeErrors + then "This tree is valid" + else "This tree is NOT valid" + , "" + , if null altsErrors + then "Theses alternatives are valid" + else "Theses alternatives are NOT valid" + , "" + , "### Tree errors" + , "" + ] + ++ + lines (concatMap showTreeError treeErrors) + ++ + [ "" + , "### Alternatives errors" + , "" + ] + ++ + lines (concatMap showAltsError altsErrors) + + +showTreeError :: TreeError + -> String +showTreeError validationError = "* in \"" ++ (name . ahpTree $ validationError) ++ "\": " ++ + case validationError of + (ConsistencyError ahpTree consistencyTreshold consistency) -> + "too much unconsistency, $value = " ++ printf "%.4f" consistency ++ "$, $treshold = " ++ show consistencyTreshold ++ "$\n" + (ChildrenUnicityError ahpTree repeated) -> + "repeated children names: " ++ show repeated ++ "\n" + (InverseError ahpTree) -> + "preference values $M(i,j) \\neq \\dfrac{1}{M(j,i)}$" ++ "\n" + (LeavesUnicityError ahpTree repeated) -> + "repeated leaves names: " ++ show repeated ++ "\n" + (NotComputedConsistencyError ahpTree) -> + "consistency not computed !" ++ "\n" + (NotUnitaryDiagError ahpTree) -> + "diagonal is not '1'" ++ "\n" + (NullDivisionError ahpTree) -> + "divide by zero !" ++ "\n" + (ParentChildrenSizeMismatchError ahpTree parent children) -> + "parent and child size mismatch, $parent size = " ++ show parent ++ "$, $children size = " ++ show children ++ "$\n" + (PositivePreferenceError ahpTree) -> + "one or more preference value is $\\leq 0$ !" ++ "\n" + (SquareMatrixError ahpTree rows cols) -> + "matrix not square, $rows = " ++ show rows ++ "$, $columns = " ++ show cols ++ "$\n" + +showAltsError :: AlternativesError + -> String +showAltsError altError = "* " ++ + case altError of + NoAlternativesError -> + "no alternatives !" ++ "\n" + (AlternativesUnicityError names) -> + "repeated alternatives names: " ++ show names ++ "\n" + (IndicatorsValuesExistenceError errors) -> + "missing indicators values:" ++ show (map (\x -> ((altName . fst) x, snd x)) errors) ++ "\n" + +-- * Alternatives printing + +-- | Print AHP Alternatives and some additional information about them +showAlternatives :: [Alternative] -- ^ AHP Alternatives + -> String -- ^ Report alternatives with indicator values +showAlternatives alts = unlines $ + [ "" + , "## Alternatives values" + , "" + ] + ++ + lines (concatMap (showAlternative 0) alts) + +-- | Print an AHP Alternative and some additional information about it +showAlternative :: Int -- ^ Deep level. Used to intercalate separators + -> Alternative -- ^ Alternative + -> String -- ^ Report about the alternative +showAlternative level a = unlines $ + (tabs ++ "1. " ++ altName a) + : + lines (showIndicatorValues (level + 1) (indValues a)) + where tabs = variableTabs level + +-- | Print an AHP IndicatorValues wit name and value +showIndicatorValues :: Int -- ^ Deep level. Used to intercalate separators + -> IndicatorValues -- ^ IndicatorValues + -> String -- ^ Report about the values +showIndicatorValues level values = unlines $ + [ tabs ++ "" + , tabs ++ "| Indicator | Value |" + , tabs ++ "|-----------|-------|" + ] + ++ + map (showIndicatorValue level) (M.toList values) + ++ + [""] + where tabs = variableTabs level + +showIndicatorValue :: Int -> (String, Double) -> String +showIndicatorValue level (key, value) = tabs ++ "| " ++ key ++ " | " ++ show value ++ " |" + where tabs = variableTabs level + +-- * AHP tree printing + +showAhpTree :: AHPTree -> String +showAhpTree = showAhpSubTree 0 + +showAhpSubTree :: Int -> AHPTree -> String +showAhpSubTree level (AHPTree name prefMatrix consistency childrenPriority alternativesPriority children) = unlines $ + [ tabs ++ "* Tree : " ++ name + , tabs ++ "\t- pairwise comparison matrix :" + , tabs + ] + ++ + lines (showMatrix (level + 2) prefMatrix) + ++ + [ tabs ++ "\t- consistency ratio = " ++ maybe "N/A" show consistency + , tabs ++ "\t- children priority vector :" + , tabs + ] + ++ + lines (maybe (variableTabs (level + 2) ++ "N/A") (showMatrix (level + 2)) childrenPriority) + ++ + [ tabs ++ "\t- alternatives priority vector :" + , tabs + ] + ++ + lines (maybe (variableTabs (level + 2) ++ "N/A") (showMatrix (level + 2)) alternativesPriority) + ++ + lines (concatMap (showAhpSubTree (level + 1)) children) + where tabs = variableTabs level + +showAhpSubTree level (AHPLeaf name maximize alternativesPriority) = unlines $ + [ tabs ++ "* Leaf : " ++ name + , tabs ++ "\t- " ++ (if maximize then "indicator is maximized" else "indicator is minimized") + , tabs ++ "\t- alternatives priority vector :" + , tabs + ] + ++ + lines (maybe (variableTabs (level + 2) ++ "N/A") (showMatrix (level + 1)) alternativesPriority) + where tabs = variableTabs level + +-- * Matrix printing + +showMatrix :: Int -> Matrix Double -> String +showMatrix level = showMatrix' (level + 2) + +showMatrix' :: Int -> Matrix Double -> String +showMatrix' level matrix = concatMap showMatrixLine lists + where lists = toLists matrix + showMatrixLine line = variableTabs level ++ " | " ++ + concatMap (\x -> printf "%.4f" x ++ " ") line ++ + "|\n" + +variableTabs :: Int -> String +variableTabs level = replicate level '\t' diff --git a/src/HAHP/Sample/CarChoice.hs b/src/HAHP/Sample/CarChoice.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Sample/CarChoice.hs @@ -0,0 +1,125 @@ +module HAHP.Sample.CarChoice where + +import Data.Map +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +carChoiceTree :: AHPTree +carChoiceTree = + AHPTree "Choose the best car for the Jones family" + ( (4><4) + [ 1, 3, 7, 3 + , 1/3, 1, 9, 1 + , 1/7, 1/9, 1, 1/7 + , 1/3, 1, 7, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPTree "Cost" + ( (4><4) + [ 1, 2, 5, 3 + , 1/2, 1, 2, 2 + , 1/5, 1/2, 1, 1/2 + , 1/3, 1/2, 2, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "Purchase Price" True Nothing + , AHPLeaf "Fuel Costs" True Nothing + , AHPLeaf "Maintenance Costs" True Nothing + , AHPLeaf "Resale Value" True Nothing + ] + , AHPLeaf "Safety" True Nothing + , AHPLeaf "Style" True Nothing + , AHPTree "Capacity" + ( (2><2) + [ 1, 1/5 + , 5, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "Cargo Capacity" True Nothing + , AHPLeaf "Passenger Capacity" True Nothing + ] + ] + +asValues = + insert "Purchase Price" 0.242 + . insert "Fuel Costs" 0.188 + . insert "Maintenance Costs" 0.357 + . insert "Resale Value" 0.225 + . insert "Safety" 0.215 + . insert "Style" 0.346 + . insert "Cargo Capacity" 0.090 + . insert "Passenger Capacity" 0.136 + $ empty + +ahValues = + insert "Purchase Price" 0.027 + . insert "Fuel Costs" 0.212 + . insert "Maintenance Costs" 0.312 + . insert "Resale Value" 0.095 + . insert "Safety" 0.215 + . insert "Style" 0.346 + . insert "Cargo Capacity" 0.090 + . insert "Passenger Capacity" 0.136 + $ empty + +psuvValues = + insert "Purchase Price" 0.027 + . insert "Fuel Costs" 0.133 + . insert "Maintenance Costs" 0.084 + . insert "Resale Value" 0.055 + . insert "Safety" 0.083 + . insert "Style" 0.045 + . insert "Cargo Capacity" 0.170 + . insert "Passenger Capacity" 0.273 + $ empty + +crvValues = + insert "Purchase Price" 0.242 + . insert "Fuel Costs" 0.160 + . insert "Maintenance Costs" 0.100 + . insert "Resale Value" 0.415 + . insert "Safety" 0.038 + . insert "Style" 0.160 + . insert "Cargo Capacity" 0.170 + . insert "Passenger Capacity" 0.136 + $ empty + +esuvValues = + insert "Purchase Price" 0.362 + . insert "Fuel Costs" 0.151 + . insert "Maintenance Costs" 0.089 + . insert "Resale Value" 0.105 + . insert "Safety" 0.025 + . insert "Style" 0.025 + . insert "Cargo Capacity" 0.170 + . insert "Passenger Capacity" 0.046 + $ empty + +omValues = + insert "Purchase Price" 0.100 + . insert "Fuel Costs" 0.156 + . insert "Maintenance Costs" 0.058 + . insert "Resale Value" 0.105 + . insert "Safety" 0.424 + . insert "Style" 0.078 + . insert "Cargo Capacity" 0.310 + . insert "Passenger Capacity" 0.273 + $ empty + +carChoiceAlternatives :: [Alternative] +carChoiceAlternatives = [ Alternative "Accord Sedan" asValues + , Alternative "Accord Hybrid" ahValues + , Alternative "Pilot SUV" psuvValues + , Alternative "CR-V SUV" crvValues + , Alternative "Element SUV" esuvValues + , Alternative "Odyssey Minivan" omValues + ] diff --git a/src/HAHP/Sample/Config1.hs b/src/HAHP/Sample/Config1.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Sample/Config1.hs @@ -0,0 +1,62 @@ +module HAHP.Sample.Config1 where + +import Data.Map +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +rootName :: String +rootName = "Super objective" + +rootPrefMatrix :: PairwiseMatrix +rootPrefMatrix = fromLists [ [1.0, 1.0] , [1.0, 1.0] ] + +leaf1 :: AHPTree +leaf1 = AHPLeaf "Indicator 1" True Nothing + +leaf2 :: AHPTree +leaf2 = AHPLeaf "Indicator 2" False Nothing + +rootNodes :: [AHPTree] +rootNodes = [ leaf1, leaf2 ] + +sampleAHPConfig1 :: AHPTree +sampleAHPConfig1 = AHPTree rootName rootPrefMatrix Nothing Nothing Nothing rootNodes + +sampleIndicatorValues1 :: IndicatorValues +sampleIndicatorValues1 = insert "Indicator 1" 1 + . insert "Indicator 2" 10 + $ empty + +sampleIndicatorValues1' :: IndicatorValues +sampleIndicatorValues1' = insert "Indicator 1" 10 + . insert "Indicator 2" 10 + $ empty + +sampleIndicatorValues1'' :: IndicatorValues +sampleIndicatorValues1'' = insert "Indicator 1" 100 + . insert "Indicator 2" 10 + $ empty + +sampleIndicatorValues1''' :: IndicatorValues +sampleIndicatorValues1''' = insert "Indicator 1" 100 + . insert "Indicator 2" 1 + $ empty + +sampleIndicatorValues1'''' :: IndicatorValues +sampleIndicatorValues1'''' = insert "Indicator 1" 10 + . insert "Indicator 2" 1000 + $ empty + +sampleIndicatorValues1''''' :: IndicatorValues +sampleIndicatorValues1''''' = insert "Indicator 1" 100 + . insert "Indicator 2" 100 + $ empty + +sampleAlternatives1 :: [Alternative] +sampleAlternatives1 = [ Alternative "alternative A" sampleIndicatorValues1 + , Alternative "alternative B" sampleIndicatorValues1' + , Alternative "alternative C" sampleIndicatorValues1'' + , Alternative "alternative D" sampleIndicatorValues1''' + , Alternative "alternative E" sampleIndicatorValues1'''' + , Alternative "alternative F" sampleIndicatorValues1''''' + ] diff --git a/src/HAHP/Sample/Config2.hs b/src/HAHP/Sample/Config2.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Sample/Config2.hs @@ -0,0 +1,74 @@ +-- | Example for choosing the world's master +module HAHP.Sample.Config2 where + +import Data.Map +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +sampleAHPConfig2 :: AHPTree +sampleAHPConfig2 = AHPTree + "Become the world's master, Pinky and the Brain" + ( fromLists [ [ 1.00, 1/4 , 4 ], + [ 4 , 1.00, 9 ], + [ 1/4 , 1/9 , 1.00 ] + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "Power" True Nothing + , AHPTree + "Charisma" + ( (3><3) [ 1, 3, 5 + , 1/3, 1, 9 + , 1/5, 1/9, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "Shyness" False Nothing + , AHPLeaf "Outfit" True Nothing + , AHPLeaf "Size of *" True Nothing + ] + , AHPLeaf "Capital" True Nothing + ] + +sampleIndicatorValues2 :: IndicatorValues +sampleIndicatorValues2 = insert "Power" 100 + . insert "Shyness" 100 + . insert "Outfit" 100 + . insert "Size of *" 100 + . insert "Capital" 100 + $ empty + +sampleIndicatorValues2' :: IndicatorValues +sampleIndicatorValues2' = insert "Power" 1000 + . insert "Shyness" 100 + . insert "Outfit" 100 + . insert "Size of *" 100 + . insert "Capital" 100 + $ empty + +sampleIndicatorValues2'' :: IndicatorValues +sampleIndicatorValues2'' = insert "Power" 1000 + . insert "Shyness" 100 + . insert "Outfit" 100 + . insert "Size of *" 1000 + . insert "Capital" 100 + $ empty + +sampleIndicatorValues2''' :: IndicatorValues +sampleIndicatorValues2''' = insert "Power" 1000 + . insert "Shyness" 1000 + . insert "Outfit" 100 + . insert "Size of *" 100 + . insert "Capital" 100 + $ empty + +sampleAlternatives2 :: [Alternative] +sampleAlternatives2 = [ Alternative "John" sampleIndicatorValues2 + , Alternative "David" sampleIndicatorValues2' + , Alternative "Marc" sampleIndicatorValues2'' + , Alternative "Steve" sampleIndicatorValues2''' + ] diff --git a/src/HAHP/Sample/Config3.hs b/src/HAHP/Sample/Config3.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Sample/Config3.hs @@ -0,0 +1,51 @@ +-- | Example from Ounnar 1999 +module HAHP.Sample.Config3 where + +import Data.Map +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +sampleAHPConfig3 :: AHPTree +sampleAHPConfig3 = AHPTree + "Testing the Priority vectors computation" + ( (4><4) [ 1, 1/5, 1, 3 + , 5, 1, 3, 5 + , 1, 1/3, 1, 3 + , 1/3, 1/5, 1/3, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "d" True Nothing + , AHPLeaf "Tp" True Nothing + , AHPLeaf "Tf" True Nothing + , AHPLeaf "Id" False Nothing + ] + +sampleIndicatorValues3 :: IndicatorValues +sampleIndicatorValues3 = insert "d" 1 + . insert "Tp" 10 + . insert "Tf" 100 + . insert "Id" 1000 + $ empty + +sampleIndicatorValues3' :: IndicatorValues +sampleIndicatorValues3' = insert "d" 2 + . insert "Tp" 20 + . insert "Tf" 200 + . insert "Id" 2000 + $ empty + +sampleIndicatorValues3'' :: IndicatorValues +sampleIndicatorValues3'' = insert "d" 1 + . insert "Tp" 10 + . insert "Tf" 100 + . insert "Id" 2000 + $ empty + +sampleAlternatives3 :: [Alternative] +sampleAlternatives3 = [ Alternative "alternative A" sampleIndicatorValues3 + , Alternative "alternative B" sampleIndicatorValues3' + , Alternative "alternative C" sampleIndicatorValues3'' + ] diff --git a/src/HAHP/Sample/LeaderChoice.hs b/src/HAHP/Sample/LeaderChoice.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Sample/LeaderChoice.hs @@ -0,0 +1,49 @@ +module HAHP.Sample.LeaderChoice where + +import Data.Map +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +leaderChoiceTree :: AHPTree +leaderChoiceTree = AHPTree "Choose the Most Suitable Leader" + ( (4><4) [ 1, 4, 3, 7 + , 1/4, 1, 1/3, 3 + , 1/3, 3, 1, 5 + , 1/7, 1/3, 1/5, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "Experience" True Nothing + , AHPLeaf "Education" True Nothing + , AHPLeaf "Charisma" True Nothing + , AHPLeaf "Age" True Nothing + ] + +tomValues = + insert "Experience" 0.217 + . insert "Education" 0.188 + . insert "Charisma" 0.743 + . insert "Age" 0.265 + $ empty + +dickValues = + insert "Experience" 0.717 + . insert "Education" 0.081 + . insert "Charisma" 0.194 + . insert "Age" 0.672 + $ empty + +harryValues = + insert "Experience" 0.066 + . insert "Education" 0.731 + . insert "Charisma" 0.063 + . insert "Age" 0.063 + $ empty + +leaderChoiceAlternatives :: [Alternative] +leaderChoiceAlternatives = [ Alternative "Tom" tomValues + , Alternative "Dick" dickValues + , Alternative "Harry" harryValues + ] diff --git a/src/HAHP/Sample/SquareMatrixError.hs b/src/HAHP/Sample/SquareMatrixError.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Sample/SquareMatrixError.hs @@ -0,0 +1,70 @@ +-- | Example from Ounnar 1999 +module HAHP.Sample.SquareMatrixError where + +import Data.Map +import HAHP.Data +import Numeric.LinearAlgebra.HMatrix + +smeConfig :: AHPTree +smeConfig = AHPTree + "Testing the Square Matrix Error" + ( (4><5) [ 1, 1/5, 0, 3, 2 + , 5, 2, -3, 5, 2 + , 1, -1/3, 1, 4, 2 + , 1/3, 1/5, 1/3, 1, 2 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "d" True Nothing + , AHPLeaf "Tp" True Nothing + , AHPLeaf "Tf" True Nothing + , AHPLeaf "Id" False Nothing + , AHPTree + "Id" + ( (2><2) [ 1, 9 + , 1/9, 1 + ] + ) + Nothing + Nothing + Nothing + [ AHPLeaf "d" True Nothing + , AHPLeaf "Tf" True Nothing + ] + ] + +smeIndicatorValues :: IndicatorValues +smeIndicatorValues = insert "d" 1 + . insert "Tp" 10 + . insert "Tf" 100 + . insert "Id" 1000 + $ empty + +smeIndicatorValues' :: IndicatorValues +smeIndicatorValues' = insert "d" 2 + . insert "Tp" 20 + . insert "Tf" 200 + . insert "Id" 2000 + $ empty + +smeIndicatorValues'' :: IndicatorValues +smeIndicatorValues'' = insert "d" 1 + . insert "Tp" 10 + . insert "Tf" 100 + . insert "Id" 2000 + $ empty + +smeIndicatorValues''' :: IndicatorValues +smeIndicatorValues''' = insert "d" 1 + . insert "Tp" 10 + . insert "Id" 2000 + $ empty + +smeAlternatives :: [Alternative] +smeAlternatives = [ Alternative "alternative A" smeIndicatorValues + , Alternative "alternative B" smeIndicatorValues' + , Alternative "alternative B" smeIndicatorValues'' + , Alternative "alternative C" smeIndicatorValues''' + ] diff --git a/src/HAHP/Validation/Alternatives.hs b/src/HAHP/Validation/Alternatives.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Validation/Alternatives.hs @@ -0,0 +1,55 @@ +module HAHP.Validation.Alternatives where + +import Control.Parallel.Strategies +import Data.Map (notMember) +import Data.Maybe +import HAHP.Data +import HAHP.Validation.Unique + +validateAlternatives :: AHPTree + -> [Alternative] + -> [AlternativesError] +validateAlternatives ahpTree alts = validate' ahpTree alts testsList + +validate' :: AHPTree + -> [Alternative] + -> [AHPTree -> [Alternative] -> Maybe AlternativesError] + -> [AlternativesError] +validate' ahpTree alts checks = catMaybes $ parMap rseq (\check -> check ahpTree alts) checks + +testsList :: [AHPTree -> [Alternative] -> Maybe AlternativesError] +testsList = [ noAlternativesTest + , alternativesUnicityTest + , indicatorsValuesExistenceTest + ] + +noAlternativesTest :: AHPTree + -> [Alternative] + -> Maybe AlternativesError +noAlternativesTest _ alts = + if not . null $ alts + then Nothing + else Just NoAlternativesError + +alternativesUnicityTest :: AHPTree + -> [Alternative] + -> Maybe AlternativesError +alternativesUnicityTest _ alts = + if null repeatedAlternativesNames + then Nothing + else Just AlternativesUnicityError {repeatedAlternativesNames = repeatedAlternativesNames} + where repeatedAlternativesNames = repeated . map altName $ alts + +indicatorsValuesExistenceTest :: AHPTree + -> [Alternative] + -> Maybe AlternativesError +indicatorsValuesExistenceTest ahpTree alts = + if null errors + then Nothing + else Just IndicatorsValuesExistenceError { indValuesErrors = errors} + where indicatorsNames = map name (getTreeLeaves ahpTree) + errors = [ (alt, ind) + | alt <- alts + , ind <- indicatorsNames + , notMember ind . indValues $ alt + ] diff --git a/src/HAHP/Validation/Tree.hs b/src/HAHP/Validation/Tree.hs new file mode 100644 --- /dev/null +++ b/src/HAHP/Validation/Tree.hs @@ -0,0 +1,154 @@ +module HAHP.Validation.Tree where + +import Control.Parallel.Strategies +--import Data.List.Unique +import Data.List (group, sort, sortBy) +import Data.Maybe +import HAHP.Data +import HAHP.Validation.Unique +import Numeric.LinearAlgebra.HMatrix + +-- * Helper functions + +validateInputAHPTree :: AHPTree -> [TreeError] +validateInputAHPTree ahpTree = validate' ahpTree inputTestsList + +validateAHPTree :: AHPTree -> [TreeError] +validateAHPTree ahpTree = validate' ahpTree testsList + +validate' :: AHPTree -> [AHPTree -> Maybe TreeError] -> [TreeError] +validate' ahpTree checks = catMaybes $ concat $ parMap rseq (recursiveValidator ahpTree) checks + +inputTestsList :: [AHPTree -> Maybe TreeError] +inputTestsList = [ squareMatrixTest + , parentSizeMatchChildrenTest + , unitaryDiagTest + , nullDivisionTest + , positivePreferenceTest + , inverseTest + , childrenUnicityTest + , leavesUnicityTest + ] + +testsList :: [AHPTree -> Maybe TreeError] +testsList = [ consistencyTest + ] + +recursiveValidator :: AHPTree + -> (AHPTree -> Maybe TreeError) + -> [Maybe TreeError] +recursiveValidator ahpTree testFnt = + case ahpTree of + AHPTree {} -> currentValidity : childrenValidity + where currentValidity = testFnt ahpTree + --childrenValidity = concatMap (`recursiveValidator` testFnt) (children ahpTree) + childrenValidity = concat $ parMap rseq (`recursiveValidator` testFnt) (children ahpTree) + AHPLeaf {} -> [Nothing] + + +-- * Tests implementations + +-- ** Consistency test + +consistencyTest :: AHPTree -> Maybe TreeError +consistencyTest ahpTree = + case consistencyValue ahpTree of + Nothing -> Just NotComputedConsistencyError { ahpTree = ahpTree } + Just x -> if isMatrixConsistent x validationConsistencyThreshold + then Nothing + else Just ConsistencyError { ahpTree = ahpTree + , consistencyThreshold = validationConsistencyThreshold + , consistency = x + } + +validationConsistencyThreshold = 0.1 + +isMatrixConsistent :: Double -> Double -> Bool +isMatrixConsistent consistency threshold + | consistency < threshold = True + | otherwise = False + +-- ** Tree structure tests + +childrenUnicityTest :: AHPTree -> Maybe TreeError +childrenUnicityTest ahpTree = + if null repeatedChildrenNames + then Nothing + else Just ChildrenUnicityError { ahpTree = ahpTree + , repeatedChildrenNames = repeatedChildrenNames + } + where repeatedChildrenNames = repeated . map name . children $ ahpTree + +leavesUnicityTest :: AHPTree -> Maybe TreeError +leavesUnicityTest ahpTree = + if null repeatedLeavesNames + then Nothing + else Just LeavesUnicityError { ahpTree = ahpTree + , repeatedLeavesNames = repeatedLeavesNames + } + where repeatedLeavesNames = repeated . map name . getTreeLeaves $ ahpTree + +parentSizeMatchChildrenTest :: AHPTree -> Maybe TreeError +parentSizeMatchChildrenTest ahpTree = + if parentSize == childrenSize + then Nothing + else Just ParentChildrenSizeMismatchError { ahpTree = ahpTree + , errorParentSize = parentSize + , errorChildrenSize = childrenSize + } + where parentSize = rows . preferenceMatrix $ ahpTree + childrenSize = length . children $ ahpTree + +-- ** Matrix properties tests + +inverseTest :: AHPTree -> Maybe TreeError +inverseTest ahpTree = + if all (inverseTest' . preferenceMatrix $ ahpTree) indices + then Nothing + else Just InverseError {ahpTree = ahpTree} + where indices = [ (i, j) + | i <- [1..matrixSize-1] + , j <- [1..matrixSize-1] + , j > i + ] + matrixSize = fromIntegral . rows . preferenceMatrix $ ahpTree + +inverseTest' :: Matrix Double -> (Int, Int) -> Bool +inverseTest' matrix (i, j) = m_ij == (1 / m_ji) + where + m_ij :: Double + m_ij = matrix `atIndex` (i, j) + m_ji :: Double + m_ji = matrix `atIndex` (j, i) + +nullDivisionTest :: AHPTree -> Maybe TreeError +nullDivisionTest ahpTree = + if 0 `notElem` matrixvalues + then Nothing + else Just NullDivisionError {ahpTree = ahpTree} + where matrixvalues = concat . toLists . preferenceMatrix $ ahpTree + +positivePreferenceTest :: AHPTree -> Maybe TreeError +positivePreferenceTest ahpTree = + if all (> 0) matrixValues + then Nothing + else Just PositivePreferenceError {ahpTree = ahpTree} + where matrixValues = concat . toLists . preferenceMatrix $ ahpTree + +squareMatrixTest :: AHPTree -> Maybe TreeError +squareMatrixTest ahpTree = + if rows matrix == cols matrix + then Nothing + else Just SquareMatrixError { ahpTree = ahpTree + , errorRows = rows matrix + , errorCols = cols matrix + } + where matrix = preferenceMatrix ahpTree + +unitaryDiagTest :: AHPTree -> Maybe TreeError +unitaryDiagTest ahpTree = + if all (== 1) diagonalValues + then Nothing + else Just NotUnitaryDiagError {ahpTree = ahpTree} + where diagonalValues = toList . takeDiag . preferenceMatrix $ ahpTree +