commit f987f5af492f2ac9d5aeebd351bcb49175556af2 Author: Sebastiano Tronto <sebastiano@tronto.net> Date: Mon, 29 May 2023 01:06:09 +0200 Initial commit Diffstat:
100 files changed, 3755 insertions(+), 0 deletions(-)
diff --git a/.gitignore b/.gitignore @@ -0,0 +1 @@ +test/*/runtest diff --git a/LICENSE b/LICENSE @@ -0,0 +1,636 @@ +The following license applies to every C source code and header file +distributed with this LICENSE file. + + h48 - a prototype for an optimal rubik's cube solver + Copyright (C) 2023 Sebastiano Tronto <sebastiano@tronto.net> + + 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. + + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. diff --git a/Makefile b/Makefile @@ -0,0 +1,25 @@ +# See LICENSE file for copyright and license details. + +CFLAGS = -std=c99 -pthread -pedantic -Wall -Wextra \ + -Wno-unused-parameter -O3 +DBGFLAGS = -std=c99 -pthread -pedantic -Wall -Wextra \ + -Wno-unused-parameter -Wno-unused-function -g3 \ + -fsanitize=address -fsanitize=undefined + +CC = cc + +all: solve + +solve: clean + ${CC} ${CFLAGS} -o solve src/*.c + +debug: + ${CC} ${DBGFLAGS} -o solve src/*.c + +clean: + rm -rf solve + +test: + ./test/test.sh + +.PHONY: all debug clean test diff --git a/README.md b/README.md @@ -0,0 +1,3 @@ +# Prototype for a new optimal solver + +Work in progress diff --git a/src/cube.c b/src/cube.c @@ -0,0 +1,888 @@ +/* +# Cube representation, moves, transformations and (tentatively) indexing + +## Textual description + +The functions readcube() and writecube() use the following format. +Each edge is represented by two letters denoting the sides it belongs to +and one number denoting its orientation (0 oriented, 1 mis-oriented). +Similarly, each corner is represented by three letters and a number +(0 oriented, 1 twisted clockwise, 2 twisted counter-clockwise). +Edge orientation is relative to the F / B axis, corner orientation is +relative to the U / D axis. + +The correct order of the pieces is the same as that defined in the +section "Internal cube representation", except that pieces are read +left-to-right. Pieces are divided by slices, so the ordering is not the +most intuitive, but it is more convenient for the internal representation. + +Whitespaces between pieces are ignored when reading the cube, and a +single whitespace character is added between pieces when writing. + +For example, the solved cube looks like this: + +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 \ (no newline) +UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 + +The cube after the moves R'U'F looks like this: + +FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0 \ (no newline) +UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0 + +More formats might be supported in the future. + +## Internal cube representation + +The cube_t data structure implemented in this file is designed to +efficiently perform common operations on a 3x3x3 Rubik's cube when +solving it with an iterative-deepening DFS search. It is not the most +general, complete, easy to read or compact one. Since the cube can +be trivially reoriented before the search, we only encode permutations +of the cube that keep the center pieces in a fixed position (that is, +we do not encode the position of the centers). + +The cube state is encoded in two 64-bit integers, one for edges and one +for centers. We explain how edges are encoded first, and the highlight +the few differences with corners afterwards. + +For encoding edges, only the 60 least-significant bits are used. Each +edge described by 5 bits. The position of a 5-bit block in the 64-bit +integer determine the position of the edge piece in the cube, according +to the following table (least-significant bits on the right): + +55-59 50-54 45-49 40-44 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + BR BL FL FR DR DL UL UR DF DB UB UF +ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee + +For each edge, the 4 least-significant bits ('ssee' in the table) +determine the piece. The two bits marked with 'ss' determine the internal +slice the piece belongs to, i.e. they are either '00' for M, '01' for +S or '10' for E. The other two bits (marked with 'ee') determine the +actual edge piece among the 4 in the same slice, and they are assigned +somewhat arbitarily. Using this representation and the ordering defined +in the table above, the edges are correctly permuted when these 4 bits +for each represent the numbers 0 to 11 in the correct order. + +The last bit determines the orientation. The orientation of an edge +depends on its position, and it is defined being 0 if the edge can be +moved to its place in the solved orientation by permutations in the +subgroup <U, D, R, L, F2, B2>. + +Corners are encoded in the 48 least-significant bits, and are described +by 6 bits each, their position being defined by the following table: + + 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + DBL DFL UBR UFL DBR DFL UBL UFR +oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc + +The bit marked with an 'x' describes the axis the corner belongs to. +The 0 axis consists of the corners UFR, UBL, DFL and DBR, and the other +four corners form the axis marked with 1. Then two bits are needed to +identify the corner among the four of the same axis. The last three bits +determine the orientation, where one corner is defined to be oriented +(marked with '000') if its top or bottom sticker faces the top or bottom +side. A corner a clockwise turn away from being oriented, thus requiring +a counter-clockwise turn to be oriented correctly, is marked with '001', +and a corner a counter-clockwise turn away is marked with '010'. The most +significant bit is not used to determine the corner orientation, but it +must always be set to '0' to simplify the moving operations (see below). + +## Basic moves + +The 18 basic moves of the cube could be performed by applying a suitable +general permutation (see below), but they have instead been manually +implemented with a few simple operations each, to improve performance. + +For each move we first permute the pieces. This amounts to shifting +around 4 blocks of bits for edges and 4 for corners. Since in some cases +adjacent pieces on the cube are also adjacent in the bit representation we +use, we can save some operations by shifting multiple blocks together. + +There are some moves that change the orientation of the pieces. Namely, +the moves F, F', B and B' change the orientation of the edges and those +moves as well as R, R', L and L' change the orientation of the corners. +Edge orientation is easy to address: we simply xor the edge representation +by a bit mask with zeroes everywhere except for the 4 edges that need +to be flipped (i.e. the ones on the twisted face). + +Corner orientation is harder to reproduce efficiently working only with +bitwise operations, as it involves performing operations modulo 3. +However, with the help of the extra bit we reserved, we are able to +do this using only two additions and 3 bitwise operations, without +any multiplication, division or modulo operation. The trick is +to use the following formula to sum two numbers x, y in {0,1,2}: + + ((x+y) + (x+y+1)/4) % 4 + +The thrid bit is needed because x+y and x+y+1 can exceed 3. We can +apply this operation to multiple pairs of bits representing ternary +digits at once using binary operations. See the function coapply() +below for the details. + +## Inverting the cube + +TODO + +## Transformations (conjugations by full-cube rotations) + +TODO + +## Indexing (tentative) + +TODO - subgroup description etc + +*/ + +#include <stdbool.h> +#include <stdint.h> +#include <string.h> + +#ifdef DEBUG +#include <stdio.h> +#endif + +#include "cube.h" + +#define _error 0xFFFFFFFF + +#define _eoblock 0x10ULL /* 10000 */ +#define _epblock 0x0FULL /* 01111 */ +#define _eblock 0x1FULL /* 11111 */ +#define _eblock2 0x3FFULL /* 1111111111 */ + +#define _coblock 0x18ULL /* 011000 */ +#define _cpblock 0x07ULL /* 000111 */ +#define _cblock 0x3FULL /* 111111 */ +#define _cblock2 0xFFFULL /* 111111111111 */ + +#define _eomask 0x842108421084210ULL /* 10000 repeated 12 times */ +#define _comask 0x618618618618ULL /* 011000 repeated 8 times */ +#define _coonemask 0x208208208208ULL /* 001000 repeated 8 times */ +#define _coextramask 0x820820820820ULL /* 100000 repeated 8 times */ + +#define _emask_u (_eblock2 | _eblock2 << 20ULL) +#define _emask_d (_eblock2 << 10ULL | _eblock2 << 30ULL) +#define _emask_r (_eblock << 20ULL | _eblock2 << 35ULL | _eblock << 55ULL) +#define _emask_l (_eblock2 << 45ULL | _eblock2 << 25ULL) +#define _emask_f (_eblock | _eblock << 15ULL | _eblock2 << 40ULL) +#define _emask_b (_eblock2 << 5ULL | _eblock2 << 50ULL) + +#define _cmask_u (_cblock2 | _cblock2 << 24ULL) +#define _cmask_d (_cblock2 << 12ULL | _cblock2 << 36ULL) +#define _cmask_r (_cblock | _cblock << 18ULL | _cblock2 << 30ULL) +#define _cmask_l (_cblock2 << 6ULL | _cblock << 24ULL | _cblock << 42ULL) +#define _cmask_f (_cblock | _cblock << 12ULL | _cblock << 24ULL | _cblock << 36ULL) +#define _cmask_b (_cblock << 6ULL | _cblock << 18ULL | _cblock << 30ULL | _cblock << 42ULL) + +#define _eomask_f (1ULL << 4ULL | 1ULL << 19ULL | 1ULL << 44ULL | 1ULL << 49ULL) +#define _eomask_b (1ULL << 9ULL | 1ULL << 14ULL | 1ULL << 54ULL | 1ULL << 59ULL) + +#define _comask_r (2ULL << 3ULL | 1ULL << 33ULL | 2ULL << 21ULL | 1ULL << 39ULL) +#define _comask_l (1ULL << 27ULL | 2ULL << 9ULL | 2ULL << 15ULL | 1ULL << 45ULL) +#define _comask_f (1ULL << 3ULL | 1ULL << 15ULL | 2ULL << 27ULL | 2ULL << 39ULL) +#define _comask_b (1ULL << 9ULL | 1ULL << 21ULL | 2ULL << 33ULL | 2ULL << 45ULL) + +static inline uint64_t coapply(uint64_t, uint64_t); +static uint64_t permsign(uint64_t *, int); +static uint64_t readep(char *); +static uint64_t readeo(char *); +static uint64_t readcp(char *); +static uint64_t readco(char *); +static uint64_t readmove(char); +static uint64_t readmodifier(char); + +static char *edgestr[] = { + "UF", "UB", "DB", "DF", + "UR", "UL", "DL", "DR", + "FR", "FL", "BL", "BR" +}; +static char *cornerstr[] = { + "UFR", "UBL", "DFL", "DBR", + "UFL", "UBR", "DFR", "DBL" +}; +static char *cornerstralt[] = { + "URF", "ULB", "DLF", "DRB", + "ULF", "URB", "DRF", "DLB" +}; +static char *movestr[] = { + [U] = "U", [U2] = "U2", [U3] = "U'", + [D] = "D", [D2] = "D2", [D3] = "D'", + [R] = "R", [R2] = "R2", [R3] = "R'", + [L] = "L", [L2] = "L2", [L3] = "L'", + [F] = "F", [F2] = "F2", [F3] = "F'", + [B] = "B", [B2] = "B2", [B3] = "B'", +}; + +cube_t solvedcube = { .e = 0x5A928398A418820ULL, .c = 0x1C61440C2040ULL }; +cube_t errorcube = { .e = _error, .c = _error }; + + +static uint64_t +permsign(uint64_t *a, int n) +{ + int i, j; + uint64_t ret; + + ret = 0; + + for (i = 0; i < n; i++) + for (j = i+1; j < n; j++) + ret += a[i] > a[j] ? 1 : 0; + + return ret % 2; +} + +bool +isconsistent(cube_t cube) +{ + uint64_t x, p[12], sum, co; + bool found[12]; + int i; + + sum = 0; + + /* Check for EP consistency */ + for (i = 0; i < 12; i++) + found[i] = false; + for (i = 0, x = cube.e; i < 12; i++, x >>= 5ULL) { + p[i] = x & _epblock; + if (p[i] >= 12) + goto inconsistent_ep; + found[p[i]] = true; + } + for (i = 0; i < 12; i++) + if (!found[i]) + goto inconsistent_ep; + sum = permsign(p, 12); + + /* Check for CP consistency */ + for (i = 0; i < 8; i++) + found[i] = false; + for (i = 0, x = cube.c; i < 8; i++, x >>= 6ULL) { + p[i] = x & _cpblock; + if (p[i] >= 8) + goto inconsistent_cp; + found[p[i]] = true; + } + for (i = 0; i < 8; i++) + if (!found[i]) + goto inconsistent_cp; + sum += permsign(p, 8); + + /* Check permutation parity */ + if (sum % 2 != 0) + goto inconsistent_parity; + + /* Check for EO parity */ + for (i = 0, sum = 0, x = cube.e; i < 12; i++, x >>= 5ULL) + sum += (x & _eoblock) >> 4ULL; + if (sum % 2 != 0) + goto inconsistent_eo; + + /* Check for CO parity */ + for (i = 0, sum = 0, x = cube.c; i < 8; i++, x >>= 6ULL) { + co = (x & _coblock) >> 3ULL; + if (co > 2) + goto inconsistent_co3; + sum += co; + } + if (sum % 3 != 0) + goto inconsistent_co; + + /* Check that CO extra bit is zero */ + if (cube.c & _coextramask) + goto inconsistent_coextra; + + return true; + +inconsistent_ep: +#ifdef DEBUG + fprintf(stderr, "Inconsistent EP\n"); +#endif + goto inconsistent_return; +inconsistent_cp: +#ifdef DEBUG + fprintf(stderr, "Inconsistent CP\n"); +#endif + goto inconsistent_return; +inconsistent_parity: +#ifdef DEBUG + fprintf(stderr, "Inconsistent parity\n"); +#endif + goto inconsistent_return; +inconsistent_eo: +#ifdef DEBUG + fprintf(stderr, "Inconsistent EO\n"); +#endif + goto inconsistent_return; +inconsistent_co3: +#ifdef DEBUG + fprintf(stderr, "Inconsistent CO=3\n"); +#endif + goto inconsistent_return; +inconsistent_co: +#ifdef DEBUG + fprintf(stderr, "Inconsistent CO\n"); +#endif + goto inconsistent_return; +inconsistent_coextra: +#ifdef DEBUG + fprintf(stderr, "Inconsistent extra bit for CO\n"); +#endif + goto inconsistent_return; +inconsistent_return: + return false; +} + +bool +issolved(cube_t cube) +{ + return cube.c == solvedcube.c && cube.e == solvedcube.e; +} + + +static uint64_t +readep(char *str) +{ + uint64_t e; + + for (e = 0; e < 12; e++) + if (!strncmp(str, edgestr[e], 2)) + return e; + +#ifdef DEBUG + fprintf(stderr, "Error reading EP\n"); +#endif + return _error; +} + +static uint64_t +readeo(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + +#ifdef DEBUG + fprintf(stderr, "Error reading EO\n"); +#endif + return _error; +} + +static uint64_t +readcp(char *str) +{ + uint64_t c; + + for (c = 0; c < 8; c++) + if (!strncmp(str, cornerstr[c], 3) || + !strncmp(str, cornerstralt[c], 3)) + return c; + +#ifdef DEBUG + fprintf(stderr, "Error reading CP\n"); +#endif + return _error; +} + +static uint64_t +readco(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + if (*str == '2') + return 2ULL; + +#ifdef DEBUG + fprintf(stderr, "Error reading CO\n"); +#endif + return _error; +} + +cube_t +readcube(char *buf) +{ + int i; + uint64_t piece, orient; + cube_t ret = {0}; + char *b = buf; + + for (i = 0; i < 12; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readep(b)) == _error) + goto readcube_error; + b += 2; + if ((orient = readeo(b)) == _error) + goto readcube_error; + b++; + ret.e |= (piece << (i * 5ULL)) | (orient << (i * 5ULL + 4ULL)); + } + for (i = 0; i < 8; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readcp(b)) == _error) + goto readcube_error; + b += 3; + if ((orient = readco(b)) == _error) + goto readcube_error; + b++; + ret.c |= (piece << (i * 6ULL)) | (orient << (i * 6ULL + 3ULL)); + } + + return ret; + +readcube_error: +#ifdef DEBUG + fprintf(stderr, "readcube error\n"); +#endif + return errorcube; +} + +void +writecube(cube_t cube, char *buf) +{ + char *errormsg; + uint64_t piece, orien, x; + size_t len; + int i; + + if (!isconsistent(cube)) { + errormsg = "ERROR: cannot write inconsistent cube"; + goto writecube_error; + } + + for (i = 0, x = cube.e; i < 12; i++, x >>= 5ULL) { + piece = x & _epblock; + orien = (x & _eoblock) >> 4ULL; + buf[4*i ] = edgestr[piece][0]; + buf[4*i + 1] = edgestr[piece][1]; + buf[4*i + 2] = orien + '0'; + buf[4*i + 3] = ' '; + } + for (i = 0, x = cube.c; i < 8; i++, x >>= 6ULL) { + piece = x & _cpblock; + orien = (x & _coblock) >> 3ULL; + buf[48 + 5*i ] = cornerstr[piece][0]; + buf[48 + 5*i + 1] = cornerstr[piece][1]; + buf[48 + 5*i + 2] = cornerstr[piece][2]; + buf[48 + 5*i + 3] = orien + '0'; + buf[48 + 5*i + 4] = ' '; + } + + buf[48+39] = '\0'; + + return; + +writecube_error: +#ifdef DEBUG + fprintf(stderr, "writecube error, see stdout for details\n"); +#endif + len = strlen(errormsg); + memcpy(buf, errormsg, len); + buf[len] = '\n'; + buf[len+1] = '\0'; +} + + +static uint64_t +readmove(char c) +{ + switch (c) { + case 'U': + return U; + case 'D': + return D; + case 'R': + return R; + case 'L': + return L; + case 'F': + return F; + case 'B': + return B; + default: + return _error; + } +} + +static uint64_t +readmodifier(char c) +{ + switch (c) { + case '1': /* Fallthrough */ + case '2': /* Fallthrough */ + case '3': + return c - '0' - 1; + case '\'': + return 2; + default: + return 0; + } +} + +int +readmoves(char *buf, move_t *m) +{ + int n; + uint64_t r; + char *b; + + for (b = buf, n = 0; *b != '\0'; b++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if (*b == '\0') + return n; + if ((r = readmove(*b)) == _error) + goto readmoves_error; + m[n] = (move_t)r; + if ((r = readmodifier(*(b+1))) != 0) { + b++; + m[n] += r; + } + n++; + } + + return n; + +readmoves_error: +#ifdef DEBUG + fprintf(stderr, "readmoves error\n"); +#endif + return -1; +} + +void +writemoves(move_t *m, int n, char *buf) +{ + int i; + size_t len; + char *b, *s; + + for (i = 0, b = buf; i < n; i++, b++) { + s = movestr[m[i]]; + len = strlen(s); + memcpy(b, s, len); + b += len; + *b = ' '; + } + *b = '\0'; +} + + +static inline uint64_t +coapply(uint64_t c, uint64_t m) +{ + uint64_t z, b; + + z = c + m; + b = ((z + _coonemask) & _coextramask) >> 2ULL; + + return (z + b) & ~_coextramask; +} + +cube_t +move(cube_t c, move_t m) +{ + cube_t ret = {0}; + +#ifdef DEBUG + if (!isconsistent(c)) { + fprintf(stderr, "move error, inconsistent cube\n"); + goto move_error; + } +#endif + + switch (m) { + case U: + ret.e = c.e & ~_emask_u; + ret.e |= + (c.e & _eblock) << 25ULL | + (c.e & _eblock << 5ULL) << 15ULL | + (c.e & _eblock2 << 20ULL) >> 20ULL; + + ret.c = c.c & ~_cmask_u; + ret.c |= + (c.c & _cblock2) << 24ULL | + (c.c & _cblock << 24ULL) >> 18ULL | + (c.c & _cblock << 30ULL) >> 30ULL; + + return ret; + case U2: + ret.e = c.e & ~_emask_u; + ret.e |= + (c.e & (_eblock | _eblock << 20ULL)) << 5ULL | + (c.e & (_eblock << 5ULL | _eblock << 25ULL)) >> 5ULL; + + ret.c = c.c & ~_cmask_u; + ret.c |= + (c.c & (_cblock | _cblock << 24ULL)) << 6ULL | + (c.c & (_cblock << 6ULL | _cblock << 30ULL)) >> 6ULL; + + return ret; + case U3: + ret.e = c.e & ~_emask_u; + ret.e |= + (c.e & _eblock2) << 20ULL | + (c.e & _eblock << 25ULL) >> 25ULL | + (c.e & _eblock << 20ULL) >> 15ULL; + + ret.c = c.c & ~_cmask_u; + ret.c |= + (c.c & _cblock) << 30ULL | + (c.c & _cblock << 6ULL) << 18ULL | + (c.c & _cblock2 << 24ULL) >> 24ULL; + + return ret; + case D: + ret.e = c.e & ~_emask_d; + ret.e |= + (c.e & _eblock2 << 10ULL) << 20ULL | + (c.e & _eblock << 30ULL) >> 15ULL | + (c.e & _eblock << 35ULL) >> 25ULL; + + ret.c = c.c & ~_cmask_d; + ret.c |= + (c.c & _cblock2 << 12ULL) << 24ULL | + (c.c & _cblock << 36ULL) >> 18ULL | + (c.c & _cblock << 42ULL) >> 30ULL; + + return ret; + case D2: + ret.e = c.e & ~_emask_d; + ret.e |= + (c.e & (_eblock << 10ULL | _eblock << 30ULL)) << 5ULL | + (c.e & (_eblock << 15ULL | _eblock << 35ULL)) >> 5ULL; + + ret.c = c.c & ~_cmask_d; + ret.c |= + (c.c & (_cblock << 12ULL | _cblock << 36ULL)) << 6ULL | + (c.c & (_cblock << 18ULL | _cblock << 42ULL)) >> 6ULL; + + return ret; + case D3: + ret.e = c.e & ~_emask_d; + ret.e |= + (c.e & _eblock << 10ULL) << 25ULL | + (c.e & _eblock << 15ULL) << 15ULL | + (c.e & _eblock2 << 30ULL) >> 20ULL; + + ret.c = c.c & ~_cmask_d; + ret.c |= + (c.c & _cblock << 12ULL) << 30ULL | + (c.c & _cblock << 18ULL) << 18ULL | + (c.c & _cblock2 << 36ULL) >> 24ULL; + + return ret; + case R: + ret.e = c.e & ~_emask_r; + ret.e |= + (c.e & _eblock << 20ULL) << 35ULL | + (c.e & _eblock << 55ULL) >> 20ULL | + (c.e & _eblock << 35ULL) << 5ULL | + (c.e & _eblock << 40ULL) >> 20ULL; + + ret.c = c.c & ~_cmask_r; + ret.c |= + (c.c & _cblock) << 30ULL | + (c.c & _cblock << 30ULL) >> 12ULL | + (c.c & _cblock << 18ULL) << 18ULL | + (c.c & _cblock << 36ULL) >> 36ULL; + + ret.c = coapply(ret.c, _comask_r); + + return ret; + case R2: + ret.e = c.e & ~_emask_r; + ret.e |= + (c.e & (_eblock << 20ULL | _eblock << 40ULL)) << 15ULL | + (c.e & (_eblock << 35ULL | _eblock << 55ULL)) >> 15ULL; + + ret.c = c.c & ~_cmask_r; + ret.c |= + (c.c & _cblock) << 18ULL | + (c.c & _cblock << 18ULL) >> 18ULL | + (c.c & _cblock << 30ULL) << 6ULL | + (c.c & _cblock << 36ULL) >> 6ULL; + + return ret; + case R3: + ret.e = c.e & ~_emask_r; + ret.e |= + (c.e & (_eblock << 20ULL | _eblock << 35ULL)) << 20ULL | + (c.e & _eblock << 55ULL) >> 35ULL | + (c.e & _eblock << 40ULL) >> 5ULL; + + ret.c = c.c & ~_cmask_r; + ret.c |= + (c.c & _cblock) << 36ULL | + (c.c & _cblock << 30ULL) >> 30ULL | + (c.c & _cblock << 18ULL) << 12ULL | + (c.c & _cblock << 36ULL) >> 18ULL; + + ret.c = coapply(ret.c, _comask_r); + + return ret; + case L: + ret.e = c.e & ~_emask_l; + ret.e |= + (c.e & _eblock2 << 25ULL) << 20ULL | + (c.e & _eblock << 45ULL) >> 15ULL | + (c.e & _eblock << 50ULL) >> 25ULL; + + ret.c = c.c & ~_cmask_l; + ret.c |= + (c.c & _cblock << 6ULL) << 18ULL | + (c.c & _cblock << 12ULL) << 30ULL | + (c.c & _cblock << 24ULL) >> 12ULL | + (c.c & _cblock << 42ULL) >> 36ULL; + + ret.c = coapply(ret.c, _comask_l); + + return ret; + case L2: + ret.e = c.e & ~_emask_l; + ret.e |= + (c.e & (_eblock << 25ULL | _eblock << 45ULL)) << 5ULL | + (c.e & (_eblock << 30ULL | _eblock << 50ULL)) >> 5ULL; + + ret.c = c.c & ~_cmask_l; + ret.c |= + (c.c & _cblock << 6ULL) << 6ULL | + (c.c & _cblock << 12ULL) >> 6ULL | + (c.c & _cblock << 24ULL) << 18ULL | + (c.c & _cblock << 42ULL) >> 18ULL; + + return ret; + case L3: + ret.e = c.e & ~_emask_l; + ret.e |= + (c.e & _eblock << 25ULL) << 25ULL | + (c.e & _eblock << 30ULL) << 15ULL | + (c.e & _eblock2 << 45ULL) >> 20ULL; + + ret.c = c.c & ~_cmask_l; + ret.c |= + (c.c & _cblock << 6ULL) << 36ULL | + (c.c & _cblock << 12ULL) << 12ULL | + (c.c & _cblock << 24ULL) >> 18ULL | + (c.c & _cblock << 42ULL) >> 30ULL; + + ret.c = coapply(ret.c, _comask_l); + + return ret; + case F: + ret.e = c.e & ~_emask_f; + ret.e |= + (c.e & _eblock) << 40ULL | + (c.e & _eblock << 15ULL) << 30ULL | + (c.e & _eblock << 40ULL) >> 25ULL | + (c.e & _eblock << 45ULL) >> 45ULL; + + ret.e ^= _eomask_f; + + ret.c = c.c & ~_cmask_f; + ret.c |= + (c.c & _cblock) << 36ULL | + (c.c & (_cblock << 24ULL | _cblock << 36ULL)) >> 24ULL | + (c.c & _cblock << 12ULL) << 12ULL; + + ret.c = coapply(ret.c, _comask_f); + + return ret; + case F2: + ret.e = c.e & ~_emask_f; + ret.e |= + (c.e & _eblock) << 15ULL | + (c.e & _eblock << 15ULL) >> 15ULL | + (c.e & _eblock << 40ULL) << 5ULL | + (c.e & _eblock << 45ULL) >> 5ULL; + + ret.c = c.c & ~_cmask_f; + ret.c |= + (c.c & (_cblock | _cblock << 24ULL)) << 12ULL | + (c.c & (_cblock << 12ULL | _cblock << 36ULL)) >> 12ULL; + + return ret; + case F3: + ret.e = c.e & ~_emask_f; + ret.e |= + (c.e & _eblock) << 45ULL | + (c.e & _eblock << 15ULL) << 25ULL | + (c.e & _eblock << 40ULL) >> 40ULL | + (c.e & _eblock << 45ULL) >> 30ULL; + + ret.e ^= _eomask_f; + + ret.c = c.c & ~_cmask_f; + ret.c |= + (c.c & (_cblock | _cblock << 12ULL)) << 24ULL | + (c.c & _cblock << 24ULL) >> 12ULL | + (c.c & _cblock << 36ULL) >> 36ULL; + + ret.c = coapply(ret.c, _comask_f); + + return ret; + case B: + ret.e = c.e & ~_emask_b; + ret.e |= + (c.e & _eblock2 << 5ULL) << 45ULL | + (c.e & _eblock << 50ULL) >> 40ULL | + (c.e & _eblock << 55ULL) >> 50ULL; + + ret.e ^= _eomask_b; + + ret.c = c.c & ~_cmask_b; + ret.c |= + (c.c & _cblock << 6ULL) << 36ULL | + (c.c & _cblock << 18ULL) << 12ULL | + (c.c & (_cblock << 30ULL | _cblock << 42ULL)) >> 24ULL; + + ret.c = coapply(ret.c, _comask_b); + + return ret; + case B2: + ret.e = c.e & ~_emask_b; + ret.e |= + (c.e & (_eblock << 5ULL | _eblock << 50ULL)) << 5ULL | + (c.e & (_eblock << 10ULL | _eblock << 55ULL)) >> 5ULL; + + ret.c = c.c & ~_cmask_b; + ret.c |= + (c.c & (_cblock << 6ULL | _cblock << 30ULL)) << 12ULL | + (c.c & (_cblock << 18ULL | _cblock << 42ULL)) >> 12ULL; + + return ret; + case B3: + ret.e = c.e & ~_emask_b; + ret.e |= + (c.e & _eblock << 5ULL) << 50ULL | + (c.e & _eblock << 10ULL) << 40ULL | + (c.e & _eblock2 << 50ULL) >> 45ULL; + + ret.e ^= _eomask_b; + + ret.c = c.c & ~_cmask_b; + ret.c |= + (c.c & (_cblock << 6ULL | _cblock << 18ULL)) << 24ULL | + (c.c & _cblock << 30ULL) >> 12ULL | + (c.c & _cblock << 42ULL) >> 36ULL; + + ret.c = coapply(ret.c, _comask_b); + + return ret; + default: + goto move_unknown; + } + +move_unknown: +#ifdef DEBUG + fprintf(stderr, "move error, unknow move\n"); +#endif + goto move_error; +move_error: + return errorcube; +} diff --git a/src/cube.h b/src/cube.h @@ -0,0 +1,27 @@ +typedef enum { + U, U2, U3, D, D2, D3, + R, R2, R3, L, L2, L3, + F, F2, F3, B, B2, B3 +} move_t; +typedef struct { + uint64_t e; + uint64_t c; +} cube_t; + +extern cube_t solvedcube; +extern cube_t errorcube; + +bool isconsistent(cube_t); +bool issolved(cube_t); + +cube_t readcube(char *); +void writecube(cube_t, char *); + +int readmoves(char *, move_t *); +void writemoves(move_t *, int, char *); + +cube_t move(cube_t, move_t); + +/* +cube_t inverse(cube_t); +*/ diff --git a/src/cube.sync-conflict-20230524-181836-JOKKFPA.c b/src/cube.sync-conflict-20230524-181836-JOKKFPA.c @@ -0,0 +1,614 @@ +/* +# Cube representation, moves, transformations and indexing + +## String description + +The functions readcube() and writecube() use the following format. +Each edge is represented by two letters denoting the sides it belongs to +and one number denoting its orientation (0 oriented, 1 mis-oriented). +Similarly, each corner is represented by three letters and a number +(0 oriented, 1 twisted clockwise, 2 twisted counter-clockwise). +Edge orientation is relative to the F / B axis, corner orientation is +relative to the U / D axis. + +The correct order of the pieces is the same as that defined in the +section "Internal cube representation", except that pieces are read +left-to-right. Pieces are divided by slices, so the ordering is not the +most intuitive, but it is more convenient for the internal representation. + +Whitespaces between pieces are ignored when reading the cube, and a +single whitespace character is added between pieces when writing. + +For example, the solved cube looks like this: + +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 + +The cube after the moves R'U'F looks like this: + +FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0 UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0 + +More formats might be supported in the future. + +## Internal cube representation + +The cube_t data structure implemented in this file is designed to +efficiently perform common operations on a 3x3x3 Rubik's cube when +solving it with an iterative-deepening DFS search. It is not the most +general, complete, easy to read or compact one. Since the cube can +be trivially reoriented before the search, we only encode permutations +of the cube that keep the center pieces in a fixed position (that is, +we do not encode the position of the centers). + +The cube state is encoded in two 64-bit integers, one for edges and one +for centers. We explain how edges are encoded first, and the highlight +the few differences with corners afterwards. + +For encoding edges, only the 60 least-significant bits are used. Each +edge described by 5 bits. The position of a 5-bit block in the 64-bit +integer determine the position of the edge piece in the cube, according +to the following table (least-significant bits on the right): + +55-59 50-54 45-49 40-44 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + BR BL FL FR DR DL UL UR DF DB UB UF +ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee + +For each edge, the 4 least-significant bits ('ssee' in the table) +determine the piece. The two bits marked with 'ss' determine the internal +slice the piece belongs to, i.e. they are either '00' for M, '01' for +S or '10' for E. The other two bits (marked with 'ee') determine the +actual edge piece among the 4 in the same slice, and they are assigned +somewhat arbitarily. Using this representation and the ordering defined +in the table above, the edges are correctly permuted when these 4 bits +for each represent the numbers 0 to 11 in the correct order. + +The last bit determines the orientation. The orientation of an edge +depends on its position, and it is defined being 0 if the edge can be +moved to its place in the solved orientation by permutations in the +subgroup <U, D, R, L, F2, B2>. + +Corners are encoded in the 48 least-significant bits, and are described +by 6 bits each, their position being defined by the following table: + + 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + DBL DFL UBR UFL DBR DFL UBL UFR +oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc + +The bit marked with an 'x' describes the axis the corner belongs to. +The 0 axis consists of the corners UFR, UBL, DFL and DBR, and the other +four corners form the axis marked with 1. Then two bits are needed to +identify the corner among the four of the same axis. The last three bits +determine the orientation, where one corner is defined to be oriented +(marked with '000') if its top or bottom sticker faces the top or bottom +side. A corner a clockwise turn away from being oriented, thus requiring +a counter-clockwise turn to be oriented correctly, is marked with '001', +and a corner a counter-clockwise turn away is marked with '010'. The most +significant bit is not used to determine the corner orientation, but it +must always be set to '0' to simplify the moving operations (see below). + +## Basic moves + +The 18 basic moves of the cube could be performed by applying a suitable +general permutation (see below), but they have instead been manually +implemented with a few simple operations each, to improve performance. + +For each move we first permute the pieces. This amounts to shifting +around 4 blocks of bits for edges and 4 for corners. Since in some cases +adjacent pieces on the cube are also adjacent in the bit representation we +use, we can save some operations by shifting multiple blocks together. +For example, for the move U for edges we shift a block of 15 bits 5 +positions to the left and a block of 5 bits 15 positions to the right. + +There are some moves that change the orientation of the pieces. Namely, +the moves F, F', B and B' change the orientation of the edges and those +moves as well as R, R', L and L' change the orientation of the corners. +Edge orientation is easy to address: we simply xor the edge representation +by a bit mask with zeroes everywhere except for the 4 edges that need +to be flipped (i.e. the ones on the twisted face). + +Corner orientation is harder to reproduce efficiently working only with +bitwise operations, as it involves performing operations modulo 3. +However, with the help of the extra bit we reserved, we are able to +do this using only two additions and 3 bitwise operations, without +any multiplication, division or modulo operation. The trick is +to use the following formula to sum two numbers x, y in {0,1,2}: + + ((x+y) + (x+y+1)/4) % 4 + +The thrid bit is needed because x+y and x+y+1 can exceed 3. +See below (in the code) for the details. + +## Inverting the cube + +TODO + +## Transformations (conjugations by full-cube rotations) + +TODO + +## Indexing + +TODO - subgroup description etc + +Ideas for pruning (for another file?): +- Use corner separation + CO as main coordinate (~150k states) + - for huge tables, htr corners can be used (6 times larger) +- Symmetry table, one entry or each main coordinate value with the + following info: + - index of the corresponding main symcoord (13 bits) + - transtorep (6 bits) + - base value for pruning table (5 bits, probably 4) + - pruning value for only main coord, i.e. fallback (4 bits) +- To get a full coord for the cube: + - get first coord c, get the transtorep + - transform edges with transtorep + - get second coordinate e + - return c * MAXE + e + - This is still too big, so divide by a power of 2 to get the hashed index + - second coordinate: ep always, + varible number of eo bit (0 to 11) +- Generate table: + - first probe for base value: + - solve coord using fallback table for pruning for 10k random states or so + - loop over all possible values (even if going for smaller table) + - with inverse-index strategy or what? + - use 1 bit per entry (more than base value or not) +*/ + +#include <stdbool.h> +#include <stdint.h> +#include <string.h> + +#ifdef DEBUG +#include <stdio.h> +#endif + +#include "cube.h" + +#define _error 0xFFFFFFFF + +#define _esize 5ULL +#define _eoblock 0x10ULL /* 10000 */ +#define _epblock 0x0FULL /* 01111 */ +#define _eblock 0x1FULL /* 11111 */ + +#define _csize 6ULL +#define _coblock 0x18ULL /* 011000 */ +#define _cpblock 0x07ULL /* 000111 */ +#define _cblock 0x3FULL /* 111111 */ + +#define _edge_uf 0ULL /* 00 00 */ +#define _edge_ub 1ULL /* 00 01 */ +#define _edge_db 2ULL /* 00 10 */ +#define _edge_df 3ULL /* 00 11 */ +#define _edge_ur 4ULL /* 01 00 */ +#define _edge_ul 5ULL /* 01 01 */ +#define _edge_dl 6ULL /* 01 10 */ +#define _edge_dr 7ULL /* 01 11 */ +#define _edge_fr 8ULL /* 10 00 */ +#define _edge_fl 9ULL /* 10 01 */ +#define _edge_bl 10ULL /* 10 10 */ +#define _edge_br 11ULL /* 10 11 */ + +#define _corner_ufr 0ULL /* 0 00 */ +#define _corner_ubl 1ULL /* 0 01 */ +#define _corner_dfl 2ULL /* 0 10 */ +#define _corner_dbr 3ULL /* 0 11 */ +#define _corner_ufl 4ULL /* 1 00 */ +#define _corner_ubr 5ULL /* 1 01 */ +#define _corner_dfr 6ULL /* 1 10 */ +#define _corner_dbl 7ULL /* 1 11 */ + +#define ESHIFT(i) ((i) * _esize) +#define EOSHIFT(i) (4ULL + (i) * _esize) +#define EMASK(i) (_eblock << ESHIFT(i)) +#define EOMASK(i) (_eoblock << ESHIFT(i)) +#define EPMASK(i) (_epblock << ESHIFT(i)) +#define ESOLVED(ee) (_edge_##ee << (_edge_##ee * _esize)) +#define EDGEAT(e, i) (((e) & EMASK(i)) >> ESHIFT(i)) +#define EOAT(e, i) (((e) & EOMASK(i)) >> EOSHIFT(i)) +#define EPAT(e, i) (((e) & EPMASK(i)) >> ESHIFT(i)) + +#define CSHIFT(i) ((i) * _csize) +#define COSHIFT(i) (3ULL + (i) * _csize) +#define CMASK(i) (_cblock << CSHIFT(i)) +#define COMASK(i) (_coblock << CSHIFT(i)) +#define CPMASK(i) (_cpblock << CSHIFT(i)) +#define CSOLVED(ccc) (_corner_##ccc << (_corner_##ccc * _csize)) +#define CORNERAT(c, i) (((c) & CMASK(i)) >> CSHIFT(i)) +#define COAT(c, i) (((c) & COMASK(i)) >> COSHIFT(i)) +#define CPAT(c, i) (((c) & CPMASK(i)) >> CSHIFT(i)) + +#define _emask_u (EMASK(uf) | EMASK(ul) | EMASK(ub) | EMASK(ur)) +#define _emask_d (EMASK(df) | EMASK(dl) | EMASK(db) | EMASK(dr)) +#define _emask_r (EMASK(ur) | EMASK(dr) | EMASK(fr) | EMASK(br)) +#define _emask_l (EMASK(ul) | EMASK(dl) | EMASK(fl) | EMASK(bl)) +#define _emask_f (EMASK(uf) | EMASK(df) | EMASK(fr) | EMASK(fl)) +#define _emask_b (EMASK(ub) | EMASK(db) | EMASK(br) | EMASK(bl)) + +#define _cmask_u (CMASK(ufr) | CMASK(ufl) | CMASK(ubl) | CMASK(ubr)) +#define _cmask_d (CMASK(dfr) | CMASK(dfl) | CMASK(dbl) | CMASK(dbr)) +#define _cmask_r (CMASK(ufr) | CMASK(dfr) | CMASK(ubr) | CMASK(dbr)) +#define _cmask_l (CMASK(ufl) | CMASK(dfl) | CMASK(ubl) | CMASK(dbl)) +#define _cmask_f (CMASK(ufr) | CMASK(ufl) | CMASK(dfr) | CMASK(dfl)) +#define _cmask_b (CMASK(ubr) | CMASK(ubl) | CMASK(dbr) | CMASK(dbl)) + +#define _eomask (EOMASK(uf) | EOMASK(ul) | EOMASK(ub) | EOMASK(ur) \ + EOMASK(df) | EOMASK(dl) | EOMASK(db) | EOMASK(dr) \ + EOMASK(fr) | EOMASK(fl) | EOMASK(bl) | EOMASK(br)) +#define _comask (COMASK(ufr) | COMASK(ufl) | COMASK(ubl) | COMASK(ubr) \ + COMASK(dfr) | COMASK(dfl) | COMASK(dbl) | COMASK(dbr)) + +static uint64_t permsign(uint64_t *, int); +static uint64_t readep(char *); +static uint64_t readeo(char *); +static uint64_t readcp(char *); +static uint64_t readco(char *); +static uint64_t readmove(char); +static uint64_t readmodifier(char); + +static char *edgestr[] = { + [_edge_uf] = "UF", + [_edge_ub] = "UB", + [_edge_db] = "DB", + [_edge_df] = "DF", + [_edge_ur] = "UR", + [_edge_ul] = "UL", + [_edge_dl] = "DL", + [_edge_dr] = "DR", + [_edge_fr] = "FR", + [_edge_fl] = "FL", + [_edge_bl] = "BL", + [_edge_br] = "BR" +}; +static char *cornerstr[] = { + [_corner_ufr] = "UFR", + [_corner_ubl] = "UBL", + [_corner_dfl] = "DFL", + [_corner_dbr] = "DBR", + [_corner_ufl] = "UFL", + [_corner_ubr] = "UBR", + [_corner_dfr] = "DFR", + [_corner_dbl] = "DBL" +}; +static char *movestr[] = { + [U] = "U", [U2] = "U2", [U3] = "U'", + [D] = "D", [D2] = "D2", [D3] = "D'", + [R] = "R", [R2] = "R2", [R3] = "R'", + [L] = "L", [L2] = "L2", [L3] = "L'", + [F] = "F", [F2] = "F2", [F3] = "F'", + [B] = "B", [B2] = "B2", [B3] = "B'", +}; + +cube_t solvedcube = { + .e = ESOLVED(uf) | ESOLVED(ul) | ESOLVED(ub) | ESOLVED(ur) | + ESOLVED(df) | ESOLVED(dl) | ESOLVED(db) | ESOLVED(dr) | + ESOLVED(fr) | ESOLVED(fl) | ESOLVED(bl) | ESOLVED(br), + .c = CSOLVED(ufr) | CSOLVED(ufl) | CSOLVED(ubl) | CSOLVED(ubr) | + CSOLVED(dfr) | CSOLVED(dfl) | CSOLVED(dbl) | CSOLVED(dbr), +}; +cube_t errorcube = { .e = _error, .c = _error }; + + +static uint64_t +permsign(uint64_t *a, int n) +{ + int i, j; + uint64_t ret; + + ret = 0; + + for (i = 0; i < n; i++) + for (j = i+1; j < n; j++) + ret += a[i] > a[j] ? 1 : 0; + + return ret % 2; +} + +bool +isconsistent(cube_t cube) +{ + uint64_t p[12], sum; + bool found[12]; + int i; + + sum = 0; + + /* Check for EP consistency */ + for (i = 0; i < 12; i++) + found[i] = false; + for (i = 0; i < 12; i++) { + p[i] = EPAT(cube.e, i); + found[p[i]] = true; + } + for (i = 0; i < 12; i++) + if (!found[i]) + return false; + sum = permsign(p, 12); + + /* Check for CP consistency */ + for (i = 0; i < 8; i++) + found[i] = false; + for (i = 0; i < 8; i++) { + p[i] = CPAT(cube.c, i); + found[p[i]] = true; + } + for (i = 0; i < 8; i++) + if (!found[i]) + return false; + sum += permsign(p, 8); + + /* Check permutation parity */ + if (sum % 2 != 0) + return false; + + /* Check for EO parity */ + for (i = 0, sum = 0; i < 12; i++) + sum += EOAT(cube.e, i); + if (sum % 2 != 0) + return false; + + /* Check for CO parity */ + for (i = 0, sum = 0; i < 8; i++) + sum += COAT(cube.c, i); + if (sum % 3 != 0) + return false; + + /* Check that CO extra bit is zero */ + for (i = 0; i < 8; i++) + if (cube.c & (1ULL << (5 + i * _csize))) + return false; + + return true; +} + +bool +issolved(cube_t cube) +{ + return cube.c == solvedcube.c && cube.e == solvedcube.e; +} + + +static uint64_t +readep(char *str) +{ + if (!strncmp(str, "UF", 2)) + return _edge_uf; + if (!strncmp(str, "UL", 2)) + return _edge_ul; + if (!strncmp(str, "UB", 2)) + return _edge_ub; + if (!strncmp(str, "UR", 2)) + return _edge_ur; + if (!strncmp(str, "DF", 2)) + return _edge_df; + if (!strncmp(str, "DL", 2)) + return _edge_dl; + if (!strncmp(str, "DB", 2)) + return _edge_db; + if (!strncmp(str, "DR", 2)) + return _edge_dr; + if (!strncmp(str, "FR", 2)) + return _edge_fr; + if (!strncmp(str, "FL", 2)) + return _edge_fl; + if (!strncmp(str, "BL", 2)) + return _edge_bl; + if (!strncmp(str, "BR", 2)) + return _edge_br; + + return _error; +} + +static uint64_t +readeo(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + + return _error; +} + +static uint64_t +readcp(char *str) +{ + if (!strncmp(str, "UFR", 3) || !strncmp(str, "URF", 3)) + return _corner_ufr; + if (!strncmp(str, "UFL", 3) || !strncmp(str, "ULF", 3)) + return _corner_ufl; + if (!strncmp(str, "UBL", 3) || !strncmp(str, "ULB", 3)) + return _corner_ubl; + if (!strncmp(str, "UBR", 3) || !strncmp(str, "URB", 3)) + return _corner_ubr; + if (!strncmp(str, "DFR", 3) || !strncmp(str, "DRF", 3)) + return _corner_dfr; + if (!strncmp(str, "DFL", 3) || !strncmp(str, "DLF", 3)) + return _corner_dfl; + if (!strncmp(str, "DBL", 3) || !strncmp(str, "DLB", 3)) + return _corner_dbl; + if (!strncmp(str, "DBR", 3) || !strncmp(str, "DRB", 3)) + return _corner_dbr; + + return _error; +} + +static uint64_t +readco(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + if (*str == '2') + return 2ULL; + + return _error; +} + +cube_t +readcube(char *buf) +{ + int i; + uint64_t piece, orient; + cube_t ret = {0}; + char *b = buf; + + for (i = 0; i < 12; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readep(b)) == _error) + goto readcube_error; + b += 2; + if ((orient = readeo(b)) == _error) + goto readcube_error; + b++; + ret.e |= (piece << ESHIFT(i)) | (orient << EOSHIFT(i)); + } + for (i = 0; i < 8; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readcp(b)) == _error) + goto readcube_error; + b += 3; + if ((orient = readco(b)) == _error) + goto readcube_error; + b++; + ret.c |= (piece << CSHIFT(i)) | (orient << COSHIFT(i)); + } + + return ret; + +readcube_error: + return errorcube; +} + +void +writecube(cube_t cube, char *buf) +{ + char *errormsg; + uint64_t piece; + size_t len; + int i; + + if (!isconsistent(cube)) { + errormsg = "ERROR: cannot write inconsistent cube"; + goto writecube_error; + } + + for (i = 0; i < 12; i++) { + piece = EPAT(cube.e, i); + buf[4*i ] = edgestr[piece][0]; + buf[4*i + 1] = edgestr[piece][1]; + buf[4*i + 2] = EOAT(cube.e, i) + '0'; + buf[4*i + 3] = ' '; + } + for (i = 0; i < 8; i++) { + piece = CPAT(cube.c, i); + buf[48 + 5*i ] = cornerstr[piece][0]; + buf[48 + 5*i + 1] = cornerstr[piece][1]; + buf[48 + 5*i + 2] = cornerstr[piece][2]; + buf[48 + 5*i + 3] = COAT(cube.c, i) + '0'; + buf[48 + 5*i + 4] = ' '; + } + + buf[48+39] = '\0'; + + return; + +writecube_error: + len = strlen(errormsg); + strcpy(buf, errormsg); + buf[len] = '\n'; + buf[len+1] = '\0'; +} + + +static uint64_t +readmove(char c) +{ + switch (c) { + case 'U': + return U; + case 'D': + return D; + case 'R': + return R; + case 'L': + return L; + case 'F': + return F; + case 'B': + return B; + default: + return _error; + } +} + +static uint64_t +readmodifier(char c) +{ + switch (c) { + case '1': /* Fallthrough */ + case '2': /* Fallthrough */ + case '3': + return c - '0' - 1; + case '\'': + return 2; + default: + return 0; + } +} + +int +readmoves(char *buf, move_t *m) +{ + int n; + uint64_t r; + char *b; + + for (b = buf, n = 0; *b != '\0'; b++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((r = readmove(*b)) == _error) + return -1; + m[n] = (move_t)r; + if ((r = readmodifier(*(b+1))) != 0) { + b++; + m[n] += r; + } + n++; + } + + return n; +} + +void +writemoves(move_t *m, int n, char *buf) +{ + int i; + char *b, *s; + + for (i = 0, b = buf; i < n; i++, b++) { + s = movestr[m[i]]; + strcpy(b, s); + b += strlen(s); + *b = ' '; + } + *b = '\0'; +} + + +cube_t +move(move_t m, cube_t c) +{ + /* TODO - not implemented yet */ + + cube_t ret = {0}; + + switch (m) { + case U: + return ret; + default: + return ret; + } +} diff --git a/src/cube.sync-conflict-20230524-181836-JOKKFPA.h b/src/cube.sync-conflict-20230524-181836-JOKKFPA.h @@ -0,0 +1,27 @@ +typedef enum { + U, U2, U3, D, D2, D3, + R, R2, R3, L, L2, L3, + F, F2, F3, B, B2, B3 +} move_t; +typedef struct { + uint64_t e; + uint64_t c; +} cube_t; + +extern cube_t solvedcube; +extern cube_t errorcube; + +bool isconsistent(cube_t); +bool issolved(cube_t); + +cube_t readcube(char *); +void writecube(cube_t, char *); + +int readmoves(char *, move_t *); +void writemoves(move_t *, int, char *); + +/* +cube_t move(move_t, cube_t); +cube_t inverse(cube_t); + +*/ diff --git a/src/cube.sync-conflict-20230524-182143-JOKKFPA.c b/src/cube.sync-conflict-20230524-182143-JOKKFPA.c @@ -0,0 +1,614 @@ +/* +# Cube representation, moves, transformations and indexing + +## String description + +The functions readcube() and writecube() use the following format. +Each edge is represented by two letters denoting the sides it belongs to +and one number denoting its orientation (0 oriented, 1 mis-oriented). +Similarly, each corner is represented by three letters and a number +(0 oriented, 1 twisted clockwise, 2 twisted counter-clockwise). +Edge orientation is relative to the F / B axis, corner orientation is +relative to the U / D axis. + +The correct order of the pieces is the same as that defined in the +section "Internal cube representation", except that pieces are read +left-to-right. Pieces are divided by slices, so the ordering is not the +most intuitive, but it is more convenient for the internal representation. + +Whitespaces between pieces are ignored when reading the cube, and a +single whitespace character is added between pieces when writing. + +For example, the solved cube looks like this: + +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 + +The cube after the moves R'U'F looks like this: + +FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0 UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0 + +More formats might be supported in the future. + +## Internal cube representation + +The cube_t data structure implemented in this file is designed to +efficiently perform common operations on a 3x3x3 Rubik's cube when +solving it with an iterative-deepening DFS search. It is not the most +general, complete, easy to read or compact one. Since the cube can +be trivially reoriented before the search, we only encode permutations +of the cube that keep the center pieces in a fixed position (that is, +we do not encode the position of the centers). + +The cube state is encoded in two 64-bit integers, one for edges and one +for centers. We explain how edges are encoded first, and the highlight +the few differences with corners afterwards. + +For encoding edges, only the 60 least-significant bits are used. Each +edge described by 5 bits. The position of a 5-bit block in the 64-bit +integer determine the position of the edge piece in the cube, according +to the following table (least-significant bits on the right): + +55-59 50-54 45-49 40-44 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + BR BL FL FR DR DL UL UR DF DB UB UF +ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee + +For each edge, the 4 least-significant bits ('ssee' in the table) +determine the piece. The two bits marked with 'ss' determine the internal +slice the piece belongs to, i.e. they are either '00' for M, '01' for +S or '10' for E. The other two bits (marked with 'ee') determine the +actual edge piece among the 4 in the same slice, and they are assigned +somewhat arbitarily. Using this representation and the ordering defined +in the table above, the edges are correctly permuted when these 4 bits +for each represent the numbers 0 to 11 in the correct order. + +The last bit determines the orientation. The orientation of an edge +depends on its position, and it is defined being 0 if the edge can be +moved to its place in the solved orientation by permutations in the +subgroup <U, D, R, L, F2, B2>. + +Corners are encoded in the 48 least-significant bits, and are described +by 6 bits each, their position being defined by the following table: + + 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + DBL DFL UBR UFL DBR DFL UBL UFR +oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc + +The bit marked with an 'x' describes the axis the corner belongs to. +The 0 axis consists of the corners UFR, UBL, DFL and DBR, and the other +four corners form the axis marked with 1. Then two bits are needed to +identify the corner among the four of the same axis. The last three bits +determine the orientation, where one corner is defined to be oriented +(marked with '000') if its top or bottom sticker faces the top or bottom +side. A corner a clockwise turn away from being oriented, thus requiring +a counter-clockwise turn to be oriented correctly, is marked with '001', +and a corner a counter-clockwise turn away is marked with '010'. The most +significant bit is not used to determine the corner orientation, but it +must always be set to '0' to simplify the moving operations (see below). + +## Basic moves + +The 18 basic moves of the cube could be performed by applying a suitable +general permutation (see below), but they have instead been manually +implemented with a few simple operations each, to improve performance. + +For each move we first permute the pieces. This amounts to shifting +around 4 blocks of bits for edges and 4 for corners. Since in some cases +adjacent pieces on the cube are also adjacent in the bit representation we +use, we can save some operations by shifting multiple blocks together. +For example, for the move U for edges we shift a block of 15 bits 5 +positions to the left and a block of 5 bits 15 positions to the right. + +There are some moves that change the orientation of the pieces. Namely, +the moves F, F', B and B' change the orientation of the edges and those +moves as well as R, R', L and L' change the orientation of the corners. +Edge orientation is easy to address: we simply xor the edge representation +by a bit mask with zeroes everywhere except for the 4 edges that need +to be flipped (i.e. the ones on the twisted face). + +Corner orientation is harder to reproduce efficiently working only with +bitwise operations, as it involves performing operations modulo 3. +However, with the help of the extra bit we reserved, we are able to +do this using only two additions and 3 bitwise operations, without +any multiplication, division or modulo operation. The trick is +to use the following formula to sum two numbers x, y in {0,1,2}: + + ((x+y) + (x+y+1)/4) % 4 + +The thrid bit is needed because x+y and x+y+1 can exceed 3. +See below (in the code) for the details. + +## Inverting the cube + +TODO + +## Transformations (conjugations by full-cube rotations) + +TODO + +## Indexing + +TODO - subgroup description etc + +Ideas for pruning (for another file?): +- Use corner separation + CO as main coordinate (~150k states) + - for huge tables, htr corners can be used (6 times larger) +- Symmetry table, one entry or each main coordinate value with the + following info: + - index of the corresponding main symcoord (13 bits) + - transtorep (6 bits) + - base value for pruning table (5 bits, probably 4) + - pruning value for only main coord, i.e. fallback (4 bits) +- To get a full coord for the cube: + - get first coord c, get the transtorep + - transform edges with transtorep + - get second coordinate e + - return c * MAXE + e + - This is still too big, so divide by a power of 2 to get the hashed index + - second coordinate: ep always, + varible number of eo bit (0 to 11) +- Generate table: + - first probe for base value: + - solve coord using fallback table for pruning for 10k random states or so + - loop over all possible values (even if going for smaller table) + - with inverse-index strategy or what? + - use 1 bit per entry (more than base value or not) +*/ + +#include <stdbool.h> +#include <stdint.h> +#include <string.h> + +#ifdef DEBUG +#include <stdio.h> +#endif + +#include "cube.h" + +#define _error 0xFFFFFFFF + +#define _esize 5ULL +#define _eoblock 0x10ULL /* 10000 */ +#define _epblock 0x0FULL /* 01111 */ +#define _eblock 0x1FULL /* 11111 */ + +#define _csize 6ULL +#define _coblock 0x18ULL /* 011000 */ +#define _cpblock 0x07ULL /* 000111 */ +#define _cblock 0x3FULL /* 111111 */ + +#define _edge_uf 0ULL /* 00 00 */ +#define _edge_ub 1ULL /* 00 01 */ +#define _edge_db 2ULL /* 00 10 */ +#define _edge_df 3ULL /* 00 11 */ +#define _edge_ur 4ULL /* 01 00 */ +#define _edge_ul 5ULL /* 01 01 */ +#define _edge_dl 6ULL /* 01 10 */ +#define _edge_dr 7ULL /* 01 11 */ +#define _edge_fr 8ULL /* 10 00 */ +#define _edge_fl 9ULL /* 10 01 */ +#define _edge_bl 10ULL /* 10 10 */ +#define _edge_br 11ULL /* 10 11 */ + +#define _corner_ufr 0ULL /* 0 00 */ +#define _corner_ubl 1ULL /* 0 01 */ +#define _corner_dfl 2ULL /* 0 10 */ +#define _corner_dbr 3ULL /* 0 11 */ +#define _corner_ufl 4ULL /* 1 00 */ +#define _corner_ubr 5ULL /* 1 01 */ +#define _corner_dfr 6ULL /* 1 10 */ +#define _corner_dbl 7ULL /* 1 11 */ + +#define ESHIFT(i) ((i) * _esize) +#define EOSHIFT(i) (4ULL + (i) * _esize) +#define EMASK(i) (_eblock << ESHIFT(i)) +#define EOMASK(i) (_eoblock << ESHIFT(i)) +#define EPMASK(i) (_epblock << ESHIFT(i)) +#define ESOLVED(ee) (_edge_##ee << (_edge_##ee * _esize)) +#define EDGEAT(e, i) (((e) & EMASK(i)) >> ESHIFT(i)) +#define EOAT(e, i) (((e) & EOMASK(i)) >> EOSHIFT(i)) +#define EPAT(e, i) (((e) & EPMASK(i)) >> ESHIFT(i)) + +#define CSHIFT(i) ((i) * _csize) +#define COSHIFT(i) (3ULL + (i) * _csize) +#define CMASK(i) (_cblock << CSHIFT(i)) +#define COMASK(i) (_coblock << CSHIFT(i)) +#define CPMASK(i) (_cpblock << CSHIFT(i)) +#define CSOLVED(ccc) (_corner_##ccc << (_corner_##ccc * _csize)) +#define CORNERAT(c, i) (((c) & CMASK(i)) >> CSHIFT(i)) +#define COAT(c, i) (((c) & COMASK(i)) >> COSHIFT(i)) +#define CPAT(c, i) (((c) & CPMASK(i)) >> CSHIFT(i)) + +#define _emask_u (EMASK(uf) | EMASK(ul) | EMASK(ub) | EMASK(ur)) +#define _emask_d (EMASK(df) | EMASK(dl) | EMASK(db) | EMASK(dr)) +#define _emask_r (EMASK(ur) | EMASK(dr) | EMASK(fr) | EMASK(br)) +#define _emask_l (EMASK(ul) | EMASK(dl) | EMASK(fl) | EMASK(bl)) +#define _emask_f (EMASK(uf) | EMASK(df) | EMASK(fr) | EMASK(fl)) +#define _emask_b (EMASK(ub) | EMASK(db) | EMASK(br) | EMASK(bl)) + +#define _cmask_u (CMASK(ufr) | CMASK(ufl) | CMASK(ubl) | CMASK(ubr)) +#define _cmask_d (CMASK(dfr) | CMASK(dfl) | CMASK(dbl) | CMASK(dbr)) +#define _cmask_r (CMASK(ufr) | CMASK(dfr) | CMASK(ubr) | CMASK(dbr)) +#define _cmask_l (CMASK(ufl) | CMASK(dfl) | CMASK(ubl) | CMASK(dbl)) +#define _cmask_f (CMASK(ufr) | CMASK(ufl) | CMASK(dfr) | CMASK(dfl)) +#define _cmask_b (CMASK(ubr) | CMASK(ubl) | CMASK(dbr) | CMASK(dbl)) + +#define _eomask (EOMASK(uf) | EOMASK(ul) | EOMASK(ub) | EOMASK(ur) \ + EOMASK(df) | EOMASK(dl) | EOMASK(db) | EOMASK(dr) \ + EOMASK(fr) | EOMASK(fl) | EOMASK(bl) | EOMASK(br)) +#define _comask (COMASK(ufr) | COMASK(ufl) | COMASK(ubl) | COMASK(ubr) \ + COMASK(dfr) | COMASK(dfl) | COMASK(dbl) | COMASK(dbr)) + +static uint64_t permsign(uint64_t *, int); +static uint64_t readep(char *); +static uint64_t readeo(char *); +static uint64_t readcp(char *); +static uint64_t readco(char *); +static uint64_t readmove(char); +static uint64_t readmodifier(char); + +static char *edgestr[] = { + [_edge_uf] = "UF", + [_edge_ub] = "UB", + [_edge_db] = "DB", + [_edge_df] = "DF", + [_edge_ur] = "UR", + [_edge_ul] = "UL", + [_edge_dl] = "DL", + [_edge_dr] = "DR", + [_edge_fr] = "FR", + [_edge_fl] = "FL", + [_edge_bl] = "BL", + [_edge_br] = "BR" +}; +static char *cornerstr[] = { + [_corner_ufr] = "UFR", + [_corner_ubl] = "UBL", + [_corner_dfl] = "DFL", + [_corner_dbr] = "DBR", + [_corner_ufl] = "UFL", + [_corner_ubr] = "UBR", + [_corner_dfr] = "DFR", + [_corner_dbl] = "DBL" +}; +static char *movestr[] = { + [U] = "U", [U2] = "U2", [U3] = "U'", + [D] = "D", [D2] = "D2", [D3] = "D'", + [R] = "R", [R2] = "R2", [R3] = "R'", + [L] = "L", [L2] = "L2", [L3] = "L'", + [F] = "F", [F2] = "F2", [F3] = "F'", + [B] = "B", [B2] = "B2", [B3] = "B'", +}; + +cube_t solvedcube = { + .e = ESOLVED(uf) | ESOLVED(ul) | ESOLVED(ub) | ESOLVED(ur) | + ESOLVED(df) | ESOLVED(dl) | ESOLVED(db) | ESOLVED(dr) | + ESOLVED(fr) | ESOLVED(fl) | ESOLVED(bl) | ESOLVED(br), + .c = CSOLVED(ufr) | CSOLVED(ufl) | CSOLVED(ubl) | CSOLVED(ubr) | + CSOLVED(dfr) | CSOLVED(dfl) | CSOLVED(dbl) | CSOLVED(dbr), +}; +cube_t errorcube = { .e = _error, .c = _error }; + + +static uint64_t +permsign(uint64_t *a, int n) +{ + int i, j; + uint64_t ret; + + ret = 0; + + for (i = 0; i < n; i++) + for (j = i+1; j < n; j++) + ret += a[i] > a[j] ? 1 : 0; + + return ret % 2; +} + +bool +isconsistent(cube_t cube) +{ + uint64_t p[12], sum; + bool found[12]; + int i; + + sum = 0; + + /* Check for EP consistency */ + for (i = 0; i < 12; i++) + found[i] = false; + for (i = 0; i < 12; i++) { + p[i] = EPAT(cube.e, i); + found[p[i]] = true; + } + for (i = 0; i < 12; i++) + if (!found[i]) + return false; + sum = permsign(p, 12); + + /* Check for CP consistency */ + for (i = 0; i < 8; i++) + found[i] = false; + for (i = 0; i < 8; i++) { + p[i] = CPAT(cube.c, i); + found[p[i]] = true; + } + for (i = 0; i < 8; i++) + if (!found[i]) + return false; + sum += permsign(p, 8); + + /* Check permutation parity */ + if (sum % 2 != 0) + return false; + + /* Check for EO parity */ + for (i = 0, sum = 0; i < 12; i++) + sum += EOAT(cube.e, i); + if (sum % 2 != 0) + return false; + + /* Check for CO parity */ + for (i = 0, sum = 0; i < 8; i++) + sum += COAT(cube.c, i); + if (sum % 3 != 0) + return false; + + /* Check that CO extra bit is zero */ + for (i = 0; i < 8; i++) + if (cube.c & (1ULL << (5 + i * _csize))) + return false; + + return true; +} + +bool +issolved(cube_t cube) +{ + return cube.c == solvedcube.c && cube.e == solvedcube.e; +} + + +static uint64_t +readep(char *str) +{ + if (!strncmp(str, "UF", 2)) + return _edge_uf; + if (!strncmp(str, "UL", 2)) + return _edge_ul; + if (!strncmp(str, "UB", 2)) + return _edge_ub; + if (!strncmp(str, "UR", 2)) + return _edge_ur; + if (!strncmp(str, "DF", 2)) + return _edge_df; + if (!strncmp(str, "DL", 2)) + return _edge_dl; + if (!strncmp(str, "DB", 2)) + return _edge_db; + if (!strncmp(str, "DR", 2)) + return _edge_dr; + if (!strncmp(str, "FR", 2)) + return _edge_fr; + if (!strncmp(str, "FL", 2)) + return _edge_fl; + if (!strncmp(str, "BL", 2)) + return _edge_bl; + if (!strncmp(str, "BR", 2)) + return _edge_br; + + return _error; +} + +static uint64_t +readeo(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + + return _error; +} + +static uint64_t +readcp(char *str) +{ + if (!strncmp(str, "UFR", 3) || !strncmp(str, "URF", 3)) + return _corner_ufr; + if (!strncmp(str, "UFL", 3) || !strncmp(str, "ULF", 3)) + return _corner_ufl; + if (!strncmp(str, "UBL", 3) || !strncmp(str, "ULB", 3)) + return _corner_ubl; + if (!strncmp(str, "UBR", 3) || !strncmp(str, "URB", 3)) + return _corner_ubr; + if (!strncmp(str, "DFR", 3) || !strncmp(str, "DRF", 3)) + return _corner_dfr; + if (!strncmp(str, "DFL", 3) || !strncmp(str, "DLF", 3)) + return _corner_dfl; + if (!strncmp(str, "DBL", 3) || !strncmp(str, "DLB", 3)) + return _corner_dbl; + if (!strncmp(str, "DBR", 3) || !strncmp(str, "DRB", 3)) + return _corner_dbr; + + return _error; +} + +static uint64_t +readco(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + if (*str == '2') + return 2ULL; + + return _error; +} + +cube_t +readcube(char *buf) +{ + int i; + uint64_t piece, orient; + cube_t ret = {0}; + char *b = buf; + + for (i = 0; i < 12; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readep(b)) == _error) + goto readcube_error; + b += 2; + if ((orient = readeo(b)) == _error) + goto readcube_error; + b++; + ret.e |= (piece << ESHIFT(i)) | (orient << EOSHIFT(i)); + } + for (i = 0; i < 8; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readcp(b)) == _error) + goto readcube_error; + b += 3; + if ((orient = readco(b)) == _error) + goto readcube_error; + b++; + ret.c |= (piece << CSHIFT(i)) | (orient << COSHIFT(i)); + } + + return ret; + +readcube_error: + return errorcube; +} + +void +writecube(cube_t cube, char *buf) +{ + char *errormsg; + uint64_t piece; + size_t len; + int i; + + if (!isconsistent(cube)) { + errormsg = "ERROR: cannot write inconsistent cube"; + goto writecube_error; + } + + for (i = 0; i < 12; i++) { + piece = EPAT(cube.e, i); + buf[4*i ] = edgestr[piece][0]; + buf[4*i + 1] = edgestr[piece][1]; + buf[4*i + 2] = EOAT(cube.e, i) + '0'; + buf[4*i + 3] = ' '; + } + for (i = 0; i < 8; i++) { + piece = CPAT(cube.c, i); + buf[48 + 5*i ] = cornerstr[piece][0]; + buf[48 + 5*i + 1] = cornerstr[piece][1]; + buf[48 + 5*i + 2] = cornerstr[piece][2]; + buf[48 + 5*i + 3] = COAT(cube.c, i) + '0'; + buf[48 + 5*i + 4] = ' '; + } + + buf[48+39] = '\0'; + + return; + +writecube_error: + len = strlen(errormsg); + strcpy(buf, errormsg); + buf[len] = '\n'; + buf[len+1] = '\0'; +} + + +static uint64_t +readmove(char c) +{ + switch (c) { + case 'U': + return U; + case 'D': + return D; + case 'R': + return R; + case 'L': + return L; + case 'F': + return F; + case 'B': + return B; + default: + return _error; + } +} + +static uint64_t +readmodifier(char c) +{ + switch (c) { + case '1': /* Fallthrough */ + case '2': /* Fallthrough */ + case '3': + return c - '0' - 1; + case '\'': + return 2; + default: + return 0; + } +} + +int +readmoves(char *buf, move_t *m) +{ + int n; + uint64_t r; + char *b; + + for (b = buf, n = 0; *b != '\0'; b++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((r = readmove(*b)) == _error) + return -1; + m[n] = (move_t)r; + if ((r = readmodifier(*(b+1))) != 0) { + b++; + m[n] += r; + } + n++; + } + + return n; +} + +void +writemoves(move_t *m, int n, char *buf) +{ + int i; + char *b, *s; + + for (i = 0, b = buf; i < n; i++, b++) { + s = movestr[m[i]]; + strcpy(b, s); + b += strlen(s); + *b = ' '; + } + *b = '\0'; +} + + +cube_t +move(move_t m, cube_t c) +{ + /* TODO - not implemented yet */ + + cube_t ret = {0}; + + switch (m) { + case U: + return ret; + default: + return ret; + } +} diff --git a/src/cube.sync-conflict-20230524-182143-JOKKFPA.h b/src/cube.sync-conflict-20230524-182143-JOKKFPA.h @@ -0,0 +1,27 @@ +typedef enum { + U, U2, U3, D, D2, D3, + R, R2, R3, L, L2, L3, + F, F2, F3, B, B2, B3 +} move_t; +typedef struct { + uint64_t e; + uint64_t c; +} cube_t; + +extern cube_t solvedcube; +extern cube_t errorcube; + +bool isconsistent(cube_t); +bool issolved(cube_t); + +cube_t readcube(char *); +void writecube(cube_t, char *); + +int readmoves(char *, move_t *); +void writemoves(move_t *, int, char *); + +/* +cube_t move(move_t, cube_t); +cube_t inverse(cube_t); + +*/ diff --git a/src/cube.sync-conflict-20230524-182146-JOKKFPA.c b/src/cube.sync-conflict-20230524-182146-JOKKFPA.c @@ -0,0 +1,614 @@ +/* +# Cube representation, moves, transformations and indexing + +## String description + +The functions readcube() and writecube() use the following format. +Each edge is represented by two letters denoting the sides it belongs to +and one number denoting its orientation (0 oriented, 1 mis-oriented). +Similarly, each corner is represented by three letters and a number +(0 oriented, 1 twisted clockwise, 2 twisted counter-clockwise). +Edge orientation is relative to the F / B axis, corner orientation is +relative to the U / D axis. + +The correct order of the pieces is the same as that defined in the +section "Internal cube representation", except that pieces are read +left-to-right. Pieces are divided by slices, so the ordering is not the +most intuitive, but it is more convenient for the internal representation. + +Whitespaces between pieces are ignored when reading the cube, and a +single whitespace character is added between pieces when writing. + +For example, the solved cube looks like this: + +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 + +The cube after the moves R'U'F looks like this: + +FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0 UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0 + +More formats might be supported in the future. + +## Internal cube representation + +The cube_t data structure implemented in this file is designed to +efficiently perform common operations on a 3x3x3 Rubik's cube when +solving it with an iterative-deepening DFS search. It is not the most +general, complete, easy to read or compact one. Since the cube can +be trivially reoriented before the search, we only encode permutations +of the cube that keep the center pieces in a fixed position (that is, +we do not encode the position of the centers). + +The cube state is encoded in two 64-bit integers, one for edges and one +for centers. We explain how edges are encoded first, and the highlight +the few differences with corners afterwards. + +For encoding edges, only the 60 least-significant bits are used. Each +edge described by 5 bits. The position of a 5-bit block in the 64-bit +integer determine the position of the edge piece in the cube, according +to the following table (least-significant bits on the right): + +55-59 50-54 45-49 40-44 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + BR BL FL FR DR DL UL UR DF DB UB UF +ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee ossee + +For each edge, the 4 least-significant bits ('ssee' in the table) +determine the piece. The two bits marked with 'ss' determine the internal +slice the piece belongs to, i.e. they are either '00' for M, '01' for +S or '10' for E. The other two bits (marked with 'ee') determine the +actual edge piece among the 4 in the same slice, and they are assigned +somewhat arbitarily. Using this representation and the ordering defined +in the table above, the edges are correctly permuted when these 4 bits +for each represent the numbers 0 to 11 in the correct order. + +The last bit determines the orientation. The orientation of an edge +depends on its position, and it is defined being 0 if the edge can be +moved to its place in the solved orientation by permutations in the +subgroup <U, D, R, L, F2, B2>. + +Corners are encoded in the 48 least-significant bits, and are described +by 6 bits each, their position being defined by the following table: + + 35-39 30-34 25-29 20-24 15-19 10-14 5-9 0-4 + DBL DFL UBR UFL DBR DFL UBL UFR +oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc oooxcc + +The bit marked with an 'x' describes the axis the corner belongs to. +The 0 axis consists of the corners UFR, UBL, DFL and DBR, and the other +four corners form the axis marked with 1. Then two bits are needed to +identify the corner among the four of the same axis. The last three bits +determine the orientation, where one corner is defined to be oriented +(marked with '000') if its top or bottom sticker faces the top or bottom +side. A corner a clockwise turn away from being oriented, thus requiring +a counter-clockwise turn to be oriented correctly, is marked with '001', +and a corner a counter-clockwise turn away is marked with '010'. The most +significant bit is not used to determine the corner orientation, but it +must always be set to '0' to simplify the moving operations (see below). + +## Basic moves + +The 18 basic moves of the cube could be performed by applying a suitable +general permutation (see below), but they have instead been manually +implemented with a few simple operations each, to improve performance. + +For each move we first permute the pieces. This amounts to shifting +around 4 blocks of bits for edges and 4 for corners. Since in some cases +adjacent pieces on the cube are also adjacent in the bit representation we +use, we can save some operations by shifting multiple blocks together. +For example, for the move U for edges we shift a block of 15 bits 5 +positions to the left and a block of 5 bits 15 positions to the right. + +There are some moves that change the orientation of the pieces. Namely, +the moves F, F', B and B' change the orientation of the edges and those +moves as well as R, R', L and L' change the orientation of the corners. +Edge orientation is easy to address: we simply xor the edge representation +by a bit mask with zeroes everywhere except for the 4 edges that need +to be flipped (i.e. the ones on the twisted face). + +Corner orientation is harder to reproduce efficiently working only with +bitwise operations, as it involves performing operations modulo 3. +However, with the help of the extra bit we reserved, we are able to +do this using only two additions and 3 bitwise operations, without +any multiplication, division or modulo operation. The trick is +to use the following formula to sum two numbers x, y in {0,1,2}: + + ((x+y) + (x+y+1)/4) % 4 + +The thrid bit is needed because x+y and x+y+1 can exceed 3. +See below (in the code) for the details. + +## Inverting the cube + +TODO + +## Transformations (conjugations by full-cube rotations) + +TODO + +## Indexing + +TODO - subgroup description etc + +Ideas for pruning (for another file?): +- Use corner separation + CO as main coordinate (~150k states) + - for huge tables, htr corners can be used (6 times larger) +- Symmetry table, one entry or each main coordinate value with the + following info: + - index of the corresponding main symcoord (13 bits) + - transtorep (6 bits) + - base value for pruning table (5 bits, probably 4) + - pruning value for only main coord, i.e. fallback (4 bits) +- To get a full coord for the cube: + - get first coord c, get the transtorep + - transform edges with transtorep + - get second coordinate e + - return c * MAXE + e + - This is still too big, so divide by a power of 2 to get the hashed index + - second coordinate: ep always, + varible number of eo bit (0 to 11) +- Generate table: + - first probe for base value: + - solve coord using fallback table for pruning for 10k random states or so + - loop over all possible values (even if going for smaller table) + - with inverse-index strategy or what? + - use 1 bit per entry (more than base value or not) +*/ + +#include <stdbool.h> +#include <stdint.h> +#include <string.h> + +#ifdef DEBUG +#include <stdio.h> +#endif + +#include "cube.h" + +#define _error 0xFFFFFFFF + +#define _esize 5ULL +#define _eoblock 0x10ULL /* 10000 */ +#define _epblock 0x0FULL /* 01111 */ +#define _eblock 0x1FULL /* 11111 */ + +#define _csize 6ULL +#define _coblock 0x18ULL /* 011000 */ +#define _cpblock 0x07ULL /* 000111 */ +#define _cblock 0x3FULL /* 111111 */ + +#define _edge_uf 0ULL /* 00 00 */ +#define _edge_ub 1ULL /* 00 01 */ +#define _edge_db 2ULL /* 00 10 */ +#define _edge_df 3ULL /* 00 11 */ +#define _edge_ur 4ULL /* 01 00 */ +#define _edge_ul 5ULL /* 01 01 */ +#define _edge_dl 6ULL /* 01 10 */ +#define _edge_dr 7ULL /* 01 11 */ +#define _edge_fr 8ULL /* 10 00 */ +#define _edge_fl 9ULL /* 10 01 */ +#define _edge_bl 10ULL /* 10 10 */ +#define _edge_br 11ULL /* 10 11 */ + +#define _corner_ufr 0ULL /* 0 00 */ +#define _corner_ubl 1ULL /* 0 01 */ +#define _corner_dfl 2ULL /* 0 10 */ +#define _corner_dbr 3ULL /* 0 11 */ +#define _corner_ufl 4ULL /* 1 00 */ +#define _corner_ubr 5ULL /* 1 01 */ +#define _corner_dfr 6ULL /* 1 10 */ +#define _corner_dbl 7ULL /* 1 11 */ + +#define ESHIFT(i) ((i) * _esize) +#define EOSHIFT(i) (4ULL + (i) * _esize) +#define EMASK(i) (_eblock << ESHIFT(i)) +#define EOMASK(i) (_eoblock << ESHIFT(i)) +#define EPMASK(i) (_epblock << ESHIFT(i)) +#define ESOLVED(ee) (_edge_##ee << (_edge_##ee * _esize)) +#define EDGEAT(e, i) (((e) & EMASK(i)) >> ESHIFT(i)) +#define EOAT(e, i) (((e) & EOMASK(i)) >> EOSHIFT(i)) +#define EPAT(e, i) (((e) & EPMASK(i)) >> ESHIFT(i)) + +#define CSHIFT(i) ((i) * _csize) +#define COSHIFT(i) (3ULL + (i) * _csize) +#define CMASK(i) (_cblock << CSHIFT(i)) +#define COMASK(i) (_coblock << CSHIFT(i)) +#define CPMASK(i) (_cpblock << CSHIFT(i)) +#define CSOLVED(ccc) (_corner_##ccc << (_corner_##ccc * _csize)) +#define CORNERAT(c, i) (((c) & CMASK(i)) >> CSHIFT(i)) +#define COAT(c, i) (((c) & COMASK(i)) >> COSHIFT(i)) +#define CPAT(c, i) (((c) & CPMASK(i)) >> CSHIFT(i)) + +#define _emask_u (EMASK(uf) | EMASK(ul) | EMASK(ub) | EMASK(ur)) +#define _emask_d (EMASK(df) | EMASK(dl) | EMASK(db) | EMASK(dr)) +#define _emask_r (EMASK(ur) | EMASK(dr) | EMASK(fr) | EMASK(br)) +#define _emask_l (EMASK(ul) | EMASK(dl) | EMASK(fl) | EMASK(bl)) +#define _emask_f (EMASK(uf) | EMASK(df) | EMASK(fr) | EMASK(fl)) +#define _emask_b (EMASK(ub) | EMASK(db) | EMASK(br) | EMASK(bl)) + +#define _cmask_u (CMASK(ufr) | CMASK(ufl) | CMASK(ubl) | CMASK(ubr)) +#define _cmask_d (CMASK(dfr) | CMASK(dfl) | CMASK(dbl) | CMASK(dbr)) +#define _cmask_r (CMASK(ufr) | CMASK(dfr) | CMASK(ubr) | CMASK(dbr)) +#define _cmask_l (CMASK(ufl) | CMASK(dfl) | CMASK(ubl) | CMASK(dbl)) +#define _cmask_f (CMASK(ufr) | CMASK(ufl) | CMASK(dfr) | CMASK(dfl)) +#define _cmask_b (CMASK(ubr) | CMASK(ubl) | CMASK(dbr) | CMASK(dbl)) + +#define _eomask (EOMASK(uf) | EOMASK(ul) | EOMASK(ub) | EOMASK(ur) \ + EOMASK(df) | EOMASK(dl) | EOMASK(db) | EOMASK(dr) \ + EOMASK(fr) | EOMASK(fl) | EOMASK(bl) | EOMASK(br)) +#define _comask (COMASK(ufr) | COMASK(ufl) | COMASK(ubl) | COMASK(ubr) \ + COMASK(dfr) | COMASK(dfl) | COMASK(dbl) | COMASK(dbr)) + +static uint64_t permsign(uint64_t *, int); +static uint64_t readep(char *); +static uint64_t readeo(char *); +static uint64_t readcp(char *); +static uint64_t readco(char *); +static uint64_t readmove(char); +static uint64_t readmodifier(char); + +static char *edgestr[] = { + [_edge_uf] = "UF", + [_edge_ub] = "UB", + [_edge_db] = "DB", + [_edge_df] = "DF", + [_edge_ur] = "UR", + [_edge_ul] = "UL", + [_edge_dl] = "DL", + [_edge_dr] = "DR", + [_edge_fr] = "FR", + [_edge_fl] = "FL", + [_edge_bl] = "BL", + [_edge_br] = "BR" +}; +static char *cornerstr[] = { + [_corner_ufr] = "UFR", + [_corner_ubl] = "UBL", + [_corner_dfl] = "DFL", + [_corner_dbr] = "DBR", + [_corner_ufl] = "UFL", + [_corner_ubr] = "UBR", + [_corner_dfr] = "DFR", + [_corner_dbl] = "DBL" +}; +static char *movestr[] = { + [U] = "U", [U2] = "U2", [U3] = "U'", + [D] = "D", [D2] = "D2", [D3] = "D'", + [R] = "R", [R2] = "R2", [R3] = "R'", + [L] = "L", [L2] = "L2", [L3] = "L'", + [F] = "F", [F2] = "F2", [F3] = "F'", + [B] = "B", [B2] = "B2", [B3] = "B'", +}; + +cube_t solvedcube = { + .e = ESOLVED(uf) | ESOLVED(ul) | ESOLVED(ub) | ESOLVED(ur) | + ESOLVED(df) | ESOLVED(dl) | ESOLVED(db) | ESOLVED(dr) | + ESOLVED(fr) | ESOLVED(fl) | ESOLVED(bl) | ESOLVED(br), + .c = CSOLVED(ufr) | CSOLVED(ufl) | CSOLVED(ubl) | CSOLVED(ubr) | + CSOLVED(dfr) | CSOLVED(dfl) | CSOLVED(dbl) | CSOLVED(dbr), +}; +cube_t errorcube = { .e = _error, .c = _error }; + + +static uint64_t +permsign(uint64_t *a, int n) +{ + int i, j; + uint64_t ret; + + ret = 0; + + for (i = 0; i < n; i++) + for (j = i+1; j < n; j++) + ret += a[i] > a[j] ? 1 : 0; + + return ret % 2; +} + +bool +isconsistent(cube_t cube) +{ + uint64_t p[12], sum; + bool found[12]; + int i; + + sum = 0; + + /* Check for EP consistency */ + for (i = 0; i < 12; i++) + found[i] = false; + for (i = 0; i < 12; i++) { + p[i] = EPAT(cube.e, i); + found[p[i]] = true; + } + for (i = 0; i < 12; i++) + if (!found[i]) + return false; + sum = permsign(p, 12); + + /* Check for CP consistency */ + for (i = 0; i < 8; i++) + found[i] = false; + for (i = 0; i < 8; i++) { + p[i] = CPAT(cube.c, i); + found[p[i]] = true; + } + for (i = 0; i < 8; i++) + if (!found[i]) + return false; + sum += permsign(p, 8); + + /* Check permutation parity */ + if (sum % 2 != 0) + return false; + + /* Check for EO parity */ + for (i = 0, sum = 0; i < 12; i++) + sum += EOAT(cube.e, i); + if (sum % 2 != 0) + return false; + + /* Check for CO parity */ + for (i = 0, sum = 0; i < 8; i++) + sum += COAT(cube.c, i); + if (sum % 3 != 0) + return false; + + /* Check that CO extra bit is zero */ + for (i = 0; i < 8; i++) + if (cube.c & (1ULL << (5 + i * _csize))) + return false; + + return true; +} + +bool +issolved(cube_t cube) +{ + return cube.c == solvedcube.c && cube.e == solvedcube.e; +} + + +static uint64_t +readep(char *str) +{ + if (!strncmp(str, "UF", 2)) + return _edge_uf; + if (!strncmp(str, "UL", 2)) + return _edge_ul; + if (!strncmp(str, "UB", 2)) + return _edge_ub; + if (!strncmp(str, "UR", 2)) + return _edge_ur; + if (!strncmp(str, "DF", 2)) + return _edge_df; + if (!strncmp(str, "DL", 2)) + return _edge_dl; + if (!strncmp(str, "DB", 2)) + return _edge_db; + if (!strncmp(str, "DR", 2)) + return _edge_dr; + if (!strncmp(str, "FR", 2)) + return _edge_fr; + if (!strncmp(str, "FL", 2)) + return _edge_fl; + if (!strncmp(str, "BL", 2)) + return _edge_bl; + if (!strncmp(str, "BR", 2)) + return _edge_br; + + return _error; +} + +static uint64_t +readeo(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + + return _error; +} + +static uint64_t +readcp(char *str) +{ + if (!strncmp(str, "UFR", 3) || !strncmp(str, "URF", 3)) + return _corner_ufr; + if (!strncmp(str, "UFL", 3) || !strncmp(str, "ULF", 3)) + return _corner_ufl; + if (!strncmp(str, "UBL", 3) || !strncmp(str, "ULB", 3)) + return _corner_ubl; + if (!strncmp(str, "UBR", 3) || !strncmp(str, "URB", 3)) + return _corner_ubr; + if (!strncmp(str, "DFR", 3) || !strncmp(str, "DRF", 3)) + return _corner_dfr; + if (!strncmp(str, "DFL", 3) || !strncmp(str, "DLF", 3)) + return _corner_dfl; + if (!strncmp(str, "DBL", 3) || !strncmp(str, "DLB", 3)) + return _corner_dbl; + if (!strncmp(str, "DBR", 3) || !strncmp(str, "DRB", 3)) + return _corner_dbr; + + return _error; +} + +static uint64_t +readco(char *str) +{ + if (*str == '0') + return 0ULL; + if (*str == '1') + return 1ULL; + if (*str == '2') + return 2ULL; + + return _error; +} + +cube_t +readcube(char *buf) +{ + int i; + uint64_t piece, orient; + cube_t ret = {0}; + char *b = buf; + + for (i = 0; i < 12; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readep(b)) == _error) + goto readcube_error; + b += 2; + if ((orient = readeo(b)) == _error) + goto readcube_error; + b++; + ret.e |= (piece << ESHIFT(i)) | (orient << EOSHIFT(i)); + } + for (i = 0; i < 8; i++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((piece = readcp(b)) == _error) + goto readcube_error; + b += 3; + if ((orient = readco(b)) == _error) + goto readcube_error; + b++; + ret.c |= (piece << CSHIFT(i)) | (orient << COSHIFT(i)); + } + + return ret; + +readcube_error: + return errorcube; +} + +void +writecube(cube_t cube, char *buf) +{ + char *errormsg; + uint64_t piece; + size_t len; + int i; + + if (!isconsistent(cube)) { + errormsg = "ERROR: cannot write inconsistent cube"; + goto writecube_error; + } + + for (i = 0; i < 12; i++) { + piece = EPAT(cube.e, i); + buf[4*i ] = edgestr[piece][0]; + buf[4*i + 1] = edgestr[piece][1]; + buf[4*i + 2] = EOAT(cube.e, i) + '0'; + buf[4*i + 3] = ' '; + } + for (i = 0; i < 8; i++) { + piece = CPAT(cube.c, i); + buf[48 + 5*i ] = cornerstr[piece][0]; + buf[48 + 5*i + 1] = cornerstr[piece][1]; + buf[48 + 5*i + 2] = cornerstr[piece][2]; + buf[48 + 5*i + 3] = COAT(cube.c, i) + '0'; + buf[48 + 5*i + 4] = ' '; + } + + buf[48+39] = '\0'; + + return; + +writecube_error: + len = strlen(errormsg); + strcpy(buf, errormsg); + buf[len] = '\n'; + buf[len+1] = '\0'; +} + + +static uint64_t +readmove(char c) +{ + switch (c) { + case 'U': + return U; + case 'D': + return D; + case 'R': + return R; + case 'L': + return L; + case 'F': + return F; + case 'B': + return B; + default: + return _error; + } +} + +static uint64_t +readmodifier(char c) +{ + switch (c) { + case '1': /* Fallthrough */ + case '2': /* Fallthrough */ + case '3': + return c - '0' - 1; + case '\'': + return 2; + default: + return 0; + } +} + +int +readmoves(char *buf, move_t *m) +{ + int n; + uint64_t r; + char *b; + + for (b = buf, n = 0; *b != '\0'; b++) { + while (*b == ' ' || *b == '\t' || *b == '\n') + b++; + if ((r = readmove(*b)) == _error) + return -1; + m[n] = (move_t)r; + if ((r = readmodifier(*(b+1))) != 0) { + b++; + m[n] += r; + } + n++; + } + + return n; +} + +void +writemoves(move_t *m, int n, char *buf) +{ + int i; + char *b, *s; + + for (i = 0, b = buf; i < n; i++, b++) { + s = movestr[m[i]]; + strcpy(b, s); + b += strlen(s); + *b = ' '; + } + *b = '\0'; +} + + +cube_t +move(move_t m, cube_t c) +{ + /* TODO - not implemented yet */ + + cube_t ret = {0}; + + switch (m) { + case U: + return ret; + default: + return ret; + } +} diff --git a/src/cube.sync-conflict-20230524-182146-JOKKFPA.h b/src/cube.sync-conflict-20230524-182146-JOKKFPA.h @@ -0,0 +1,27 @@ +typedef enum { + U, U2, U3, D, D2, D3, + R, R2, R3, L, L2, L3, + F, F2, F3, B, B2, B3 +} move_t; +typedef struct { + uint64_t e; + uint64_t c; +} cube_t; + +extern cube_t solvedcube; +extern cube_t errorcube; + +bool isconsistent(cube_t); +bool issolved(cube_t); + +cube_t readcube(char *); +void writecube(cube_t, char *); + +int readmoves(char *, move_t *); +void writemoves(move_t *, int, char *); + +/* +cube_t move(move_t, cube_t); +cube_t inverse(cube_t); + +*/ diff --git a/test/basic/all.in b/test/basic/all.in diff --git a/test/basic/all.out b/test/basic/all.out @@ -0,0 +1,4 @@ +Solved is consistent +Solved is solved +Zero is NOT consistent +Zero is NOT solved diff --git a/test/basic/basic_tests.c b/test/basic/basic_tests.c @@ -0,0 +1,19 @@ +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> + +#include "../../src/cube.h" + +int main() { + cube_t z, s; + + s = solvedcube; + printf("Solved %s consistent\n", isconsistent(s) ? "is" : "is NOT"); + printf("Solved %s solved\n", issolved(s) ? "is" : "is NOT"); + + z = (cube_t){0}; + printf("Zero %s consistent\n", isconsistent(z) ? "is" : "is NOT"); + printf("Zero %s solved\n", issolved(z) ? "is" : "is NOT"); + + return 0; +} diff --git a/test/io/00_garbage.in b/test/io/00_garbage.in @@ -0,0 +1,3 @@ +FUF0 UBBBR2 k4 +hello +garbage diff --git a/test/io/00_garbage.out b/test/io/00_garbage.out @@ -0,0 +1 @@ +Error reading cube diff --git a/test/io/01_solved_oneline.in b/test/io/01_solved_oneline.in @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/01_solved_oneline.out b/test/io/01_solved_oneline.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/02_solved_oneline_whitespace.in b/test/io/02_solved_oneline_whitespace.in @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/02_solved_oneline_whitespace.out b/test/io/02_solved_oneline_whitespace.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/03_solved_multiline.in b/test/io/03_solved_multiline.in @@ -0,0 +1,9 @@ +UF0 UB0 +DB0 DF0 UR0 UL0 DL0 +DR0 FR0 FL0 BL0 BR0 UFR0 + +UBL0 DFL0 DBR0 + + +UFL0 UBR0 DFR0 + DBL0 diff --git a/test/io/03_solved_multiline.out b/test/io/03_solved_multiline.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/04_inconsistent_ep.in b/test/io/04_inconsistent_ep.in @@ -0,0 +1 @@ +UB0 UF0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/04_inconsistent_ep.out b/test/io/04_inconsistent_ep.out @@ -0,0 +1 @@ +Cube is inconsistent diff --git a/test/io/05_inconsistent_eo.in b/test/io/05_inconsistent_eo.in @@ -0,0 +1 @@ +UF1 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/05_inconsistent_eo.out b/test/io/05_inconsistent_eo.out @@ -0,0 +1 @@ +Cube is inconsistent diff --git a/test/io/06_inconsistent_cp.in b/test/io/06_inconsistent_cp.in @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UBL0 UFR0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/06_inconsistent_cp.out b/test/io/06_inconsistent_cp.out @@ -0,0 +1 @@ +Cube is inconsistent diff --git a/test/io/07_inconsistent_co.in b/test/io/07_inconsistent_co.in @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR1 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/io/07_inconsistent_co.out b/test/io/07_inconsistent_co.out @@ -0,0 +1 @@ +Cube is inconsistent diff --git a/test/io/08_unsolved.in b/test/io/08_unsolved.in @@ -0,0 +1,6 @@ +UL1 DR0 UB0 DL1 +UR0 FR1 DB0 BR0 +UF1 DF0 BL0 FL0 + +UBL0 DLF1 DBR2 UFR1 +DFR1 UBR1 UFL0 DBL0 diff --git a/test/io/08_unsolved.out b/test/io/08_unsolved.out @@ -0,0 +1 @@ +UL1 DR0 UB0 DL1 UR0 FR1 DB0 BR0 UF1 DF0 BL0 FL0 UBL0 DFL1 DBR2 UFR1 DFR1 UBR1 UFL0 DBL0 diff --git a/test/io/io_tests.c b/test/io/io_tests.c @@ -0,0 +1,28 @@ +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> + +#include "../../src/cube.h" + +#define STRLENMAX 10000 + +int main() { + char *c, str[STRLENMAX]; + cube_t cube; + + for (c = str; (*c = getchar()) != EOF; c++) ; + *c = '\0'; + + cube = readcube(str); + + if (cube.e == errorcube.e && cube.c == errorcube.c) { + printf("Error reading cube\n"); + } else if (!isconsistent(cube)) { + printf("Cube is inconsistent\n"); + } else { + writecube(cube, str); + printf("%s\n", str); + } + + return 0; +} diff --git a/test/move/000_nomove_solved.in b/test/move/000_nomove_solved.in @@ -0,0 +1,2 @@ + +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/000_nomove_solved.out b/test/move/000_nomove_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/001_nomove_scrambled.in b/test/move/001_nomove_scrambled.in @@ -0,0 +1,2 @@ + +BR0 DF1 DL1 FR0 UB1 DR1 UF0 UR0 UL0 FL1 BL0 DB1 UBL0 DBR1 UFL1 DFR2 UFR0 UBR1 DBL1 DFL0 diff --git a/test/move/001_nomove_scrambled.out b/test/move/001_nomove_scrambled.out @@ -0,0 +1 @@ +BR0 DF1 DL1 FR0 UB1 DR1 UF0 UR0 UL0 FL1 BL0 DB1 UBL0 DBR1 UFL1 DFR2 UFR0 UBR1 DBL1 DFL0 diff --git a/test/move/010_U_solved.in b/test/move/010_U_solved.in @@ -0,0 +1,2 @@ +U +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/010_U_solved.out b/test/move/010_U_solved.out @@ -0,0 +1 @@ +UR0 UL0 DB0 DF0 UB0 UF0 DL0 DR0 FR0 FL0 BL0 BR0 UBR0 UFL0 DFL0 DBR0 UFR0 UBL0 DFR0 DBL0 diff --git a/test/move/011_U_scrambled.in b/test/move/011_U_scrambled.in @@ -0,0 +1,2 @@ +U +BR0 DF1 DL1 FR0 UB1 DR1 UF0 UR0 UL0 FL1 BL0 DB1 UBL0 DBR1 UFL1 DFR2 UFR0 UBR1 DBL1 DFL0 diff --git a/test/move/011_U_scrambled.out b/test/move/011_U_scrambled.out @@ -0,0 +1 @@ +UB1 DR1 DL1 FR0 DF1 BR0 UF0 UR0 UL0 FL1 BL0 DB1 UBR1 UFR0 UFL1 DFR2 UBL0 DBR1 DBL1 DFL0 diff --git a/test/move/012_U_inverse.in b/test/move/012_U_inverse.in @@ -0,0 +1,2 @@ +U +UL0 UR0 DB0 DF0 UF0 UB0 DL0 DR0 FR0 FL0 BL0 BR0 UFL0 UBR0 DFL0 DBR0 UBL0 UFR0 DFR0 DBL0 diff --git a/test/move/012_U_inverse.out b/test/move/012_U_inverse.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/020_U2_solved.in b/test/move/020_U2_solved.in @@ -0,0 +1,2 @@ +U2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/020_U2_solved.out b/test/move/020_U2_solved.out @@ -0,0 +1 @@ +UB0 UF0 DB0 DF0 UL0 UR0 DL0 DR0 FR0 FL0 BL0 BR0 UBL0 UFR0 DFL0 DBR0 UBR0 UFL0 DFR0 DBL0 diff --git a/test/move/021_U2_scrambled.in b/test/move/021_U2_scrambled.in @@ -0,0 +1,2 @@ +U2 +BR0 DF1 DL1 FR0 UB1 DR1 UF0 UR0 UL0 FL1 BL0 DB1 UBL0 DBR1 UFL1 DFR2 UFR0 UBR1 DBL1 DFL0 diff --git a/test/move/021_U2_scrambled.out b/test/move/021_U2_scrambled.out @@ -0,0 +1 @@ +DF1 BR0 DL1 FR0 DR1 UB1 UF0 UR0 UL0 FL1 BL0 DB1 DBR1 UBL0 UFL1 DFR2 UBR1 UFR0 DBL1 DFL0 diff --git a/test/move/022_U2_inverse.in b/test/move/022_U2_inverse.in @@ -0,0 +1,2 @@ +U2 +UB0 UF0 DB0 DF0 UL0 UR0 DL0 DR0 FR0 FL0 BL0 BR0 UBL0 UFR0 DFL0 DBR0 UBR0 UFL0 DFR0 DBL0 diff --git a/test/move/022_U2_inverse.out b/test/move/022_U2_inverse.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/030_U3_solved.in b/test/move/030_U3_solved.in @@ -0,0 +1,2 @@ +U3 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/030_U3_solved.out b/test/move/030_U3_solved.out @@ -0,0 +1 @@ +UL0 UR0 DB0 DF0 UF0 UB0 DL0 DR0 FR0 FL0 BL0 BR0 UFL0 UBR0 DFL0 DBR0 UBL0 UFR0 DFR0 DBL0 diff --git a/test/move/031_U3_inverse.in b/test/move/031_U3_inverse.in @@ -0,0 +1,2 @@ +U3 +UR0 UL0 DB0 DF0 UB0 UF0 DL0 DR0 FR0 FL0 BL0 BR0 UBR0 UFL0 DFL0 DBR0 UFR0 UBL0 DFR0 DBL0 diff --git a/test/move/031_U3_inverse.out b/test/move/031_U3_inverse.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/032_U3_scrambled.in b/test/move/032_U3_scrambled.in @@ -0,0 +1,2 @@ +U3 +UF1 BR0 DL1 UR1 FR1 FL0 UL0 BL1 DR0 DF1 DB0 UB0 UBR2 DFL1 UFL0 DBR1 UBL2 DFR0 DBL2 UFR1 diff --git a/test/move/032_U3_scrambled.out b/test/move/032_U3_scrambled.out @@ -0,0 +1 @@ +FL0 FR1 DL1 UR1 UF1 BR0 UL0 BL1 DR0 DF1 DB0 UB0 UBL2 DFR0 UFL0 DBR1 DFL1 UBR2 DBL2 UFR1 diff --git a/test/move/033_U3_with_prime.in b/test/move/033_U3_with_prime.in @@ -0,0 +1,2 @@ +U' +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/033_U3_with_prime.out b/test/move/033_U3_with_prime.out @@ -0,0 +1 @@ +UL0 UR0 DB0 DF0 UF0 UB0 DL0 DR0 FR0 FL0 BL0 BR0 UFL0 UBR0 DFL0 DBR0 UBL0 UFR0 DFR0 DBL0 diff --git a/test/move/040_D_solved.in b/test/move/040_D_solved.in @@ -0,0 +1,2 @@ +D +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/040_D_solved.out b/test/move/040_D_solved.out @@ -0,0 +1 @@ +UF0 UB0 DR0 DL0 UR0 UL0 DB0 DF0 FR0 FL0 BL0 BR0 UFR0 UBL0 DBL0 DFR0 UFL0 UBR0 DFL0 DBR0 diff --git a/test/move/050_D2_solved.in b/test/move/050_D2_solved.in @@ -0,0 +1,2 @@ +D2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/050_D2_solved.out b/test/move/050_D2_solved.out @@ -0,0 +1 @@ +UF0 UB0 DF0 DB0 UR0 UL0 DR0 DL0 FR0 FL0 BL0 BR0 UFR0 UBL0 DBR0 DFL0 UFL0 UBR0 DBL0 DFR0 diff --git a/test/move/060_D3_solved.in b/test/move/060_D3_solved.in @@ -0,0 +1,2 @@ +D3 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/060_D3_solved.out b/test/move/060_D3_solved.out @@ -0,0 +1 @@ +UF0 UB0 DL0 DR0 UR0 UL0 DF0 DB0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFR0 DBL0 UFL0 UBR0 DBR0 DFL0 diff --git a/test/move/070_R_solved.in b/test/move/070_R_solved.in @@ -0,0 +1,2 @@ +R +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/070_R_solved.out b/test/move/070_R_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 FR0 UL0 DL0 BR0 DR0 FL0 BL0 UR0 DFR2 UBL0 DFL0 UBR2 UFL0 UFR1 DBR1 DBL0 diff --git a/test/move/071_R_scrambled.in b/test/move/071_R_scrambled.in @@ -0,0 +1,2 @@ +R +UF1 BR0 DL1 UR1 FR1 FL0 UL0 BL1 DR0 DF1 DB0 UB0 UBR2 DFL1 UFL0 DBR1 UBL2 DFR0 DBL2 UFR1 diff --git a/test/move/071_R_scrambled.out b/test/move/071_R_scrambled.out @@ -0,0 +1 @@ +UF1 BR0 DL1 UR1 DR0 FL0 UL0 UB0 BL1 DF1 DB0 FR1 DBL1 DFL1 UFL0 DFR2 UBL2 UBR0 DBR2 UFR1 diff --git a/test/move/080_R2_solved.in b/test/move/080_R2_solved.in @@ -0,0 +1,2 @@ +R2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/080_R2_solved.out b/test/move/080_R2_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 DR0 UL0 DL0 UR0 BR0 FL0 BL0 FR0 DBR0 UBL0 DFL0 UFR0 UFL0 DFR0 UBR0 DBL0 diff --git a/test/move/090_R3_solved.in b/test/move/090_R3_solved.in @@ -0,0 +1,2 @@ +R3 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/090_R3_solved.out b/test/move/090_R3_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 BR0 UL0 DL0 FR0 UR0 FL0 BL0 DR0 UBR2 UBL0 DFL0 DFR2 UFL0 DBR1 UFR1 DBL0 diff --git a/test/move/100_L_solved.in b/test/move/100_L_solved.in @@ -0,0 +1,2 @@ +L +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/100_L_solved.out b/test/move/100_L_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 BL0 FL0 DR0 FR0 UL0 DL0 BR0 UFR0 DBL2 UFL2 DBR0 UBL1 UBR0 DFR0 DFL1 diff --git a/test/move/110_L2_solved.in b/test/move/110_L2_solved.in @@ -0,0 +1,2 @@ +L2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/110_L2_solved.out b/test/move/110_L2_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 DL0 UL0 DR0 FR0 BL0 FL0 BR0 UFR0 DFL0 UBL0 DBR0 DBL0 UBR0 DFR0 UFL0 diff --git a/test/move/120_L3_solved.in b/test/move/120_L3_solved.in @@ -0,0 +1,2 @@ +L3 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/120_L3_solved.out b/test/move/120_L3_solved.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 FL0 BL0 DR0 FR0 DL0 UL0 BR0 UFR0 UFL2 DBL2 DBR0 DFL1 UBR0 DFR0 UBL1 diff --git a/test/move/130_F_solved.in b/test/move/130_F_solved.in @@ -0,0 +1,2 @@ +F +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/130_F_solved.out b/test/move/130_F_solved.out @@ -0,0 +1 @@ +FL1 UB0 DB0 FR1 UR0 UL0 DL0 DR0 UF1 DF1 BL0 BR0 UFL1 UBL0 DFR1 DBR0 DFL2 UBR0 UFR2 DBL0 diff --git a/test/move/132_F_scrambled.in b/test/move/132_F_scrambled.in @@ -0,0 +1,2 @@ +F +DL1 BR0 DR0 UR1 DF0 FL1 BL0 UL0 FR0 UF0 DB1 UB0 UFR0 DBL1 DBR0 UFL1 DFR1 DFL1 UBL2 UBR0 diff --git a/test/move/132_F_scrambled.out b/test/move/132_F_scrambled.out @@ -0,0 +1 @@ +UF1 BR0 DR0 FR1 DF0 FL1 BL0 UL0 DL0 UR0 DB1 UB0 DFR2 DBL1 UBL0 UFL1 DBR2 DFL1 UFR2 UBR0 diff --git a/test/move/133_F_scrambled_2.in b/test/move/133_F_scrambled_2.in @@ -0,0 +1,2 @@ +F +BL1 DB0 UL1 DF0 BR1 UF1 DL0 FL1 UB0 DR1 FR1 UR1 UBR2 UBL1 DFR2 DBL2 DBR0 DFL0 UFR0 UFL2 diff --git a/test/move/133_F_scrambled_2.out b/test/move/133_F_scrambled_2.out @@ -0,0 +1 @@ +DR0 DB0 UL1 UB1 BR1 UF1 DL0 FL1 BL0 DF1 FR1 UR1 DBR1 UBL1 UFR1 DBL2 DFR1 DFL0 UBR1 UFL2 diff --git a/test/move/140_F2_solved.in b/test/move/140_F2_solved.in @@ -0,0 +1,2 @@ +F2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/140_F2_solved.out b/test/move/140_F2_solved.out @@ -0,0 +1 @@ +DF0 UB0 DB0 UF0 UR0 UL0 DL0 DR0 FL0 FR0 BL0 BR0 DFL0 UBL0 UFR0 DBR0 DFR0 UBR0 UFL0 DBL0 diff --git a/test/move/150_F3_solved.in b/test/move/150_F3_solved.in @@ -0,0 +1,2 @@ +F3 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/150_F3_solved.out b/test/move/150_F3_solved.out @@ -0,0 +1 @@ +FR1 UB0 DB0 FL1 UR0 UL0 DL0 DR0 DF1 UF1 BL0 BR0 DFR1 UBL0 UFL1 DBR0 UFR2 UBR0 DFL2 DBL0 diff --git a/test/move/160_B_solved.in b/test/move/160_B_solved.in @@ -0,0 +1,2 @@ +B +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/160_B_solved.out b/test/move/160_B_solved.out @@ -0,0 +1 @@ +UF0 BR1 BL1 DF0 UR0 UL0 DL0 DR0 FR0 FL0 UB1 DB1 UFR0 UBR1 DFL0 DBL1 UFL0 DBR2 DFR0 UBL2 diff --git a/test/move/170_B2_solved.in b/test/move/170_B2_solved.in @@ -0,0 +1,2 @@ +B2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/170_B2_solved.out b/test/move/170_B2_solved.out @@ -0,0 +1 @@ +UF0 DB0 UB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BR0 BL0 UFR0 DBR0 DFL0 UBL0 UFL0 DBL0 DFR0 UBR0 diff --git a/test/move/180_B3_solved.in b/test/move/180_B3_solved.in @@ -0,0 +1,2 @@ +B3 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/180_B3_solved.out b/test/move/180_B3_solved.out @@ -0,0 +1 @@ +UF0 BL1 BR1 DF0 UR0 UL0 DL0 DR0 FR0 FL0 DB1 UB1 UFR0 DBL1 DFL0 UBR1 UFL0 UBL2 DFR0 DBR2 diff --git a/test/move/200_scramble_solved.in b/test/move/200_scramble_solved.in @@ -0,0 +1,2 @@ +B' D' B' R2 B' R F D F2 U2 B D2 F R2 F2 L2 F L2 U2 +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/200_scramble_solved.out b/test/move/200_scramble_solved.out @@ -0,0 +1 @@ +BR0 DF0 FL1 UB0 BL0 FR1 UR1 UL0 DR1 DB0 UF1 DL1 DFL0 DFR0 UFL1 UBL2 DBR1 DBL0 UFR1 UBR1 diff --git a/test/move/201_solution_scrambled.in b/test/move/201_solution_scrambled.in @@ -0,0 +1,2 @@ +F' B' D2 U2 F2 U' L' U D B D' R2 B' L' R' D' R D L2 U' L' B L L U F U' F' U F U' F2 L' F U F U' F' U2 F2 R2 L2 B2 +BR0 DF0 FL1 UB0 BL0 FR1 UR1 UL0 DR1 DB0 UF1 DL1 DFL0 DFR0 UFL1 UBL2 DBR1 DBL0 UFR1 UBR1 diff --git a/test/move/201_solution_scrambled.out b/test/move/201_solution_scrambled.out @@ -0,0 +1 @@ +UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 diff --git a/test/move/move_tests.c b/test/move/move_tests.c @@ -0,0 +1,40 @@ +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> + +#include "../../src/cube.h" + +#define STRLENMAX 10000 +#define MOVESMAX 1000 + +int main() { + char str[STRLENMAX]; + int i, n; + move_t moves[MOVESMAX]; + cube_t cube; + + fgets(str, STRLENMAX, stdin); + n = readmoves(str, moves); + + if (n == -1) { + printf("Error reading moves\n"); + return 1; + } + + fgets(str, STRLENMAX, stdin); + cube = readcube(str); + + for (i = 0; i < n; i++) + cube = move(cube, moves[i]); + + if (cube.e == errorcube.e && cube.c == errorcube.c) { + printf("Error moving cube\n"); + } else if (!isconsistent(cube)) { + printf("Moved cube is inconsistent\n"); + } else { + writecube(cube, str); + printf("%s\n", str); + } + + return 0; +} diff --git a/test/test.sh b/test/test.sh @@ -0,0 +1,32 @@ +#!/bin/sh + +CC="cc -DDEBUG -std=c99 -pthread -pedantic -Wall -Wextra \ + -Wno-unused-parameter -Wno-unused-function -g3" +if [ $(uname) != "OpenBSD" ]; then + CC="$CC -fsanitize=address -fsanitize=undefined" +fi +SRC="src/cube.c" +TESTBIN="test/run" +TESTOUT="test/last.out" +TESTERR="test/last.err" + +for t in test/*; do + if [ ! -d $t ]; then continue; fi + $CC -o $TESTBIN $t/*.c $SRC || exit 1; + for cin in $t/*.in; do + c=$(echo "$cin" | sed 's/\.in//') + cout=$c.out + printf "$c: " + $TESTBIN < "$cin" > $TESTOUT 2> $TESTERR + if diff $cout $TESTOUT; then + printf "OK\n" + else + printf "Test failed! stderr:\n" + cat $TESTERR + exit 1 + fi + done +done + +echo "All tests passed!" +rm -rf $TESTBIN $TESTOUT $TESTERR