diff --git a/LICENSE b/LICENSE
index dba13ed..f413340 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,661 +1,287 @@
- GNU AFFERO GENERAL PUBLIC LICENSE
- Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-our General Public Licenses are 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.
-
- 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.
-
- Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
- A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate. Many developers of free software are heartened and
-encouraged by the resulting cooperation. However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
- The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community. It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server. Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
- An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals. This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
-
- 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
-
- Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software. This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
- 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 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 work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
- 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 AGPL, see
-.
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
+EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
+below) which is provided under the terms of this Licence. Any use of the Work,
+other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work:
+
+Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+
+- ‘The Licence’: this Licence.
+
+- ‘The Original Work’: the work or software distributed or communicated by the
+Licensor under this Licence, available as Source Code and also as Executable
+Code as the case may be.
+
+- ‘Derivative Works’: the works or software that could be created by the
+Licensee, based upon the Original Work or modifications thereof. This Licence
+does not define the extent of modification or dependence on the Original Work
+required in order to classify a work as a Derivative Work; this extent is
+determined by copyright law applicable in the country mentioned in Article 15.
+
+- ‘The Work’: the Original Work or its Derivative Works.
+
+- ‘The Source Code’: the human-readable form of the Work which is the most
+convenient for people to study and modify.
+
+- ‘The Executable Code’: any code which has generally been compiled and which is
+meant to be interpreted by a computer as a program.
+
+- ‘The Licensor’: the natural or legal person that distributes or communicates
+the Work under the Licence.
+
+- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
+Licence, or otherwise contributes to the creation of a Derivative Work.
+
+- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+the Work under the terms of the Licence.
+
+- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+renting, distributing, communicating, transmitting, or otherwise making
+available, online or offline, copies of the Work or providing access to its
+essential functionalities at the disposal of any other natural or legal
+person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright vested
+in the Original Work:
+
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display
+the Work or copies thereof to the public and perform publicly, as the case may
+be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make effective
+the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
+any patents held by the Licensor, to the extent necessary to make use of the
+rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates, in
+a notice following the copyright notice attached to the Work, a repository where
+the Source Code is easily and freely accessible for as long as the Licensor
+continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits from
+any exception or limitation to the exclusive rights of the rights owners in the
+Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and a
+copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of the
+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions on
+the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed under
+a Compatible Licence, this Distribution or Communication can be done under the
+terms of this Compatible Licence. For the sake of this clause, ‘Compatible
+Licence’ refers to the licences listed in the appendix attached to this Licence.
+Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible
+Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work,
+the Licensee will provide a machine-readable copy of the Source Code or indicate
+a repository where this Source will be easily and freely available for as long
+as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade names,
+trademarks, service marks, or names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings
+to the Work are owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis
+and without warranties of any kind concerning the Work, including without
+limitation merchantability, fitness for a particular purpose, absence of defects
+or errors, accuracy, non-infringement of intellectual property rights other than
+copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition
+for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the use
+of the Work, including without limitation, damages for loss of goodwill, work
+stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such damage.
+However, the Licensor will be liable under statutory product liability laws as
+far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional agreement,
+defining obligations or services consistent with this Licence. However, if
+accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor harmless
+for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
+placed under the bottom of a window displaying the text of this Licence or by
+affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this Licence,
+such as the use of the Work, the creation by You of a Derivative Work or the
+Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of electronic
+communication by You (for example, by offering to download the Work from a
+remote location) the distribution channel or media (for example, a website) must
+at least provide to the public the information requested by the applicable law
+regarding the Licensor, the Licence and the way it may be accessible, concluded,
+stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has
+received the Work from the Licensee under the Licence, provided such persons
+remain in full compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of
+this Licence or updated versions of the Appendix, so far this is required and
+reasonable, without reducing the scope of the rights granted by the Licence. New
+versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+
+- any litigation resulting from the interpretation of this License, arising
+between the European Union institutions, bodies, offices or agencies, as a
+Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+of Justice of the European Union, as laid down in article 272 of the Treaty on
+the Functioning of the European Union,
+
+- any litigation arising between other parties and resulting from the
+interpretation of this License, will be subject to the exclusive jurisdiction
+of the competent court where the Licensor resides or conducts its primary
+business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+
+- this Licence shall be governed by the law of the European Union Member State
+where the Licensor has his seat, resides or has his registered office,
+
+- this licence shall be governed by Belgian law if the Licensor has no seat,
+residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
+- Open Software License (OSL) v. 2.1, v. 3.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
+Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above
+licences without producing a new version of the EUPL, as long as they provide
+the rights granted in Article 2 of this Licence and protect the covered Source
+Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new
+EUPL version.
diff --git a/README.md b/README.md
index 8a0e137..3803165 100644
--- a/README.md
+++ b/README.md
@@ -4,50 +4,38 @@ mealy-decompose
Tools to investigate decomposition of Mealy machines, aka finite state
machines (FSMs). Notable entry points are:
-* `app/Main.hs` is a heuristic to decompose finite state machines into
+* `hs/app/Main.hs` is a heuristic to decompose finite state machines into
multiple components, based on their outputs.
-* `other/decompose_fsm_optimise.py` does the same, but optimally and with a
+* `py/decompose_fsm_optimise.py` does the same, but optimally and with a
SAT solver. This can only handle state spaces of at most a few hundred
states.
-* `app/RandomGen.hs` for generating FSMs which are decomposable.
+* `hs/app/RandomGen.hs` for generating FSMs which are decomposable.
## How to run
The the haskell tools (tested with ghc 9.2.8 and ghc 9.10.1):
```
-cabal run mealy-decompose --
+cabal run mealy-decompose-main --
```
For the python tools (tested with python 3.12):
```
-pip3 install python-sat
-python3 decompose_fsm_optimise.py -h
+pip install -r py/requirements.txt
+python py/decompose_fsm_optimise.py -h
```
-## Notes on `copar`
+## Copyright notice and license
-In the first versions of this tool, I used the `copar` library:
-[CoPaR (The Coalgebraic Partition Refiner)](https://git8.cs.fau.de/software/copar).
-This is a great library and in particular very fast. Despite that, I switched
-to my own partition refinement implementations because of the reasons below.
-The last commit to use `copar` is `2b8b79a4`.
+(c) 2024-2025 Joshua Moerman, Open Universiteit, licensed under the EUPL
+(European Union Public License). You may find the license in the LICENSE file.
-* I needed witnesses for some tasks. So I not only construct a partition,
- but also a splitting tree, where are track all the actions needed to
- separate states.
+If you want to use this library and find the license not suitable for you,
+then please do get in touch.
-* I prefer to use the actual strings (or other data type) for the states,
- inputs and outputs as opposed to `Int`s. This makes it easier to debug, and
- less error-prone, as one cannot mix these entities anymore.
-
-* `copar` comes with many dependencies, and it was a bit tricky to get the
- versioning correct.
-
-
-## Copyright
-
-(c) 2024 Joshua Moerman, Open Universiteit
+```
+SPDX-License-Identifier: EUPL-1.2
+```
diff --git a/cabal.project b/cabal.project
new file mode 100644
index 0000000..6acc394
--- /dev/null
+++ b/cabal.project
@@ -0,0 +1,8 @@
+packages: hs
+
+package *
+ optimization: True
+
+package mealy-decompose
+ profiling: True
+ ghc-options: -Wall -fexpose-all-unfoldings -fspecialise-aggressively
diff --git a/docs/copar.md b/docs/copar.md
new file mode 100644
index 0000000..452f5cf
--- /dev/null
+++ b/docs/copar.md
@@ -0,0 +1,18 @@
+# Notes on the `copar` library
+
+In the first versions of this tool, I used the `copar` library:
+[CoPaR (The Coalgebraic Partition Refiner)](https://git8.cs.fau.de/software/copar).
+This is a great library and in particular very fast. Despite that, I switched
+to my own partition refinement implementations because of the reasons below.
+The last commit to use `copar` is `2b8b79a4`.
+
+* I needed witnesses for some tasks. So I not only construct a partition,
+ but also a splitting tree, where are track all the actions needed to
+ separate states.
+
+* I prefer to use the actual strings (or other data type) for the states,
+ inputs and outputs as opposed to `Int`s. This makes it easier to debug, and
+ less error-prone, as one cannot mix these entities anymore.
+
+* `copar` comes with many dependencies, and it was a bit tricky to get the
+ versioning correct.
\ No newline at end of file
diff --git a/examples/RKMachine_3.dot b/examples/RKMachine_3.dot
new file mode 100644
index 0000000..2a73ded
--- /dev/null
+++ b/examples/RKMachine_3.dot
@@ -0,0 +1,15 @@
+digraph RKMachine_3 {
+ s0Up -> s1Up [label="a/0"]
+ s0Up -> s0Dn [label="b/0"]
+ s1Up -> s2Up [label="a/1"]
+ s1Up -> s1Dn [label="b/0"]
+ s2Up -> s0Up [label="a/2"]
+ s2Up -> s2Dn [label="b/0"]
+ s0Dn -> s2Dn [label="a/0"]
+ s0Dn -> s0Up [label="b/0"]
+ s1Dn -> s0Dn [label="a/1"]
+ s1Dn -> s1Up [label="b/0"]
+ s2Dn -> s1Dn [label="a/2"]
+ s2Dn -> s2Up [label="b/0"]
+}
+
diff --git a/examples/RKMachine_4.dot b/examples/RKMachine_4.dot
new file mode 100644
index 0000000..69c3ee8
--- /dev/null
+++ b/examples/RKMachine_4.dot
@@ -0,0 +1,19 @@
+digraph RKMachine_4 {
+ s0Up -> s1Up [label="a/0"]
+ s0Up -> s0Dn [label="b/0"]
+ s1Up -> s2Up [label="a/1"]
+ s1Up -> s1Dn [label="b/0"]
+ s2Up -> s3Up [label="a/2"]
+ s2Up -> s2Dn [label="b/0"]
+ s3Up -> s0Up [label="a/3"]
+ s3Up -> s3Dn [label="b/0"]
+ s0Dn -> s3Dn [label="a/0"]
+ s0Dn -> s0Up [label="b/0"]
+ s1Dn -> s0Dn [label="a/1"]
+ s1Dn -> s1Up [label="b/0"]
+ s2Dn -> s1Dn [label="a/2"]
+ s2Dn -> s2Up [label="b/0"]
+ s3Dn -> s2Dn [label="a/3"]
+ s3Dn -> s3Up [label="b/0"]
+}
+
diff --git a/app/LStarMain.hs b/hs/app/LStarMain.hs
similarity index 100%
rename from app/LStarMain.hs
rename to hs/app/LStarMain.hs
diff --git a/app/Main.hs b/hs/app/Main.hs
similarity index 100%
rename from app/Main.hs
rename to hs/app/Main.hs
diff --git a/app/Playground.hs b/hs/app/Playground.hs
similarity index 100%
rename from app/Playground.hs
rename to hs/app/Playground.hs
diff --git a/app/RandomGen.hs b/hs/app/RandomGen.hs
similarity index 100%
rename from app/RandomGen.hs
rename to hs/app/RandomGen.hs
diff --git a/mealy-decompose.cabal b/hs/mealy-decompose.cabal
similarity index 87%
rename from mealy-decompose.cabal
rename to hs/mealy-decompose.cabal
index 8fe0c3e..b959e83 100644
--- a/mealy-decompose.cabal
+++ b/hs/mealy-decompose.cabal
@@ -1,11 +1,11 @@
cabal-version: 2.2
name: mealy-decompose
-version: 0.2.0.0
-license: AGPL-3.0-only
-license-file: LICENSE
+version: 0.3.0.0
+license: EUPL-1.2
+license-file: ../LICENSE
author: Joshua Moerman
maintainer: joshua.moerman@ou.nl
-copyright: (c) 2024 Joshua Moerman, Open Universiteit
+copyright: (c) 2024-2025 Joshua Moerman, Open Universiteit
build-type: Simple
common stuff
@@ -38,7 +38,7 @@ library
SplittingTree,
StateIdentifiers
-executable mealy-decompose
+executable mealy-decompose-main
import: stuff
hs-source-dirs: app
main-is: Main.hs
diff --git a/src/Bisimulation.hs b/hs/src/Bisimulation.hs
similarity index 100%
rename from src/Bisimulation.hs
rename to hs/src/Bisimulation.hs
diff --git a/src/Data/Partition.hs b/hs/src/Data/Partition.hs
similarity index 100%
rename from src/Data/Partition.hs
rename to hs/src/Data/Partition.hs
diff --git a/src/Data/Preorder.hs b/hs/src/Data/Preorder.hs
similarity index 100%
rename from src/Data/Preorder.hs
rename to hs/src/Data/Preorder.hs
diff --git a/src/Data/Trie.hs b/hs/src/Data/Trie.hs
similarity index 100%
rename from src/Data/Trie.hs
rename to hs/src/Data/Trie.hs
diff --git a/src/Data/UnionFind.hs b/hs/src/Data/UnionFind.hs
similarity index 100%
rename from src/Data/UnionFind.hs
rename to hs/src/Data/UnionFind.hs
diff --git a/src/DotParser.hs b/hs/src/DotParser.hs
similarity index 100%
rename from src/DotParser.hs
rename to hs/src/DotParser.hs
diff --git a/src/DotWriter.hs b/hs/src/DotWriter.hs
similarity index 100%
rename from src/DotWriter.hs
rename to hs/src/DotWriter.hs
diff --git a/src/LStar.hs b/hs/src/LStar.hs
similarity index 100%
rename from src/LStar.hs
rename to hs/src/LStar.hs
diff --git a/src/Mealy.hs b/hs/src/Mealy.hs
similarity index 100%
rename from src/Mealy.hs
rename to hs/src/Mealy.hs
diff --git a/src/MealyRefine.hs b/hs/src/MealyRefine.hs
similarity index 100%
rename from src/MealyRefine.hs
rename to hs/src/MealyRefine.hs
diff --git a/src/Merger.hs b/hs/src/Merger.hs
similarity index 100%
rename from src/Merger.hs
rename to hs/src/Merger.hs
diff --git a/src/SplittingTree.hs b/hs/src/SplittingTree.hs
similarity index 100%
rename from src/SplittingTree.hs
rename to hs/src/SplittingTree.hs
diff --git a/src/StateIdentifiers.hs b/hs/src/StateIdentifiers.hs
similarity index 100%
rename from src/StateIdentifiers.hs
rename to hs/src/StateIdentifiers.hs
diff --git a/test/Main.hs b/hs/test/Main.hs
similarity index 100%
rename from test/Main.hs
rename to hs/test/Main.hs
diff --git a/other/decompose_observation_table.py b/other/decompose_observation_table.py
deleted file mode 100644
index b8358da..0000000
--- a/other/decompose_observation_table.py
+++ /dev/null
@@ -1,227 +0,0 @@
-from pysat.solvers import Solver
-from pysat.card import CardEnc
-from pysat.formula import IDPool
-from pysat.formula import CNF
-
-### Gebruik:
-# Stap 1: pip3 install python-sat
-# Stap 2: python3 decompose_observation_table.py
-
-
-###################################
-# Wat dingetjes over Mealy machines
-
-
-# Voorbeeld: 2n states, input-alfabet 'a' en 'b', outputs [0...n-1]
-def rick_koenders_machine(N):
- transition_fun = {((n, False), 'a'): ((n + 1) % N, False) for n in range(N)}
- transition_fun |= {(((n + 1) % N, True), 'a'): (n % N, True) for n in range(N)}
- transition_fun |= {((n, b), 'b'): (n, not b) for b in [False, True] for n in range(N)}
- output_fun = {((n, b), 'a'): n for b in [False, True] for n in range(N)}
- output_fun |= {((n, b), 'b'): 0 for b in [False, True] for n in range(N)}
- initial_state = (0, False)
- inputs = ['a', 'b']
- outputs = [n for n in range(N)]
- return {'transition_fun': transition_fun, 'output_fun': output_fun, 'initial_state': initial_state, 'inputs': inputs, 'outputs': outputs}
-
-
-def mealy_sem_q(machine, word, state):
- if len(word) == 0:
- return None
- if len(word) == 1:
- return machine['output_fun'][(state, word[0])]
- else:
- return mealy_sem_q(machine, word[1:], machine['transition_fun'][(state, word[0])])
-
-
-def mealy_sem(machine, word):
- return mealy_sem_q(machine, word, machine['initial_state'])
-
-
-def print_table(cell, rs, cs):
- first_col_size = max([len(str(r)) for r in rs])
- col_size = 1 + max([len(str(c)) for c in cs])
-
- print(''.rjust(first_col_size), end='')
- for c in cs:
- print(str(c).rjust(col_size), end='')
- print('')
-
- for r in rs:
- print(str(r).rjust(first_col_size), end='')
- for c in cs:
- print(cell(r, c).rjust(col_size), end='')
- print('')
-
-
-################
-# Voorbeeld data
-machine = rick_koenders_machine(4) # 8 states
-
-# L* table: Niet noodzakelijk volledig, werkt ook met minder data, maar ik
-# weet niet wat voor garanties we dan kunnen geven. Het is sowieso maar de
-# vraag of de kolommen voldoende zijn als we projecteren.
-rows = ['', 'a', 'aa', 'aaa', 'aaaa', 'b', 'ab', 'aab', 'aaab']
-cols = ['a', 'aa', 'aaa', 'aaaa', 'b', 'ab', 'ba', 'abab']
-
-print_table(lambda r, c: str(mealy_sem(machine, r + c)), rows, cols)
-
-# We zoeken 2 componenten met gezamelijke grootte 6 (minder dan 8)
-# als de de total_size te laag is => UNSAT => duurt lang
-c = 2
-total_size = 6
-
-
-########################
-# Encodering naar logica
-print('Start encoding')
-os = machine['outputs'] # outputs
-rids = [i for i in range(c)] # components
-vpool = IDPool()
-cnf = CNF()
-
-
-# Een hulp variabele voor False en True, maakt de andere variabelen eenvoudiger
-def var_const(b):
- return vpool.id(('const', b))
-
-
-cnf.append([var_const(True)])
-cnf.append([-var_const(False)])
-
-
-# Voor elke relatie en elke twee elementen o1 en o2, is er een variabele die
-# aangeeft of o1 en o2 gerelateerd zijn. Er is 1 variabele voor xRy en yRx, dus
-# symmetrie is al ingebouwd. Reflexiviteit is ook ingebouwd.
-def var_rel(rid, o1, o2):
- if o1 == o2:
- return var_const(True)
-
- [so1, so2] = sorted([o1, o2])
- return vpool.id(('rel', rid, so1, so2))
-
-
-# De relatie op outputs geeft een relaties op rijen. Deze zijn geindexeerd
-# met de woorden uit 'rows'.
-def var_row_rel(rid, r1, r2):
- if r1 == r2:
- return var_const(True)
-
- [sr1, sr2] = sorted([r1, r2])
- return vpool.id(('row_rel', rid, sr1, sr2))
-
-
-# Voor elke relatie, en elke equivalentie-klasse, kiezen we precies 1 rij
-# als representant. Deze variabele geeft aan welk element.
-def var_row_rep(rid, r):
- return vpool.id(('row_rep', rid, r))
-
-
-# Contraints zodat de relatie een equivalentie relatie is. We hoeven alleen
-# maar transitiviteit te encoderen, want refl en symm zijn ingebouwd in de var.
-# Dit stukje van het encoderen duurt het langst.
-print('- transitivity (o)')
-for rid in rids:
- for xo in os:
- for yo in os:
- for zo in os:
- # als xo R yo en yo R zo dan xo R zo
- cnf.append([-var_rel(rid, xo, yo), -var_rel(rid, yo, zo), var_rel(rid, xo, zo)])
-
-print('- transitivity (r)')
-for rid in rids:
- for rx in rows:
- for ry in rows:
- for rz in rows:
- # als rx R ry en ry R rz dan rx R rz
- cnf.append([-var_row_rel(rid, rx, ry), -var_row_rel(rid, ry, rz), var_row_rel(rid, rx, rz)])
-
-# Constraint zodat de relaties samen alle elementen kunnen onderscheiden.
-# (Aka: the bijbehorende quotienten zijn joint-injective.)
-print('- injectivity (o)')
-for xi, xo in enumerate(os):
- for yo in os[xi + 1 :]:
- # Tenminste een rid moet een verschil maken
- cnf.append([-var_rel(rid, xo, yo) for rid in rids])
-
-# Als outputs equivalent zijn, dan ook sommige rijen, en andersom.
-print('rel <=> row_rel')
-for rid in rids:
- for rx in rows:
- for ry in rows:
- osx = [mealy_sem(machine, rx + c) for c in cols]
- osy = [mealy_sem(machine, ry + c) for c in cols]
- oss = list(zip(osx, osy))
-
- # (ox1 ~ oy1 and ox2 ~ oy2 and ...) => rx ~ ry
- cnf.append([-var_rel(rid, ox, oy) for (ox, oy) in oss] + [var_row_rel(rid, rx, ry)])
-
- # rx ~ ry => oxi ~ oyi
- for ox, oy in oss:
- cnf.append([-var_row_rel(rid, rx, ry), var_rel(rid, ox, oy)])
-
-# De constraints die zorgen dat representanten ook echt representanten zijn.
-print('- representatives (r)')
-for rid in rids:
- for ix, rx in enumerate(rows):
- # Belangrijkste: een element is een representant, of equivalent met een
- # eerder element. We forceren hiermee dat de solver representanten moet
- # kiezen (voor aan de lijst).
- cnf.append([var_row_rep(rid, rx)] + [var_row_rel(rid, rx, ry) for ry in rows[:ix]])
- for ry in rows[:ix]:
- # rx en ry kunnen niet beide een representant zijn, tenzij ze
- # niet gerelateerd zijn.
- cnf.append([-var_row_rep(rid, rx), -var_row_rep(rid, ry), -var_row_rel(rid, rx, ry)])
-
-# Tot slot willen we weinig representanten. Dit doen we met een "atmost"
-# formule. Idealiter zoeken we naar de total_size, maar die staat nu vast.
-print('- representatives at most k')
-cnf_optim = CardEnc.atmost([var_row_rep(rid, rx) for rid in rids for rx in rows], total_size, vpool=vpool)
-cnf.extend(cnf_optim)
-
-
-def print_eqrel(rel, xs):
- print_table(lambda r, c: 'Y' if rel(r, c) else '·', xs, xs)
-
-
-##################################
-# Probleem oplossen met solver :-)
-print('Start solving')
-print('- copying formula')
-with Solver(bootstrap_with=cnf) as solver:
- print('- actual solve')
- sat = solver.solve()
-
- if not sat:
- print('unsat :-(')
- exit()
-
- print('sat :-)')
-
- # Even omzetten in een makkelijkere data structuur
- print('- get model')
- m = solver.get_model()
- model = {}
- for l in m:
- model[abs(l)] = l > 0
-
- for rid in rids:
- print(f'Relation {rid}:')
- print_eqrel(lambda x, y: model[var_rel(rid, x, y)], os)
-
- for rid in rids:
- print(f'Row relation {rid}:')
- print_eqrel(lambda x, y: model[var_row_rel(rid, x, y)], rows)
-
- # print equivalence classes
- count = 0
- for rid in rids:
- print(f'component {rid}')
- # Eerst verzamelen we de representanten
- for r in rows:
- if model[var_row_rep(rid, r)]:
- print(f'- representative row {r}')
- count += 1
-
- # count moet gelijk zijn aan cost
- print(f'total size = {count}')
diff --git a/other/decompose_fsm.py b/py/decompose_fsm.py
similarity index 98%
rename from other/decompose_fsm.py
rename to py/decompose_fsm.py
index 7b9a289..3e627c4 100644
--- a/other/decompose_fsm.py
+++ b/py/decompose_fsm.py
@@ -1,3 +1,6 @@
+# Copyright 2024-2025 Joshua Moerman, Open Universiteit. All rights reserved
+# SPDX-License-Identifier: EUPL-1.2
+
from pysat.solvers import Solver
from pysat.card import CardEnc
from pysat.formula import IDPool
@@ -6,9 +9,6 @@ from pysat.formula import CNF
import math
import argparse
-### Gebruik:
-# Stap 1: pip3 install python-sat
-# Stap 2: python3 decompose_fsm.py -h
parser = argparse.ArgumentParser(description='Decomposes a FSM into smaller components by remapping its outputs. Uses a SAT solver.')
parser.add_argument('-c', '--components', type=int, default=2, help='number of components')
diff --git a/other/decompose_fsm_optimise.py b/py/decompose_fsm_optimise.py
similarity index 99%
rename from other/decompose_fsm_optimise.py
rename to py/decompose_fsm_optimise.py
index 63d04d1..3b30e6b 100644
--- a/other/decompose_fsm_optimise.py
+++ b/py/decompose_fsm_optimise.py
@@ -1,3 +1,6 @@
+# Copyright 2024-2025 Joshua Moerman, Open Universiteit. All rights reserved
+# SPDX-License-Identifier: EUPL-1.2
+
from pysat.solvers import Solver
from pysat.card import ITotalizer
from pysat.formula import IDPool
@@ -6,10 +9,6 @@ import signal
import math
import argparse
-### Gebruik:
-# Stap 1: pip3 install python-sat
-# Stap 2: python3 decompose_fsm.py -h
-
keep_log = True
record_file = './results/log.txt' if keep_log else None
diff --git a/other/decompose_set.py b/py/decompose_set.py
similarity index 97%
rename from other/decompose_set.py
rename to py/decompose_set.py
index c1fd927..b4e8cb8 100644
--- a/other/decompose_set.py
+++ b/py/decompose_set.py
@@ -1,11 +1,11 @@
+# Copyright 2024-2025 Joshua Moerman, Open Universiteit. All rights reserved
+# SPDX-License-Identifier: EUPL-1.2
+
from pysat.solvers import Solver
from pysat.card import CardEnc
from pysat.formula import IDPool
from pysat.formula import CNF
-### Gebruik:
-# Stap 1: pip3 install python-sat
-# Stap 2: python3 decompose_set.py
# Een verzameling X ontbinden in factoren X1 ... Xc, zodat X ⊆ X1 × ... × Xc.
# Hierbij is c een parameter (het aantal componenten), en ook het aantal
diff --git a/other/fsm-examples.py b/py/fsm-examples.py
similarity index 100%
rename from other/fsm-examples.py
rename to py/fsm-examples.py
diff --git a/other/partitions.py b/py/partitions.py
similarity index 100%
rename from other/partitions.py
rename to py/partitions.py
diff --git a/py/requirements.txt b/py/requirements.txt
new file mode 100644
index 0000000..e7de295
--- /dev/null
+++ b/py/requirements.txt
@@ -0,0 +1 @@
+python-sat
diff --git a/results/esm-log.txt b/results/esm-log.txt
new file mode 100644
index 0000000..b14590d
--- /dev/null
+++ b/results/esm-log.txt
@@ -0,0 +1,174 @@
+> other (main*) time python3 decompose_fsm_optimise.py -c 2 -w ~/OneDrive\ -\ Open\ Universiteit/Onderzoek/AutomataWiki/Mealy/ESM/run1/hyp.10.obf.dot
+Input FSM: 674 states, 78 inputs, and 147 outputs
+===============
+Start encoding
+transitivity (o)
+injectivity
+bisimulation modulo rel
+representatives
+weak size constraints 25 674
+===============
+Start solving
+Trying 25 < 349 < 674 up
+Trying 349 < 511 < 674 up
+Trying 511 < 592 < 674 down
+Trying 511 < 551 < 592 down
+Trying 511 < 531 < 551 down
+Trying 511 < 521 < 531 down
+Trying 511 < 516 < 521 down
+Trying 511 < 513 < 516 down
+Trying 511 < 512 < 513 down
+done searching, found bound = 512
+Reduced sizes = [512, 512] = 1024
+===============
+Output mapping:
+ 0 1
+ 5.2-O2.2-O36 cls_0_0 cls_1_0
+ 8 cls_0_0 cls_1_1_u
+ 32 cls_0_0 cls_1_2
+ 40.0 cls_0_1_u cls_1_3_u
+ 22.4-O22.3-O22.2-O22.1-O22.0-O13 cls_0_0 cls_1_4
+ 5.12-O2.12-O35 cls_0_2 cls_1_5_u
+ 40.3 cls_0_3_u cls_1_6_u
+ 3.13 cls_0_4_u cls_1_7
+ 5.1-O2.1-O6-O10 cls_0_5_u cls_1_8
+ 2.23 cls_0_6 cls_1_9
+ 9 cls_0_0 cls_1_10_u
+ 40.4 cls_0_0 cls_1_11_u
+ 3.0 cls_0_7_u cls_1_12
+ 2.8-O38 cls_0_8_u cls_1_13
+ 3.3 cls_0_9_u cls_1_12
+ 5.10 cls_0_0 cls_1_14_u
+ 5.1-O2.1-O6-O36 cls_0_10 cls_1_15
+ 5.23-O2.23-O10 cls_0_0 cls_1_16_u
+ 2.3 cls_0_11_u cls_1_13
+ 24.4-O24.3-O24.2-O24.1-O24.0 cls_0_0 cls_1_17_u
+ 2.14 cls_0_0 cls_1_18_u
+ 3.1 cls_0_12_u cls_1_12
+ 3.19 cls_0_13 cls_1_12
+ 10-O5.2-O2.2 cls_0_14_u cls_1_19_u
+ 21.4-O21.3-O21.2-O21.1-O21.0 cls_0_0 cls_1_20_u
+ 3.21 cls_0_15_u cls_1_7
+ 3.12 cls_0_16_u cls_1_12
+ 5.3-O2.3-O10 cls_0_17_u cls_1_21
+ 39.3 cls_0_18_u cls_1_22_u
+ 3.8 cls_0_19_u cls_1_12
+ 25.4-O25.3-O25.2-O25.1-O25.0 cls_0_0 cls_1_23
+ 5.0-O2.0-O5.8-O2.8-O38 cls_0_20_u cls_1_23
+ 3.6 cls_0_21_u cls_1_12
+ 5.0-O2.0 cls_0_22_u cls_1_2
+ 5.3-O2.3-O5.9-O2.9-O33 cls_0_23_u cls_1_24
+ 5.7-O2.7-O37 cls_0_0 cls_1_25_u
+ 39.1 cls_0_24_u cls_1_26_u
+ 5.14 cls_0_0 cls_1_27
+ 5.3-O2.3 cls_0_25_u cls_1_4
+ 2.13 cls_0_2 cls_1_24
+ 2.0 cls_0_26_u cls_1_13
+ 3.7 cls_0_27_u cls_1_12
+ 2.2 cls_0_0 cls_1_28
+ 3.4 cls_0_28_u cls_1_7
+ 2.17 cls_0_29 cls_1_29
+ 5.3 cls_0_30_u cls_1_30
+ 5.23-O2.23-O36 cls_0_0 cls_1_31
+ 5.4-O2.4 cls_0_0 cls_1_32_u
+ 40.2 cls_0_31_u cls_1_33_u
+ 13-O34 cls_0_0 cls_1_34_u
+ 5.2-O2.2 cls_0_2 cls_1_35_u
+ 5.9-O2.9-O33 cls_0_0 cls_1_36_u
+ 2.23-O36 cls_0_32_u cls_1_27
+ 5.13-O2.13-O28.0 cls_0_2 cls_1_37_u
+ 5.23-O2.23 cls_0_0 cls_1_38_u
+ 2.6 cls_0_0 cls_1_39_u
+ 2.1-O6-O2.12-O35 cls_0_33_u cls_1_0
+ 2.3-O10 cls_0_34_u cls_1_40
+ 5.8-O2.8-O38 cls_0_35_u cls_1_41
+ 5.2-O2.2-O10 cls_0_0 cls_1_21
+ 28.3 cls_0_0 cls_1_42_u
+ 5.4 cls_0_0 cls_1_43_u
+ 39.5 cls_0_36_u cls_1_44_u
+ 2.10-O36 cls_0_0 cls_1_45_u
+ 23.4-O23.3-O23.2-O23.1-O23.0 cls_0_37 cls_1_28
+ 2.1-O6-O10 cls_0_38_u cls_1_46_u
+ 5.1 cls_0_39 cls_1_47
+ 2.16 cls_0_0 cls_1_48_u
+ quiescence cls_0_0 cls_1_15
+ 39.4 cls_0_40_u cls_1_49_u
+ 3.10 cls_0_13 cls_1_7
+ 5.7-O2.7-O26.4-O26.3-O26.2-O26.1-O26.0-O13 cls_0_41_u cls_1_2
+ 5.18 cls_0_0 cls_1_50_u
+ 5.1-O2.1-O6-O5.12-O2.12-O35 cls_0_42_u cls_1_4
+ 5.3-O2.3-O36 cls_0_43_u cls_1_40
+ 26.4-O26.3-O26.2-O26.1-O26.0-O13 cls_0_29 cls_1_51_u
+ 18.4-O18.3-O18.2-O18.1-O18.0 cls_0_0 cls_1_52_u
+ 5.12 cls_0_0 cls_1_47
+ 4 cls_0_0 cls_1_53_u
+ 2.1 cls_0_0 cls_1_8
+ 16-O12-O12-O12-O12-O12-O12-O12-O12 cls_0_44_u cls_1_54_u
+ 2.0-O2.8-O38 cls_0_45_u cls_1_13
+ 2.18 cls_0_0 cls_1_55_u
+ 5.7 cls_0_46 cls_1_47
+ 3.17 cls_0_47_u cls_1_12
+ 2.10 cls_0_0 cls_1_56_u
+ 2.12-O35 cls_0_0 cls_1_57
+ 2.1-O13-O34 cls_0_48_u cls_1_57
+ 2.12 cls_0_0 cls_1_29
+ 35 cls_0_0 cls_1_58_u
+ 27.4-O27.3-O27.2-O27.1-O27.0 cls_0_49_u cls_1_41
+ 2.2-O18.4-O18.3-O18.2-O18.1-O18.0 cls_0_0 cls_1_59_u
+ 3.9 cls_0_50 cls_1_12
+ 39.0 cls_0_51_u cls_1_60_u
+ 5.0 cls_0_46 cls_1_30
+ 2.2-O36 cls_0_0 cls_1_24
+ 7 cls_0_10 cls_1_41
+ 3.20 cls_0_52_u cls_1_12
+ 2.7-O37 cls_0_0 cls_1_61_u
+ 2.1-O6 cls_0_53_u cls_1_15
+ 40.1 cls_0_54_u cls_1_62_u
+ 2.9 cls_0_0 cls_1_63_u
+ 2.1-O6-O36 cls_0_55_u cls_1_64_u
+ 2.9-O33 cls_0_0 cls_1_65
+ 19.4-O19.3-O19.2-O19.1-O19.0 cls_0_0 cls_1_66_u
+ 5.10-O2.10 cls_0_0 cls_1_67_u
+ 3.16 cls_0_50 cls_1_68_u
+ 10-O36 cls_0_0 cls_1_13
+ 5.9 cls_0_56 cls_1_30
+ 5.6-O2.6 cls_0_0 cls_1_9
+ 2.3-O2.9-O33 cls_0_57_u cls_1_9
+ 10-O2.2 cls_0_2 cls_1_4
+ 39.2 cls_0_58_u cls_1_69_u
+ 2.7 cls_0_37 cls_1_41
+ 5.2-O2.2-O18.4-O18.3-O18.2-O18.1-O18.0 cls_0_2 cls_1_31
+ 5.1-O2.1 cls_0_0 cls_1_70_u
+ 5.6 cls_0_0 cls_1_30
+ 10 cls_0_0 cls_1_71_u
+ 36 cls_0_0 cls_1_72_u
+ 5.22-O2.22 cls_0_0 cls_1_73_u
+ 2.7-O26.4-O26.3-O26.2-O26.1-O26.0-O13 cls_0_59_u cls_1_2
+ 2.8 cls_0_60_u cls_1_8
+ 3.14 cls_0_50 cls_1_7
+ 5.23 cls_0_2 cls_1_30
+ 5.22 cls_0_46 cls_1_27
+ 5.10-O2.10-O36 cls_0_0 cls_1_74_u
+ 2.21 cls_0_6 cls_1_23
+ 2.4 cls_0_0 cls_1_41
+ 5.1-O2.1-O6 cls_0_61_u cls_1_41
+ 5.17 cls_0_56 cls_1_47
+ 5.16 cls_0_0 cls_1_75_u
+ 2.23-O10 cls_0_0 cls_1_76_u
+ 3.18 cls_0_13 cls_1_77_u
+ 5.1-O2.1-O13-O34 cls_0_2 cls_1_65
+ 10-O5.23-O2.23 cls_0_0 cls_1_78_u
+ 5.2 cls_0_2 cls_1_47
+ 40.5 cls_0_62_u cls_1_79_u
+ 10-O9 cls_0_0 cls_1_80_u
+ 3.2 cls_0_63_u cls_1_12
+ 34 cls_0_0 cls_1_81
+ 5.13 cls_0_2 cls_1_27
+ 2.2-O10 cls_0_0 cls_1_82_u
+ 5.21 cls_0_64_u cls_1_27
+ 2.22 cls_0_0 cls_1_83_u
+ 2.3-O36 cls_0_65_u cls_1_81
+ 28.0 cls_0_6 cls_1_84_u
+ 5.8 cls_0_39 cls_1_30
+python3 decompose_fsm_optimise.py -c 2 -w 12388.54s user 133.05s system 69% cpu 5:00:13.39 total
+> other (main*)
diff --git a/other/results/optimal_decomposition_of_sets.txt b/results/optimal_decomposition_of_sets.txt
similarity index 100%
rename from other/results/optimal_decomposition_of_sets.txt
rename to results/optimal_decomposition_of_sets.txt