commit 1ac6269e50982c0b65aa1c0ad29ea4046d8f31d2 Author: YuhangQ Date: Tue Feb 14 16:58:22 2023 +0800 first commit diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f51de82 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,672 @@ +### GNU GENERAL PUBLIC LICENSE + +Copyright (C) 2018-2020 Shaowei Cai, Zhendong Lei + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ffa94db --- /dev/null +++ b/Makefile @@ -0,0 +1,3 @@ +SATLike3.0: basis_pms.h build.h pms.h heuristic.h pms.cpp + g++ pms.cpp -static -O3 -o SATLike3.0 + rm -f *~ diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/SATLike3.0 b/SATLike3.0 new file mode 100644 index 0000000..56c2585 Binary files /dev/null and b/SATLike3.0 differ diff --git a/basis_pms.h b/basis_pms.h new file mode 100644 index 0000000..34f2b6c --- /dev/null +++ b/basis_pms.h @@ -0,0 +1,183 @@ +#ifndef _BASIS_PMS_H_ +#define _BASIS_PMS_H_ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include //these two h files are for timing in linux +#include + +using namespace std; + +#define mypop(stack) stack[--stack##_fill_pointer] +#define mypush(item, stack) stack[stack##_fill_pointer++] = item + +const float MY_RAND_MAX_FLOAT = 10000000.0; +const int MY_RAND_MAX_INT = 10000000; +const float BASIC_SCALE = 0.0000001; //1.0f/MY_RAND_MAX_FLOAT; + +// Define a data structure for a literal. +struct lit +{ + int clause_num; //clause num, begin with 0 + int var_num; //variable num, begin with 1 + bool sense; //is 1 for true literals, 0 for false literals. +}; + +static struct tms start_time; +static double get_runtime() +{ + struct tms stop; + times(&stop); + return (double)(stop.tms_utime - start_time.tms_utime + stop.tms_stime - start_time.tms_stime) / sysconf(_SC_CLK_TCK); +} +static void start_timing() +{ + times(&start_time); +} + +class Satlike +{ + private: + /***********non-algorithmic information ****************/ + int problem_weighted; + int partial; //1 if the instance has hard clauses, and 0 otherwise. + int pure_sat; + + int max_clause_length; + int min_clause_length; + + //size of the instance + int num_vars; //var index from 1 to num_vars + int num_clauses; //clause index from 0 to num_clauses-1 + int num_hclauses; + int num_sclauses; + + //steps and time + int tries; + int max_tries; + unsigned int max_flips; + unsigned int max_non_improve_flip; + unsigned int step; + + int print_time; + int cutoff_time; + int prioup_time; + double opt_time; + + /**********end non-algorithmic information*****************/ + /* literal arrays */ + lit **var_lit; //var_lit[i][j] means the j'th literal of var i. + int *var_lit_count; //amount of literals of each var + lit **clause_lit; //clause_lit[i][j] means the j'th literal of clause i. + int *clause_lit_count; // amount of literals in each clause + + /* Information about the variables. */ + long long *score; + long long *time_stamp; + int **var_neighbor; + int *var_neighbor_count; + int *neighbor_flag; + int *temp_neighbor; + + /* Information about the clauses */ + long long top_clause_weight; + long long *org_clause_weight; + long long total_soft_weight; + long long *clause_weight; + int *sat_count; + int *sat_var; + long long *clause_selected_count; + int *best_soft_clause; + + //original unit clause stack + lit *unit_clause; + int unit_clause_count; + + //unsat clauses stack + int *hardunsat_stack; //store the unsat clause number + int *index_in_hardunsat_stack; //which position is a clause in the unsat_stack + int hardunsat_stack_fill_pointer; + + int *softunsat_stack; //store the unsat clause number + int *index_in_softunsat_stack; //which position is a clause in the unsat_stack + int softunsat_stack_fill_pointer; + + //variables in unsat clauses + int *unsatvar_stack; + int unsatvar_stack_fill_pointer; + int *index_in_unsatvar_stack; + int *unsat_app_count; //a varible appears in how many unsat clauses + + //good decreasing variables (dscore>0 and confchange=1) + int *goodvar_stack; + int goodvar_stack_fill_pointer; + int *already_in_goodvar_stack; + + /* Information about solution */ + int *cur_soln; //the current solution, with 1's for True variables, and 0's for False variables + int *best_soln; + int *local_opt_soln; + int best_soln_feasible; //when find a feasible solution, this is marked as 1. + int local_soln_feasible; + int hard_unsat_nb; + long long soft_unsat_weight; + long long opt_unsat_weight; + long long local_opt_unsat_weight; + + //clause weighting + int *large_weight_clauses; + int large_weight_clauses_count; + int large_clause_count_threshold; + + int *soft_large_weight_clauses; + int *already_in_soft_large_weight_stack; + int soft_large_weight_clauses_count; + int soft_large_clause_count_threshold; + + //tem data structure used in algorithm + int *best_array; + int best_count; + int *temp_lit; + + //parameters used in algorithm + float rwprob; + float rdprob; + float smooth_probability; + int hd_count_threshold; + int h_inc; + int softclause_weight_threshold; + + //function used in algorithm + void build_neighbor_relation(); + void allocate_memory(); + bool verify_sol(); + void increase_weights(); + void smooth_weights(); + void update_clause_weights(); + void unsat(int clause); + void sat(int clause); + void init(vector &init_solution); + void flip(int flipvar); + void update_goodvarstack1(int flipvar); + void update_goodvarstack2(int flipvar); + int pick_var(); + + public: + Satlike(); + void settings(); + void build_instance(char *filename); + void local_search(char *inputfile); + void local_search_with_decimation(char *inputfile); + void simple_print(); + void print_best_solution(); + void free_memory(); +}; + +#endif diff --git a/build.h b/build.h new file mode 100644 index 0000000..78ac267 --- /dev/null +++ b/build.h @@ -0,0 +1,388 @@ +#ifndef _BUILD_H_ +#define _BUILD_H_ + +#include "basis_pms.h" + +Satlike::Satlike() {} + +void Satlike::settings() +{ + cutoff_time = 60; + if (problem_weighted == 1) + { + max_tries = 100000000; + max_flips = 200000000; + max_non_improve_flip = 10000000; + + large_clause_count_threshold = 0; + soft_large_clause_count_threshold = 0; + + rdprob = 0.01; + hd_count_threshold = 15; + rwprob = 0.1; + smooth_probability = 0.01; + + if ((top_clause_weight / num_sclauses) > 10000) + { + h_inc = 300; + softclause_weight_threshold = 500; + } + else + { + h_inc = 3; + softclause_weight_threshold = 0; + } + + if (num_vars > 2000) + { + rdprob = 0.01; + hd_count_threshold = 15; + rwprob = 0.1; + smooth_probability = 0.0000001; + } + } + else + { + max_tries = 100000000; + max_flips = 200000000; + max_non_improve_flip = 10000000; + + large_clause_count_threshold = 0; + soft_large_clause_count_threshold = 0; + + rdprob = 0.01; + hd_count_threshold = 42; + rwprob = 0.091; + smooth_probability = 0.000003; + + h_inc = 1; + softclause_weight_threshold = 400; + + if (num_vars < 1100) //for somall instances + { + h_inc = 1; + softclause_weight_threshold = 0; + rdprob = 0.01; + hd_count_threshold = 15; + rwprob = 0; + smooth_probability = 0.01; + return; + } + } +} + +void Satlike::build_neighbor_relation() +{ + int i, j, count; + int v, c, n; + int temp_neighbor_count; + + for (v = 1; v <= num_vars; ++v) + { + neighbor_flag[v] = 1; + temp_neighbor_count = 0; + + for (i = 0; i < var_lit_count[v]; ++i) + { + c = var_lit[v][i].clause_num; + for (j = 0; j < clause_lit_count[c]; ++j) + { + n = clause_lit[c][j].var_num; + if (neighbor_flag[n] != 1) + { + neighbor_flag[n] = 1; + temp_neighbor[temp_neighbor_count++] = n; + } + } + } + + neighbor_flag[v] = 0; + + var_neighbor[v] = new int[temp_neighbor_count]; + var_neighbor_count[v] = temp_neighbor_count; + + count = 0; + for (i = 0; i < temp_neighbor_count; i++) + { + var_neighbor[v][count++] = temp_neighbor[i]; + neighbor_flag[temp_neighbor[i]] = 0; + } + } +} + +void Satlike::build_instance(char *filename) +{ + istringstream iss; + string line; + char tempstr1[10]; + char tempstr2[10]; + + ifstream infile(filename); + if (!infile) + { + cout << "c the input filename " << filename << " is invalid, please input the correct filename." << endl; + exit(-1); + } + + /*** build problem data structures of the instance ***/ + while (getline(infile, line)) + { + if (line[0] == 'p') + { + int read_items; + num_vars = num_clauses = 0; + read_items = sscanf(line.c_str(), "%s %s %d %d %lld", tempstr1, tempstr2, &num_vars, &num_clauses, &top_clause_weight); + + if (read_items < 5) + { + cout << "read item < 5 " << endl; + exit(-1); + } + break; + } + } + + allocate_memory(); + + int v, c; + for (c = 0; c < num_clauses; c++) + { + clause_lit_count[c] = 0; + clause_lit[c] = NULL; + } + for (v = 1; v <= num_vars; ++v) + { + var_lit_count[v] = 0; + var_lit[v] = NULL; + var_neighbor[v] = NULL; + } + + int cur_lit; + c = 0; + problem_weighted = 0; + partial = 0; + num_hclauses = num_sclauses = 0; + max_clause_length = 0; + min_clause_length = 100000000; + unit_clause_count = 0; + + int *redunt_test = new int[num_vars + 1]; + memset(redunt_test, 0, sizeof(int) * num_vars + 1); + //Now, read the clauses, one at a time. + while (getline(infile, line)) + { + if (line[0] == 'c') + continue; + else + { + iss.clear(); + iss.str(line); + iss.seekg(0, ios::beg); + } + clause_lit_count[c] = 0; + + iss >> org_clause_weight[c]; + if (org_clause_weight[c] != top_clause_weight) + { + if (org_clause_weight[c] != 1) + problem_weighted = 1; + total_soft_weight += org_clause_weight[c]; + num_sclauses++; + } + else + { + num_hclauses++; + partial = 1; + } + + iss >> cur_lit; + int clause_reduent = 0; + while (cur_lit != 0) + { + if (redunt_test[abs(cur_lit)] == 0) + { + temp_lit[clause_lit_count[c]] = cur_lit; + clause_lit_count[c]++; + redunt_test[abs(cur_lit)] = cur_lit; + } + else if (redunt_test[abs(cur_lit)] != cur_lit) + { + clause_reduent = 1; + break; + } + iss >> cur_lit; + } + if (clause_reduent == 1) + { + for (int i = 0; i < clause_lit_count[c]; ++i) + redunt_test[abs(temp_lit[i])] = 0; + + num_clauses--; + clause_lit_count[c] = 0; + continue; + } + + clause_lit[c] = new lit[clause_lit_count[c] + 1]; + + int i; + for (i = 0; i < clause_lit_count[c]; ++i) + { + clause_lit[c][i].clause_num = c; + clause_lit[c][i].var_num = abs(temp_lit[i]); + redunt_test[abs(temp_lit[i])] = 0; + if (temp_lit[i] > 0) + clause_lit[c][i] + .sense = 1; + else + clause_lit[c][i].sense = 0; + + var_lit_count[clause_lit[c][i].var_num]++; + } + clause_lit[c][i].var_num = 0; + clause_lit[c][i].clause_num = -1; + + if (clause_lit_count[c] == 1) + unit_clause[unit_clause_count++] = clause_lit[c][0]; + + if (clause_lit_count[c] > max_clause_length) + max_clause_length = clause_lit_count[c]; + + if (clause_lit_count[c] < min_clause_length) + min_clause_length = clause_lit_count[c]; + + c++; + } + + infile.close(); + + //creat var literal arrays + for (v = 1; v <= num_vars; ++v) + { + var_lit[v] = new lit[var_lit_count[v] + 1]; + var_lit_count[v] = 0; //reset to 0, for build up the array + } + //scan all clauses to build up var literal arrays + for (c = 0; c < num_clauses; ++c) + { + for (int i = 0; i < clause_lit_count[c]; ++i) + { + v = clause_lit[c][i].var_num; + var_lit[v][var_lit_count[v]] = clause_lit[c][i]; + ++var_lit_count[v]; + } + } + for (v = 1; v <= num_vars; ++v) + var_lit[v][var_lit_count[v]].clause_num = -1; + + build_neighbor_relation(); + + best_soln_feasible = 0; +} + +void Satlike::allocate_memory() +{ + int malloc_var_length = num_vars + 10; + int malloc_clause_length = num_clauses + 10; + + unit_clause = new lit[malloc_clause_length]; + + var_lit = new lit *[malloc_var_length]; + var_lit_count = new int[malloc_var_length]; + clause_lit = new lit *[malloc_clause_length]; + clause_lit_count = new int[malloc_clause_length]; + + score = new long long[malloc_var_length]; + var_neighbor = new int *[malloc_var_length]; + var_neighbor_count = new int[malloc_var_length]; + time_stamp = new long long[malloc_var_length]; + neighbor_flag = new int[malloc_var_length]; + temp_neighbor = new int[malloc_var_length]; + + org_clause_weight = new long long[malloc_clause_length]; + clause_weight = new long long[malloc_clause_length]; + sat_count = new int[malloc_clause_length]; + sat_var = new int[malloc_clause_length]; + clause_selected_count = new long long[malloc_clause_length]; + best_soft_clause = new int[malloc_clause_length]; + + hardunsat_stack = new int[malloc_clause_length]; + index_in_hardunsat_stack = new int[malloc_clause_length]; + softunsat_stack = new int[malloc_clause_length]; + index_in_softunsat_stack = new int[malloc_clause_length]; + + unsatvar_stack = new int[malloc_var_length]; + index_in_unsatvar_stack = new int[malloc_var_length]; + unsat_app_count = new int[malloc_var_length]; + + goodvar_stack = new int[malloc_var_length]; + already_in_goodvar_stack = new int[malloc_var_length]; + + cur_soln = new int[malloc_var_length]; + best_soln = new int[malloc_var_length]; + local_opt_soln = new int[malloc_var_length]; + + large_weight_clauses = new int[malloc_clause_length]; + soft_large_weight_clauses = new int[malloc_clause_length]; + already_in_soft_large_weight_stack = new int[malloc_clause_length]; + + best_array = new int[malloc_var_length]; + temp_lit = new int[malloc_var_length]; +} + +void Satlike::free_memory() +{ + int i; + for (i = 0; i < num_clauses; i++) + delete[] clause_lit[i]; + + for (i = 1; i <= num_vars; ++i) + { + delete[] var_lit[i]; + delete[] var_neighbor[i]; + } + + delete[] var_lit; + delete[] var_lit_count; + delete[] clause_lit; + delete[] clause_lit_count; + + delete[] score; + delete[] var_neighbor; + delete[] var_neighbor_count; + delete[] time_stamp; + delete[] neighbor_flag; + delete[] temp_neighbor; + + delete[] org_clause_weight; + delete[] clause_weight; + delete[] sat_count; + delete[] sat_var; + delete[] clause_selected_count; + delete[] best_soft_clause; + + delete[] hardunsat_stack; + delete[] index_in_hardunsat_stack; + delete[] softunsat_stack; + delete[] index_in_softunsat_stack; + + delete[] unsatvar_stack; + delete[] index_in_unsatvar_stack; + delete[] unsat_app_count; + + delete[] goodvar_stack; + delete[] already_in_goodvar_stack; + + //delete [] fix; + delete[] cur_soln; + delete[] best_soln; + delete[] local_opt_soln; + + delete[] large_weight_clauses; + delete[] soft_large_weight_clauses; + delete[] already_in_soft_large_weight_stack; + + delete[] best_array; + delete[] temp_lit; +} + +#endif diff --git a/deci.h b/deci.h new file mode 100644 index 0000000..77965c9 --- /dev/null +++ b/deci.h @@ -0,0 +1,415 @@ +#ifndef _DECI_H_ +#define _DECI_H_ + +#include "basis_pms.h" + +using namespace std; + +class Decimation +{ + public: + Decimation(lit **ls_var_lit, int *ls_var_lit_count, lit **ls_clause_lit, long long *ls_org_clause_weight, long long ls_top_clause_weight); + + void make_space(int max_c, int max_v); + void free_memory(); + void init(int *ls_local_opt, int *ls_global_opt, lit *ls_unit_clause, int ls_unit_clause_count, int *ls_clause_lit_count); + void push_unit_clause_to_queue(lit tem_l); + void assign(int v, int sense); + void remove_unassigned_var(int v); + void hunit_propagation(); + void sunit_propagation(); + void random_propagation(); + void unit_prosess(); + bool choose_sense(int v); + + vector fix; + + int num_vars; + int num_clauses; + + long long *h_true_score; + long long *h_false_score; + long long *hscore; + long long *s_true_score; + long long *s_false_score; + long long *sscore; + + lit **clause_lit; + lit **var_lit; + int *var_lit_count; + + int *local_opt; + int *global_opt; + long long *org_clause_weight; + long long top_clause_weight; + + lit *hunit_clause_queue; + int *sense_in_hunit_clause_queue; + int hunit_beg_pointer; + int hunit_end_pointer; + + lit *sunit_clause_queue; + int *sense_in_sunit_clause_queue; + int sunit_beg_pointer; + int sunit_end_pointer; + + int *unassigned_var; + int *index_in_unassigned_var; + int unassigned_var_count; + + int *clause_delete; + int *clause_lit_count; +}; + +Decimation::Decimation(lit **ls_var_lit, int *ls_var_lit_count, lit **ls_clause_lit, long long *ls_org_clause_weight, long long ls_top_clause_weight) +{ + var_lit = ls_var_lit; + var_lit_count = ls_var_lit_count; + clause_lit = ls_clause_lit; + org_clause_weight = ls_org_clause_weight; + top_clause_weight = ls_top_clause_weight; +} + +void Decimation::make_space(int max_c, int max_v) +{ + num_vars = max_v; + num_clauses = max_c; + + max_c += 10; + max_v += 10; + + h_true_score = new long long[max_v]; + h_false_score = new long long[max_v]; + hscore = new long long[max_v]; + s_true_score = new long long[max_v]; + s_false_score = new long long[max_v]; + sscore = new long long[max_v]; + + fix.resize(max_v); + fix.reserve(max_v); + + hunit_clause_queue = new lit[max_v]; + sense_in_hunit_clause_queue = new int[max_v]; + + sunit_clause_queue = new lit[max_v]; + sense_in_sunit_clause_queue = new int[max_v]; + + unassigned_var = new int[max_v]; + index_in_unassigned_var = new int[max_v]; + + clause_delete = new int[max_c]; + clause_lit_count = new int[max_c]; +} + +void Decimation::free_memory() +{ + fix.clear(); + delete[] h_true_score; + delete[] h_false_score; + delete[] hscore; + delete[] s_true_score; + delete[] s_false_score; + delete[] sscore; + + delete[] hunit_clause_queue; + delete[] sense_in_hunit_clause_queue; + + delete[] sunit_clause_queue; + delete[] sense_in_sunit_clause_queue; + + delete[] unassigned_var; + delete[] index_in_unassigned_var; + + delete[] clause_delete; + delete[] clause_lit_count; +} + +void Decimation::init(int *ls_local_opt, int *ls_global_opt, lit *ls_unit_clause, int ls_unit_clause_count, int *ls_clause_lit_count) +{ + int v; + int c; + //parameters used in decimation + hunit_beg_pointer = 0; + hunit_end_pointer = 0; + + sunit_beg_pointer = 0; + sunit_end_pointer = 0; + + unassigned_var_count = num_vars; + + //data structure of the instance + local_opt = ls_local_opt; + global_opt = ls_global_opt; + + for (int i = 0; i < num_vars; ++i) + { + v = i + 1; + unassigned_var[i] = v; + index_in_unassigned_var[v] = i; + + fix[v] = -1; + sense_in_hunit_clause_queue[v] = -1; // not in hunit queue + sense_in_sunit_clause_queue[v] = -1; // not in sunit queue + } + + for (int i = 0; i < num_clauses; ++i) + { + clause_lit_count[i] = ls_clause_lit_count[i]; + clause_delete[i] = 0; + } + + for (int i = 0; i < ls_unit_clause_count; ++i) + { + push_unit_clause_to_queue(ls_unit_clause[i]); + } + + //figout score + for (v = 1; v <= num_vars; ++v) + { + h_false_score[v] = 0; + h_true_score[v] = 0; + s_false_score[v] = 0; + s_true_score[v] = 0; + for (int i = 0; i < var_lit_count[v]; ++i) + { + c = var_lit[v][i].clause_num; + if (org_clause_weight[c] == top_clause_weight) + { + if (var_lit[v][i].sense == 1) + ++h_true_score[v]; + else + ++h_false_score[v]; + } + else + { + if (var_lit[v][i].sense == 1) + s_true_score[v] += org_clause_weight[c]; + else + s_false_score[v] += org_clause_weight[c]; + } + } + hscore[v] = max(h_false_score[v], h_true_score[v]); + sscore[v] = max(s_false_score[v], s_true_score[v]); + } +} + +void Decimation::push_unit_clause_to_queue(lit tem_l) +{ + int v = tem_l.var_num; + int c = tem_l.clause_num; + if (org_clause_weight[c] == top_clause_weight) + { + if (sense_in_hunit_clause_queue[v] == -1) + { + sense_in_hunit_clause_queue[v] = tem_l.sense; + hunit_clause_queue[hunit_end_pointer++] = tem_l; + } + else + { + if (sense_in_hunit_clause_queue[v] != tem_l.sense) //conflict var in hard unit queue + { + sense_in_hunit_clause_queue[v] = -2; //means this variable is conflict in hard unit queue + } + } + } + else + { + if (sense_in_hunit_clause_queue[v] != -1) + return; //be defined by hard unit queue + + if (sense_in_sunit_clause_queue[v] == -1) + { + sense_in_sunit_clause_queue[v] = tem_l.sense; + sunit_clause_queue[sunit_end_pointer++] = tem_l; + } + else + { + if (sense_in_sunit_clause_queue[v] != tem_l.sense) //conflict var in hard unit queue + { + sense_in_sunit_clause_queue[v] = -3; //means this variable is conflict in hard unit queue + } + } + } +} + +void Decimation::remove_unassigned_var(int v) +{ + int index = index_in_unassigned_var[v]; + int last_var = unassigned_var[--unassigned_var_count]; + unassigned_var[index] = last_var; + index_in_unassigned_var[last_var] = index; +} + +void Decimation::assign(int v, int sense) +{ + int c, l; + lit tem_lit; + fix[v] = sense; + remove_unassigned_var(v); + + for (int i = 0; i < var_lit_count[v]; ++i) + { + c = var_lit[v][i].clause_num; + if (clause_delete[c] == 1) + continue; + + if (sense == var_lit[v][i].sense) + { + clause_delete[c] = 1; + if (org_clause_weight[c] == top_clause_weight) + { + for (int j = 0; j < clause_lit_count[c]; j++) + { + tem_lit = clause_lit[c][j]; + if (tem_lit.sense == 1) + { + h_true_score[tem_lit.var_num]--; + } + else + h_false_score[tem_lit.var_num]--; + hscore[tem_lit.var_num] = max(h_true_score[tem_lit.var_num], h_false_score[tem_lit.var_num]); + } + } + else + { + for (int j = 0; j < clause_lit_count[c]; j++) + { + tem_lit = clause_lit[c][j]; + if (tem_lit.sense == 1) + { + s_true_score[tem_lit.var_num] -= org_clause_weight[c]; + } + else + s_false_score[tem_lit.var_num] -= org_clause_weight[c]; + sscore[tem_lit.var_num] = max(s_true_score[tem_lit.var_num], s_false_score[tem_lit.var_num]); + } + } + continue; + } + + for (int j = 0; j < clause_lit_count[c]; j++) + { + if (clause_lit[c][j].var_num == v) + { + swap(clause_lit[c][j], clause_lit[c][--clause_lit_count[c]]); + break; + } + } + if (clause_lit_count[c] == 1) + { + push_unit_clause_to_queue(clause_lit[c][0]); + } + } +} + +bool Decimation::choose_sense(int v) +{ + return rand() % 2; +} + +void Decimation::hunit_propagation() +{ + int v, c, sense, rd; + + v = hunit_clause_queue[hunit_beg_pointer].var_num; + sense = hunit_clause_queue[hunit_beg_pointer].sense; + hunit_beg_pointer++; + + if (sense_in_hunit_clause_queue[v] == -2) + { + if (sscore[v] > 0) + { + if (sscore[v] == s_true_score[v]) + sense = 1; + else + sense = 0; + } + else + { + sense = choose_sense(v); + } + } + assign(v, sense); +} + +void Decimation::sunit_propagation() +{ + int v, c, sense, rd; + + int ht; + ht = 15; + + int best_v = sunit_clause_queue[sunit_beg_pointer].var_num; + int best_score = sscore[best_v]; + int index = sunit_beg_pointer; + int count = sunit_end_pointer - sunit_beg_pointer; + if (count > 15) + { + for (int i = 0; i < 15; ++i) + { + rd = rand() % count; + + v = sunit_clause_queue[sunit_beg_pointer + rd].var_num; + if (sscore[v] > best_score) + { + best_v = v; + index = sunit_beg_pointer + rd; + } + } + } + else + { + for (int i = sunit_beg_pointer; i < sunit_end_pointer; ++i) + { + v = sunit_clause_queue[i].var_num; + if (sscore[v] > best_score) + { + best_v = v; + index = i; + } + } + } + swap(sunit_clause_queue[sunit_beg_pointer], sunit_clause_queue[index]); + v = sunit_clause_queue[sunit_beg_pointer].var_num; + sense = sunit_clause_queue[sunit_beg_pointer].sense; + sunit_beg_pointer++; + + if (fix[v] != -1) + return; + + if (sense_in_sunit_clause_queue[v] == -3) + { + sense = choose_sense(v); + } + assign(v, sense); +} + +void Decimation::random_propagation() +{ + int v, sense; + v = unassigned_var[rand() % unassigned_var_count]; + sense = rand() % 2; + assign(v, sense); +} + +void Decimation::unit_prosess() +{ + + while (unassigned_var_count > 0) + { + if (hunit_beg_pointer != hunit_end_pointer) + { + hunit_propagation(); + } + else if (sunit_beg_pointer != sunit_end_pointer) + { + sunit_propagation(); + } + else + { + random_propagation(); + } + } +} + +#endif diff --git a/heuristic.h b/heuristic.h new file mode 100644 index 0000000..ffd59d6 --- /dev/null +++ b/heuristic.h @@ -0,0 +1,407 @@ +#ifndef _HEURISTIC_H_ +#define _HEURISTIC_H_ + +#include "basis_pms.h" +#include "deci.h" + +void Satlike::init(vector &init_solution) +{ + soft_large_weight_clauses_count = 0; + //Initialize clause information + for (int c = 0; c < num_clauses; c++) + { + already_in_soft_large_weight_stack[c] = 0; + clause_selected_count[c] = 0; + + if (org_clause_weight[c] == top_clause_weight) + clause_weight[c] = 1; + else + { + if (best_soln_feasible == 0) + { + clause_weight[c] = 0; + } + else + { + clause_weight[c] = org_clause_weight[c]; + if (clause_weight[c] > 1 && already_in_soft_large_weight_stack[c] == 0) + { + already_in_soft_large_weight_stack[c] = 1; + soft_large_weight_clauses[soft_large_weight_clauses_count++] = c; + } + } + } + } + + //init solution + if (best_soln_feasible == 1) + { + best_soln_feasible = 2; + for (int v = 1; v <= num_vars; v++) + { + //cur_soln[v] = rand() % 2; + time_stamp[v] = 0; + unsat_app_count[v] = 0; + } + } + else if (init_solution.size() == 0) + { + for (int v = 1; v <= num_vars; v++) + { + cur_soln[v] = rand() % 2; + time_stamp[v] = 0; + unsat_app_count[v] = 0; + } + } + else + { + for (int v = 1; v <= num_vars; v++) + { + cur_soln[v] = init_solution[v]; + if (cur_soln[v] != 0 && cur_soln[v] != 1) + cur_soln[v] = rand() % 2; + time_stamp[v] = 0; + unsat_app_count[v] = 0; + } + } + + //init stacks + hard_unsat_nb = 0; + soft_unsat_weight = 0; + hardunsat_stack_fill_pointer = 0; + softunsat_stack_fill_pointer = 0; + unsatvar_stack_fill_pointer = 0; + large_weight_clauses_count = 0; + + /* figure out sat_count, sat_var and init unsat_stack */ + for (int c = 0; c < num_clauses; ++c) + { + sat_count[c] = 0; + for (int j = 0; j < clause_lit_count[c]; ++j) + { + if (cur_soln[clause_lit[c][j].var_num] == clause_lit[c][j].sense) + { + sat_count[c]++; + sat_var[c] = clause_lit[c][j].var_num; + } + } + if (sat_count[c] == 0) + { + unsat(c); + } + } + + /*figure out score*/ + for (int v = 1; v <= num_vars; v++) + { + score[v] = 0; + for (int i = 0; i < var_lit_count[v]; ++i) + { + int c = var_lit[v][i].clause_num; + if (sat_count[c] == 0) + score[v] += clause_weight[c]; + else if (sat_count[c] == 1 && var_lit[v][i].sense == cur_soln[v]) + score[v] -= clause_weight[c]; + } + } + + //init goodvars stack + goodvar_stack_fill_pointer = 0; + for (int v = 1; v <= num_vars; v++) + { + if (score[v] > 0) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + else + already_in_goodvar_stack[v] = -1; + } + + //cout << goodvar_stack_fill_pointer << endl; + //cout << hard_unsat_nb << endl; + //cout << soft_unsat_weight << endl; +} + +int Satlike::pick_var() +{ + int i, v; + int best_var; + + if (goodvar_stack_fill_pointer > 0) + { + if ((rand() % MY_RAND_MAX_INT) * BASIC_SCALE < rdprob) + return goodvar_stack[rand() % goodvar_stack_fill_pointer]; + + if (goodvar_stack_fill_pointer < hd_count_threshold) + { + best_var = goodvar_stack[0]; + for (i = 1; i < goodvar_stack_fill_pointer; ++i) + { + v = goodvar_stack[i]; + if (score[v] > score[best_var]) + best_var = v; + else if (score[v] == score[best_var]) + { + if (time_stamp[v] < time_stamp[best_var]) + best_var = v; + } + } + return best_var; + } + else + { + best_var = goodvar_stack[rand() % goodvar_stack_fill_pointer]; + for (i = 1; i < hd_count_threshold; ++i) + { + v = goodvar_stack[rand() % goodvar_stack_fill_pointer]; + if (score[v] > score[best_var]) + best_var = v; + else if (score[v] == score[best_var]) + { + if (time_stamp[v] < time_stamp[best_var]) + best_var = v; + } + } + return best_var; + } + } + + update_clause_weights(); + + int sel_c; + lit *p; + + if (hardunsat_stack_fill_pointer > 0) + { + sel_c = hardunsat_stack[rand() % hardunsat_stack_fill_pointer]; + } + else + { + sel_c = softunsat_stack[rand() % softunsat_stack_fill_pointer]; + } + if ((rand() % MY_RAND_MAX_INT) * BASIC_SCALE < rwprob) + return clause_lit[sel_c][rand() % clause_lit_count[sel_c]].var_num; + + best_var = clause_lit[sel_c][0].var_num; + p = clause_lit[sel_c]; + for (p++; (v = p->var_num) != 0; p++) + { + if (score[v] > score[best_var]) + best_var = v; + else if (score[v] == score[best_var]) + { + if (time_stamp[v] < time_stamp[best_var]) + best_var = v; + } + } + + return best_var; +} + +void Satlike::local_search(char *inputfile) +{ + vector init_solution; + settings(); + for (tries = 1; tries < max_tries; ++tries) + { + init(init_solution); + for (step = 1; step < max_flips; ++step) + { + if (hard_unsat_nb == 0 && (soft_unsat_weight < opt_unsat_weight || best_soln_feasible == 0)) + { + if (soft_unsat_weight < opt_unsat_weight) + { + best_soln_feasible = 1; + opt_unsat_weight = soft_unsat_weight; + opt_time = get_runtime(); + for (int v = 1; v <= num_vars; ++v) + best_soln[v] = cur_soln[v]; + } + if (opt_unsat_weight == 0) + return; + } + + if (step % 1000 == 0) + { + double elapse_time = get_runtime(); + if (elapse_time >= cutoff_time) + return; + else if (opt_unsat_weight == 0) + return; + } + + int flipvar = pick_var(); + flip(flipvar); + time_stamp[flipvar] = step; + } + } +} + +void Satlike::local_search_with_decimation(char *inputfile) +{ + settings(); + Decimation deci(var_lit, var_lit_count, clause_lit, org_clause_weight, top_clause_weight); + deci.make_space(num_clauses, num_vars); + + opt_unsat_weight = __LONG_LONG_MAX__; + for (tries = 1; tries < max_tries; ++tries) + { + if (best_soln_feasible != 1) + { + deci.init(local_opt_soln, best_soln, unit_clause, unit_clause_count, clause_lit_count); + deci.unit_prosess(); + init(deci.fix); + } + else + init(deci.fix); + + long long local_opt = __LONG_LONG_MAX__; + max_flips = max_non_improve_flip; + for (step = 1; step < max_flips; ++step) + { + if (hard_unsat_nb == 0) + { + if (local_opt > soft_unsat_weight) + { + local_opt = soft_unsat_weight; + max_flips = step + max_non_improve_flip; + } + if (soft_unsat_weight < opt_unsat_weight) + { + cout << "o " << soft_unsat_weight << endl; + opt_unsat_weight = soft_unsat_weight; + opt_time = get_runtime(); + for (int v = 1; v <= num_vars; ++v) + best_soln[v] = cur_soln[v]; + } + if (best_soln_feasible == 0) + { + best_soln_feasible = 1; + break; + } + } + //if(goodvar_stack_fill_pointer==0) cout<var_num) != 0; p++) + { + score[v] += h_inc; + if (score[v] > 0 && already_in_goodvar_stack[v] == -1) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + } + } + for (i = 0; i < softunsat_stack_fill_pointer; ++i) + { + c = softunsat_stack[i]; + if (clause_weight[c] > softclause_weight_threshold) + continue; + else + clause_weight[c]++; + + if (clause_weight[c] > 1 && already_in_soft_large_weight_stack[c] == 0) + { + already_in_soft_large_weight_stack[c] = 1; + soft_large_weight_clauses[soft_large_weight_clauses_count++] = c; + } + for (lit *p = clause_lit[c]; (v = p->var_num) != 0; p++) + { + score[v]++; + if (score[v] > 0 && already_in_goodvar_stack[v] == -1) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + } + } +} + +void Satlike::smooth_weights() +{ + int i, clause, v; + + for (i = 0; i < large_weight_clauses_count; i++) + { + clause = large_weight_clauses[i]; + if (sat_count[clause] > 0) + { + clause_weight[clause] -= h_inc; + + if (clause_weight[clause] == 1) + { + large_weight_clauses[i] = large_weight_clauses[--large_weight_clauses_count]; + i--; + } + if (sat_count[clause] == 1) + { + v = sat_var[clause]; + score[v] += h_inc; + if (score[v] > 0 && already_in_goodvar_stack[v] == -1) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + } + } + } + + for (i = 0; i < soft_large_weight_clauses_count; i++) + { + clause = soft_large_weight_clauses[i]; + if (sat_count[clause] > 0) + { + clause_weight[clause]--; + if (clause_weight[clause] == 1 && already_in_soft_large_weight_stack[clause] == 1) + { + already_in_soft_large_weight_stack[clause] = 0; + soft_large_weight_clauses[i] = soft_large_weight_clauses[--soft_large_weight_clauses_count]; + i--; + } + if (sat_count[clause] == 1) + { + v = sat_var[clause]; + score[v]++; + if (score[v] > 0 && already_in_goodvar_stack[v] == -1) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + } + } + } +} + +void Satlike::update_clause_weights() +{ + if (((rand() % MY_RAND_MAX_INT) * BASIC_SCALE) < smooth_probability && large_weight_clauses_count > large_clause_count_threshold) + { + smooth_weights(); + } + else + { + increase_weights(); + } +} + +#endif diff --git a/pms.cpp b/pms.cpp new file mode 100644 index 0000000..d3f63ab --- /dev/null +++ b/pms.cpp @@ -0,0 +1,33 @@ +#include "basis_pms.h" +#include "build.h" +#include "pms.h" +#include "heuristic.h" +#include + + +Satlike s; +void interrupt(int sig) +{ + s.print_best_solution(); + s.free_memory(); + exit(10); +} + +int main(int argc, char *argv[]) +{ + start_timing(); + + signal(SIGTERM, interrupt); + + s.build_instance(argv[1]); + + s.settings(); + + s.local_search_with_decimation(argv[1]); + + //s.simple_print(); + + s.free_memory(); + + return 0; +} diff --git a/pms.h b/pms.h new file mode 100644 index 0000000..4d2d850 --- /dev/null +++ b/pms.h @@ -0,0 +1,256 @@ +#ifndef _PMS_H_ +#define _PMS_H_ + +#include "basis_pms.h" +#include "deci.h" + +void Satlike::update_goodvarstack1(int flipvar) +{ + int v; + //remove the vars no longer goodvar in goodvar stack + for (int index = goodvar_stack_fill_pointer - 1; index >= 0; index--) + { + v = goodvar_stack[index]; + if (score[v] <= 0) + { + goodvar_stack[index] = mypop(goodvar_stack); + already_in_goodvar_stack[v] = -1; + } + } + + //add goodvar + for (int i = 0; i < var_neighbor_count[flipvar]; ++i) + { + v = var_neighbor[flipvar][i]; + if (score[v] > 0) + { + if (already_in_goodvar_stack[v] == -1) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + } + } +} +void Satlike::update_goodvarstack2(int flipvar) +{ + if (score[flipvar] > 0 && already_in_goodvar_stack[flipvar] == -1) + { + already_in_goodvar_stack[flipvar] = goodvar_stack_fill_pointer; + mypush(flipvar, goodvar_stack); + } + else if (score[flipvar] <= 0 && already_in_goodvar_stack[flipvar] != -1) + { + int index = already_in_goodvar_stack[flipvar]; + int last_v = mypop(goodvar_stack); + goodvar_stack[index] = last_v; + already_in_goodvar_stack[last_v] = index; + already_in_goodvar_stack[flipvar] = -1; + } + int i, v; + for (i = 0; i < var_neighbor_count[flipvar]; ++i) + { + v = var_neighbor[flipvar][i]; + if (score[v] > 0) + { + if (already_in_goodvar_stack[v] == -1) + { + already_in_goodvar_stack[v] = goodvar_stack_fill_pointer; + mypush(v, goodvar_stack); + } + } + else if (already_in_goodvar_stack[v] != -1) + { + int index = already_in_goodvar_stack[v]; + int last_v = mypop(goodvar_stack); + goodvar_stack[index] = last_v; + already_in_goodvar_stack[last_v] = index; + already_in_goodvar_stack[v] = -1; + } + } +} + +void Satlike::flip(int flipvar) +{ + int i, v, c; + int index; + lit *clause_c; + + int org_flipvar_score = score[flipvar]; + cur_soln[flipvar] = 1 - cur_soln[flipvar]; + + for (i = 0; i < var_lit_count[flipvar]; ++i) + { + c = var_lit[flipvar][i].clause_num; + clause_c = clause_lit[c]; + + if (cur_soln[flipvar] == var_lit[flipvar][i].sense) + { + ++sat_count[c]; + if (sat_count[c] == 2) //sat_count from 1 to 2 + { + score[sat_var[c]] += clause_weight[c]; + } + else if (sat_count[c] == 1) // sat_count from 0 to 1 + { + sat_var[c] = flipvar; //record the only true lit's var + for (lit *p = clause_c; (v = p->var_num) != 0; p++) + { + score[v] -= clause_weight[c]; + } + sat(c); + } + } + else // cur_soln[flipvar] != cur_lit.sense + { + --sat_count[c]; + if (sat_count[c] == 1) //sat_count from 2 to 1 + { + for (lit *p = clause_c; (v = p->var_num) != 0; p++) + { + if (p->sense == cur_soln[v]) + { + score[v] -= clause_weight[c]; + sat_var[c] = v; + break; + } + } + } + else if (sat_count[c] == 0) //sat_count from 1 to 0 + { + for (lit *p = clause_c; (v = p->var_num) != 0; p++) + { + score[v] += clause_weight[c]; + } + unsat(c); + } //end else if + } //end else + } + + //update information of flipvar + score[flipvar] = -org_flipvar_score; + update_goodvarstack1(flipvar); +} + +void Satlike::print_best_solution() +{ + if (best_soln_feasible == 0) + return; + + printf("v"); + for (int i = 1; i <= num_vars; i++) + { + printf(" "); + if (best_soln[i] == 0) + printf("-"); + printf("%d", i); + } + printf("\n"); +} + +bool Satlike::verify_sol() +{ + int c, j, flag; + long long verify_unsat_weight = 0; + + for (c = 0; c < num_clauses; ++c) + { + flag = 0; + for (j = 0; j < clause_lit_count[c]; ++j) + if (best_soln[clause_lit[c][j].var_num] == clause_lit[c][j].sense) + { + flag = 1; + break; + } + + if (flag == 0) + { + if (org_clause_weight[c] == top_clause_weight) //verify hard clauses + { + //output the clause unsatisfied by the solution + cout << "c Error: hard clause " << c << " is not satisfied" << endl; + + cout << "c "; + for (j = 0; j < clause_lit_count[c]; ++j) + { + if (clause_lit[c][j].sense == 0) + cout << "-"; + cout << clause_lit[c][j].var_num << " "; + } + cout << endl; + cout << "c "; + for (j = 0; j < clause_lit_count[c]; ++j) + cout << best_soln[clause_lit[c][j].var_num] << " "; + cout << endl; + return 0; + } + else + { + verify_unsat_weight += org_clause_weight[c]; + } + } + } + + if (verify_unsat_weight == opt_unsat_weight) + return 1; + else + { + cout << "c Error: find opt=" << opt_unsat_weight << ", but verified opt=" << verify_unsat_weight << endl; + } + return 0; +} + +void Satlike::simple_print() +{ + if (best_soln_feasible != 0) + { + if (verify_sol() == 1) + cout << opt_unsat_weight << '\t' << opt_time << endl; + else + cout << "solution is wrong " << endl; + } + else + cout << -1 << '\t' << -1 << endl; +} + +inline void Satlike::unsat(int clause) +{ + if (org_clause_weight[clause] == top_clause_weight) + { + index_in_hardunsat_stack[clause] = hardunsat_stack_fill_pointer; + mypush(clause, hardunsat_stack); + hard_unsat_nb++; + } + else + { + index_in_softunsat_stack[clause] = softunsat_stack_fill_pointer; + mypush(clause, softunsat_stack); + soft_unsat_weight += org_clause_weight[clause]; + } +} + +inline void Satlike::sat(int clause) +{ + int index, last_unsat_clause; + + if (org_clause_weight[clause] == top_clause_weight) + { + last_unsat_clause = mypop(hardunsat_stack); + index = index_in_hardunsat_stack[clause]; + hardunsat_stack[index] = last_unsat_clause; + index_in_hardunsat_stack[last_unsat_clause] = index; + + hard_unsat_nb--; + } + else + { + last_unsat_clause = mypop(softunsat_stack); + index = index_in_softunsat_stack[clause]; + softunsat_stack[index] = last_unsat_clause; + index_in_softunsat_stack[last_unsat_clause] = index; + + soft_unsat_weight -= org_clause_weight[clause]; + } +} + +#endif diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..ea0cacf --- /dev/null +++ b/readme.txt @@ -0,0 +1,11 @@ +Copyright @ 2018-2020 Shaowei Cai, Zhendong Lei +This is SATLike (V3.0). +SATLike is a MaxSAT solver based on local search, which is competitive on industrial instances. + + +To compile the codes: ./make +To run the solver: ./SATLike3.0 + +Reference: +Shaowei Cai, Zhendong Lei: Old techniques in new ways: Clause weighting, unit propagation and hybridization for maximum satisfiability. Artif. Intell. 287: 103354 (2020) +Zhendong Lei, Shaowei Cai: Solving (Weighted) Partial MaxSAT by Dynamic Local Search for SAT. IJCAI 2018: 1346-1352 \ No newline at end of file