diff --git a/Makefile b/Makefile index 033b1ac7d..c98a0c1c1 100644 --- a/Makefile +++ b/Makefile @@ -113,7 +113,7 @@ CFLAGS=-L ../build/Debug+Asserts/lib \ SCAFFOLD=scaffold -all: Sqct Clang +all: Clang Clang: llvm build @cd llvm/tools && /bin/rm -f clang && /bin/ln -s ../../clang; @@ -141,12 +141,8 @@ llvm: Scaffold: @cd scaffold && make; -Sqct: - @cd Rotations/sqct && make - clean: - @cd Rotations/sqct && make clean #cd scaffold && make clean @if [ -d build ]; then cd build && make clean; fi -.PHONY: clean Sqct Scaffold Clang +.PHONY: clean Scaffold Clang diff --git a/Rotations/sqct/.gitignore b/Rotations/sqct/.gitignore deleted file mode 100644 index bed239818..000000000 --- a/Rotations/sqct/.gitignore +++ /dev/null @@ -1,14 +0,0 @@ -*.aux -*.*~ -CMakeCache.txt -CMakeLists.txt.user -*.o -*.dir -CMakeFiles -*.cmake -*.cbp -out -doc -sqct -test -rotZ diff --git a/Rotations/sqct/COPYING b/Rotations/sqct/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/Rotations/sqct/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/Rotations/sqct/COPYING.LESSER b/Rotations/sqct/COPYING.LESSER deleted file mode 100644 index 65c5ca88a..000000000 --- a/Rotations/sqct/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/Rotations/sqct/Doxyfile b/Rotations/sqct/Doxyfile deleted file mode 100644 index 042e09f9c..000000000 --- a/Rotations/sqct/Doxyfile +++ /dev/null @@ -1,1716 +0,0 @@ -# Doxyfile 1.7.4 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" "). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = SQCT - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = 0.1 - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = Single qubit circuit toolkit - -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = doc - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = NO - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = YES - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). - -INLINE_GROUPED_CLASSES = NO - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = YES - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = NO - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = "." - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = real.hpp mpfr_header_wrapper.hpp - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. - -FILTER_SOURCE_PATTERNS = - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is adviced to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW! - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. - -ENUM_VALUES_PER_LINE = 4 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. - -USE_MATHJAX = YES - -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the -# mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvantages are that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = NO - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4 - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for -# the generated latex document. The footer should contain everything after -# the last chapter. If it is left blank doxygen will generate a -# standard footer. Notice: only use this tag if you know what you are doing! - -LATEX_FOOTER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = NO - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# pointed to by INCLUDE_PATH will be searched when a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition that -# overrules the definition found in the source code. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all references to function-like macros -# that are alone on a line, have an all uppercase name, and do not end with a -# semicolon, because these will confuse the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option also works with HAVE_DOT disabled, but it is recommended to -# install and use dot, since it yields more powerful graphs. - -CLASS_DIAGRAMS = YES - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = YES - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can set it -# explicitly to a value larger than 0 to get control over the balance -# between CPU load and processing speed. - -DOT_NUM_THREADS = 0 - -# By default doxygen will write a font called Helvetica to the output -# directory and reference it in all dot files that doxygen generates. -# When you want a differently looking font you can specify the font name -# using DOT_FONTNAME. You need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will generate a graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are svg, png, jpg, or gif. -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the -# \mscfile command). - -MSCFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = YES - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES diff --git a/Rotations/sqct/Makefile b/Rotations/sqct/Makefile deleted file mode 100644 index ae1d28cbc..000000000 --- a/Rotations/sqct/Makefile +++ /dev/null @@ -1,68 +0,0 @@ -.SUFFIXES: -.SUFFIXES: .cpp .o - -CXX=g++ -#CXXFLAGS=-Wall -fPIC -c -g -ggdb -O0 -std=c++0x -#CXXWARN=-Wall -Wextra -Wunreachable-code -CXXFLAGS=-fPIC -c -g -ggdb -O0 -std=c++0x -CXXWARN=-Wextra -Wunreachable-code -INC=-I/usr/include/boost -LIB=-L/usr/lib/boost_1_48_0 - -LDFLAGS=-static-libstdc++ -static-libgcc -static -LDLIBS=-Wl,-Bstatic -lgomp -lpthread -lmpfr -lgmpxx -lgmp -lrt -BOOST=-Wl,-Bstatic -lboost_program_options -lboost_timer -lboost_chrono -lboost_system -SO=-Wall -fPIC - -vpath %.cpp -vpath %.h - -OBJECTS=hprhelpers.o \ - resring.o \ - rint.o \ - matrix2x2.o \ - vector2.o \ - vector3hpr.o \ - output.o \ - numbersgen.o \ - gatelibrary.o \ - optsequencegenerator.o \ - seqlookupcliff.o \ - exactdecomposer.o \ - epsilonnet.o \ - netgenerator.o \ - unitaryapproximator.o \ - gcommdecomposer.o \ - sk.o \ - skdecomposer.o \ - numbers-stat.o \ - theoremverification.o \ - toptimalitytest.o \ - hoptimalitytest.o - -#all: sqct lib test -all: rotZ - -rotZ: $(OBJECTS) rotZ.o - $(CXX) $(LDFLAGS) $(INC) $(LIB) $(OBJECTS) rotZ.o -o rotZ $(BOOST) $(LDLIBS) - -sqct: $(OBJECTS) main.o - $(CXX) $(LDFLAGS) $(INC) $(LIB) $(OBJECTS) main.o -o sqct $(BOOST) $(LDLIBS) - -test: lib - $(CXX) $(LDFLAGS) test.o -o test -L. -lskdecomp $(BOOST) $(LDLIBS) - -%.o : %.cpp - $(CXX) $(CXXFLAGS) $(INC) $(LIB) $< -o $@ - -lib: libskdecomp.a -libskdecomp.a: $(OBJECTS) - #$(CXX) -shared -Wl,-soname,libskdecomp.so.1 -o libskdecomp.so.1.0 $(OBJECTS) - #ln -sf libskdecomp.so.1.0 libskdecomp.so.1 && ln -sf libskdecomp.so.1 libskdecomp.so - ar -cvq libskdecomp.a $(OBJECTS) $(BOOST) $(LDLIBS) - -install: lib - cp libskdecomp.so* /usr/lib - -clean: - rm -f rotZ sqct test *.bin *.o *.so *.so.* *.a diff --git a/Rotations/sqct/README b/Rotations/sqct/README deleted file mode 100644 index 1da96a20c..000000000 --- a/Rotations/sqct/README +++ /dev/null @@ -1,22 +0,0 @@ -SQCT -- Single Qubit Circuit Toolkit - -BUILD - -You will need the following libraries installed on your system: -1. Boost 1.48 --- program_options --- chrono --- timer --- system -2. The GNU Multiple Precision Arithmetic Library (gmp and gmpxx) -3. The GNU MPFR Library (mpfr) - -Also C++ compiler supporting C++11 is necessary. -Information about program use available through --help option. - -ABOUT -The program code based on results of http://arxiv.org/abs/1206.5236. It also implements -the version of Solovay Kitaev algorithm described in http://arxiv.org/abs/quant-ph/0505030. -In addition to Boost, The GNU Multiple Precision Arithmetic Library, The GNU MPFR Library the library -mpfr::real by Christian Schneider is used for high precision -floating point arithmetic. \ No newline at end of file diff --git a/Rotations/sqct/eapp.h b/Rotations/sqct/eapp.h deleted file mode 100644 index fc54c494f..000000000 --- a/Rotations/sqct/eapp.h +++ /dev/null @@ -1,138 +0,0 @@ -// Copyright (c) 2013 Jeff Heckey jheckey(at)ece(dot)ucsb(dot)edu -// This file uses SQCT, Copyright (c) 2012 Vadym Kliuchnikov, Dmitri Maslov, Michele Mosca; -// SQCT is distributed under LGPL v3 -// - -#include "sk.h" -#include "netgenerator.h" - -#include -#include - -#ifndef EAPP_H -#define EAPP_H - -/// \brief Options for epsilon net generation -struct enetOptions -{ - /// \brief If one element specified -- upper bound for sde of epsilon net to be - /// generated. If two elements specified -- interval of sde to be generated. - std::vector epsilon_net_layers; -}; - -//////////////////////////////////////////////////////////////////// - -struct enetApplication -{ - enetApplication( const enetOptions& options ) : - m_options(options) - {} - - /// \brief Checks if all layers generated on initial state are available - void check_initial() - { - initial_ok = true; - if( m_layers[0] == 0 ) - initial_ok = false; - - for( int i = 2; (i < initial_end) && initial_ok ; ++i ) - if( m_layers[i] == 0 ) initial_ok = false; - } - - /// \brief Collects information about parts of epsilon net available - void check_files() - { - m_layers.resize(100,0); - // collect information about available layers - for( int i = 0; i < 100; ++i ) - { - std::string name = netGenerator::fileName(i); - std::ifstream ifs(name); - if( !ifs ) - m_layers[i] = 0; - else - m_layers[i] = 1; - } - } - - /// \brief Generates all layers with \f$ sde(|\cdot|^2) \f$ in the interval [st,end) - void generate( int st, int end ) - { - if( ! initial_ok && st < initial_end ) - m_ng.generateInitial(); - - for( int i = std::max(initial_end,st) ; i < end; ++i ) - { - if( m_layers[i] == 0 ) - { - //std::cout << "\tGenerating Layer " << i << " of " << end << std::endl; - epsilonnet base_net; - base_net.loadFromFile( netGenerator::fileName(i-1).c_str() ); - std::unique_ptr res( netGenerator::generate( base_net ) ); - res->saveToFile( netGenerator::fileName(i).c_str() ); - } - } - } - - /// \brief Do the work - void process() - { - check_files(); - check_initial(); - - int sz = m_options.epsilon_net_layers.size(); - int b = m_options.epsilon_net_layers[0]; - switch( sz ) - { - case 1: - generate(0,b + 1); - break; - case 2: - generate(b,m_options.epsilon_net_layers[1] + 1); - break; - default: - std::cerr << "Wrong number of parameters. See help." << std::endl; - } - } - - void print_error_message() - { - std::cout << "Epsilon net files a not available, use --epsilon-net option" << std::endl - << "to generate them." << std::endl; - } - - bool check() - { - int st = 0; - int end = m_options.epsilon_net_layers[0] + 1; - check_files(); - check_initial(); - - if( ! initial_ok && st < initial_end ) - { - //print_error_message(); - return false; - } - - for( int i = std::max(initial_end,st) ; i < end; ++i ) - { - if( m_layers[i] == 0 ) - { - print_error_message(); - return false; - } - } - return true; - } - - const enetOptions& m_options; ///< Application options - std::vector m_layers; ///< Ones for available layers, zeros for not availible layers - static const int initial_end; ///< Maximal layer generated on initial state - bool initial_ok; ///< If all initial layers are availible - netGenerator m_ng; ///< Epsilon net generator -}; - -const int enetApplication::initial_end = 21; - -#endif // EAPP_H - diff --git a/Rotations/sqct/epsilonnet.cpp b/Rotations/sqct/epsilonnet.cpp deleted file mode 100644 index 1bf3a8f20..000000000 --- a/Rotations/sqct/epsilonnet.cpp +++ /dev/null @@ -1,443 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#include -#include -#include -#include -#include -#include "epsilonnet.h" -#include "output.h" - -#include -using boost::make_iterator_range; - -using namespace std; - -/// \brief Header of the file with epsilon net -struct epsilonnetHeader -{ - size_t nodes_count; -}; - -std::ostream& operator<<(std::ostream& out, const enetNode& node ) -{ - out << "enetNode[" << node.ipxx << "," << node.ipQxx << "," - << node.num_offset << "," << node.compl_offset << "]"; - return out; -} - -bool epsilonnet::loadFromFile(const char* filename) -{ - epsilonnetHeader eh; - ifstream ifs( filename, ios_base::binary ); - if( !ifs ) - return false; - ifs.read( (char*) &eh,sizeof(eh)); - nodes.clear(); - nodes.resize( eh.nodes_count ); - ifs.read( (char*) &nodes[0], nodes.size() * sizeof(enetNode) ); - numbers.clear(); - numbers.resize( nodes.back().num_offset ); - ifs.read( (char*) &numbers[0], numbers.size() * sizeof(ri) ); - ifs.close(); - denominator_exponent = denominatorExponent2(); - return true; -} - -epsilonnet::epsilonnet() -{ - enetNode nd={0,0,0,0}; - nodes.push_back(nd); -} - -size_t epsilonnet::nodesCount(const char* filename) const -{ - epsilonnetHeader eh; - ifstream ifs( filename, ios_base::binary ); - ifs.read( (char*) &eh,sizeof(eh)); - ifs.close(); - return eh.nodes_count; -} - -void epsilonnet::saveToFile (const char* filename) const -{ - if( numbers.size() == 0 ) - return; - - epsilonnetHeader eh; - eh.nodes_count = nodes.size(); - ofstream ofs( filename, ios_base::binary ); - ofs.write( (const char*) &eh,sizeof(eh)); - - assert( nodes.back().ipxx == 0 ); - assert( nodes.back().ipQxx == 0 ); - assert( nodes.back().num_offset == numbers.size() ); - - ofs.write( (const char*) &nodes[0], nodes.size() * sizeof(enetNode) ); - ofs.write( (const char*) &numbers[0], numbers.size() * sizeof(ri) ); - - ofs.close(); -} - -/// \brief Comparator based on pointers data -template< class T> -struct eq_ptr -{ - bool operator() ( const T* a , const T* b ) - { - return *a == *b; - } -}; - -/// \brief Modified stub of back_insert_iterator from http://www.cplusplus.com/reference/std/iterator/back_insert_iterator/ -template - class back_insert_iterator_ptr : - public iterator -{ -protected: - Container* container; - -public: - typedef Container container_type; - explicit back_insert_iterator_ptr (Container& x) : container(&x) {} - back_insert_iterator_ptr& operator= (const typename Container::value_type* value) - { container->push_back(*value); return *this; } - back_insert_iterator_ptr& operator* () - { return *this; } - back_insert_iterator_ptr& operator++ () - { return *this; } - back_insert_iterator_ptr operator++ (int) - { return *this; } -}; - -void epsilonnet::addNode( const pair< ip_type,ip_type>& ip, const nodeRangesPtr &ranges) -{ - nodes.back().ipxx = ip.first; - nodes.back().ipQxx = ip.second; - - eq_ptr< ri > eq_ri; - back_insert_iterator_ptr< vector > biit( numbers ); - - int size = numbers.size(); - unique_copy( ranges.nums_begin, ranges.nums_end , biit , eq_ri ); - nodes.back().compl_offset = numbers.size() - size; - unique_copy( ranges.nums_compl_begin, ranges.nums_compl_end , biit , eq_ri ); - - enetNode en = {0,0,numbers.size(),0}; - nodes.push_back(en); -} - -void epsilonnet::addNode(epsilonnet::ip_type ipxx, epsilonnet::ip_type ipQxx, const nodeRanges &ranges) -{ - nodes.back().ipxx = ipxx; - nodes.back().ipQxx = ipQxx; - - auto bi = back_inserter( numbers ); - int size = numbers.size(); - unique_copy( ranges.nums_begin, ranges.nums_end ,bi ); - nodes.back().compl_offset = numbers.size() - size; - unique_copy( ranges.nums_compl_begin, ranges.nums_compl_end , bi ); - - enetNode en = {0,0,numbers.size(),0}; - nodes.push_back(en); -} - -void epsilonnet::getNode(size_t node_id, nodeRanges &ranges) const -{ - const enetNode& node = nodes[ node_id ]; - ranges.nums_begin = numbers.begin() + node.num_offset; - ranges.nums_end = numbers.begin() + complOffset( node_id ); - ranges.nums_compl_begin = ranges.nums_end; - ranges.nums_compl_end = numbers.begin() + nodes[ node_id + 1 ].num_offset; -} - -size_t epsilonnet::complOffset(size_t nodeId) const -{ - const enetNode& node = nodes[ nodeId ]; - return node.num_offset + node.compl_offset; -} - -int epsilonnet::denominatorExponent2() const -{ - size_t offset = complOffset(0); - auto denom = numbers[offset].ipxx() + numbers[0].ipxx(); - int val = ri::gde2( denom ); - // overflow check - decltype( denom ) d = 1; - d <<= val; - assert( d == denom && "Sum of ipxx for number and complementary number is not a power of 2." ); - //denominator_exponent = val; - return val; -} - -int epsilonnet::sde() const -{ - int res = ::sde( 2 * denominatorExponent2(), numbers[0].abs2().gde() ); - if( res == std::numeric_limits::max() ) res = 0; - return res; -} - -double epsilonnet::findExhaustiveApproximation(const epsilonnet::vector2double &vec, epsilonnet::vi &result) const -{ - //denominator_exponent = denominatorExponent2(); - vi current; - double current_dist = 1.0; - double best_dist = 1.0; - vector2double canonical_vec = vec; - bool conj_1 = false, conj_2 = false; - int w_pow1 = 0, w_pow2 = 0; - canonical_vec.first = canonical( vec.first, w_pow1, conj_1 ); - canonical_vec.second = canonical( vec.second, w_pow2, conj_2 ); - - for( int i = 0; i < nodes.size(); ++i ) - { - current_dist = findExhaustiveApproximation( canonical_vec, current, i ); - if( best_dist > current_dist ) - { - best_dist = current_dist; - result = current; - } - } - -// cout << result.de << ":" << endl; -// cout << canonical_vec.first << result.d[0].toComplex( result.de ) << endl; -// cout << canonical_vec.second << result.d[1].toComplex( result.de ) << endl; - - if( conj_1 ) result.d[0].conjugate_eq(); - if( conj_2 ) result.d[1].conjugate_eq(); - result.d[0].mul_eq_w( w_pow1 ); - result.d[1].mul_eq_w( w_pow2 ); - result.de = denominator_exponent; - - return best_dist; -} - -typedef epsilonnet::vector2double vd; - -/// \brief Inline Euclidean distance computation -inline double dist_squared( const vd& a, const vd& b ) -{ - double d1 = a.first.real() - b.first.real(); - double d2 = a.second.real() - b.second.real(); - double d3 = a.first.imag() - b.first.imag(); - double d4 = a.second.imag() - b.second.imag(); - return d1*d1 +d2*d2 +d3*d3 + d4*d4; -} - -/// \brief Inline Euclidean distance computation -inline double dist_squared( const vd& a, double fre, double fim , double sre , double sim ) -{ - double d1 = a.first.real() - fre; - double d2 = a.second.real() - sre; - double d3 = a.first.imag() - fim; - double d4 = a.second.imag() - sim; - return d1*d1 +d2*d2 +d3*d3 + d4*d4; -} - -/// \todo Remove code duplication by changing one of epsilonnet::findExhaustiveApproximation -double epsilonnet::findExhaustiveApproximation(const epsilonnet::vector2double &vec, epsilonnet::vi &result, int node_id) const -{ - double best = 3.0; - nodeRanges nr; - getNode( node_id, nr ); - auto ic = nr.nums_begin; - auto jc = nr.nums_compl_begin; - bool tw = true; - for( auto i = nr.nums_begin; i != nr.nums_end ;++i ) - { - double iim, ire; - i->toComplex( denominator_exponent, ire, iim ); - for( auto j = nr.nums_compl_begin; j != nr.nums_compl_end; ++j ) - { - double jim, jre; - j->toComplex( denominator_exponent, jre, jim ); - double d1 = dist_squared( vec, ire, iim, jre, jim ); - double d2 = dist_squared( vec, jre, jim, ire, iim ); - - if( d1 < best ) - { - best = d1; - ic = i; jc = j; - tw = false; - } - - if( d2 < best ) - { - best = d2; - ic = i; jc = j; - tw = true; - } - } - } - - if( tw ) - { - result.d[0] = *jc; - result.d[1] = *ic; - //result.de = denominator_exponent; // -avoid extra operations - } - else - { - result.d[0] = *ic; - result.d[1] = *jc; - //result.de = denominator_exponent; // -avoid extra operations - } - - return best; -} - -double epsilonnet::findExhaustiveApproximation(const epsilonnet::vector2double &vec, epsilonnet::vi &result, int node_id, double &bdist) const -{ - nodeRanges nr; - getNode( node_id, nr ); - bool found = false; - auto ic = nr.nums_begin; - auto jc = nr.nums_compl_begin; - bool tw = true; - for( auto i = nr.nums_begin; i != nr.nums_end ;++i ) - { - double iim, ire; - i->toComplex( denominator_exponent, ire, iim ); - for( auto j = nr.nums_compl_begin; j != nr.nums_compl_end; ++j ) - { - double jim, jre; - j->toComplex( denominator_exponent, jre, jim ); - double d1 = dist_squared( vec, ire, iim, jre, jim ); - double d2 = dist_squared( vec, jre, jim, ire, iim ); - - if( d1 < bdist ) - { - found = true; - bdist = d1; - ic = i; jc = j; - tw = false; - } - - if( d2 < bdist ) - { - found = true; - bdist = d2; - ic = i; jc = j; - tw = true; - } - } - } - - if( found ) - { - if( tw ) - { - result.d[0] = *jc; - result.d[1] = *ic; - result.de = denominator_exponent; - } - else - { - result.d[0] = *ic; - result.d[1] = *jc; - result.de = denominator_exponent; - } - } - - return bdist; -} - -//// Code that was used to iterate through epsilon net. Does not required now - -//private: -// /// \brief Executes functor for all complex values in epsilon net -// template< class T> -// void for_all_complex( T& functor ) const; -// /// \brief Executes functor for all complex values in epsilon net within node -// template< class T> -// void for_all_complex( T& functor, int node_id ) const; -// /// \brief Executes functor for all complex values in epsilon net within node with fixed first element -// template< class T> -// void for_all_complex( T& functor, nodeRanges& nr, ri& a ) const; -// /// \brief Executes functor for a, b and elements that are of the form \f$ a\omega^k, a\omega^k \f$ -// template< class T> -// void for_all_complex( T& functor, std::complex& a, ri& b ) const; - -//template< class T> -//void epsilonnet::for_all_complex( T& functor ) const -//{ -// denominator_exponent = denominatorExponent2(); -// for( int i = 0; i < nodes.size() - 1 ; ++i ) -// for_all_complex( functor, i ); -//} - -//template< class T> -//void epsilonnet::for_all_complex( T& functor, int node_id ) const -//{ -// nodeRanges nr; -// getNode( node_id, nr ); -// for( auto i : make_iterator_range( nr.nums_begin, nr.nums_end) ) -// { -// ri a(i); -// if( i.is_im_eq0() ) -// { -// for_all_complex( functor, nr, a ); -// } -// else -// { -// for_all_complex( functor, nr, a ); -// a.conjugate_eq(); -// for_all_complex( functor, nr, a ); -// } -// } -//} - -//template< class T> -//void epsilonnet::for_all_complex( T& functor, nodeRanges& nr, ri& a ) const -//{ -// for( int i = 0; i < 8 ; ++i ) -// { -// a.mul_eq_w(); -// auto first = a.toComplex( denominator_exponent ); -// for( auto j : make_iterator_range(nr.nums_compl_begin, nr.nums_compl_end) ) -// { -// ri b(j); -// if( j.is_im_eq0() ) -// { -// for_all_complex( functor, first, b ); -// } -// else -// { -// for_all_complex( functor, first, b ); -// b.conjugate_eq(); -// for_all_complex( functor, first, b ); -// } -// } -// } -//} - -//template< class T> -//void epsilonnet::for_all_complex( T& functor, std::complex& first, ri& b ) const -//{ -// int max_ph = 1; -// if( all_phases ) max_ph = 8; - -// for( int i = 0; i < max_ph ; ++i ) -// { -// b.mul_eq_w(); -// auto second = b.toComplex( denominator_exponent ); -// functor( first, second ); -// functor( second, first ); -// } -//} diff --git a/Rotations/sqct/epsilonnet.h b/Rotations/sqct/epsilonnet.h deleted file mode 100644 index d539f6023..000000000 --- a/Rotations/sqct/epsilonnet.h +++ /dev/null @@ -1,142 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#ifndef EPSILONNET_H -#define EPSILONNET_H - -#include "rint.h" -#include "vector2.h" -#include - -/// \brief Node of epsilon net -struct enetNode -{ - /// \brief Type that is used for P(x) and Q(x) \see ring_int::ipxx() and ring_int::ipQxx() - typedef ring_int::pr_type ip_type; - /// \brief Value of P(x) - ip_type ipxx; - /// \brief Value of Q(x) - ip_type ipQxx; - /// \brief Index where numbers with given P(x),Q(x) starts in epsilonnet::numbers - size_t num_offset; - /// \brief Index where complementary numbers starts in epsilonnet::numbers. - /// Two numbers x,y are complementary if P(x) + P(y) is a power of 2 and Q(x) = -Q(y) - int compl_offset; -}; - -/// \brief Represents range of nodes with fixed P(x), Q(x) -struct nodeRanges -{ - /// \brief Type of the ring elements - typedef ring_int ri; - /// \brief Type of ranges iterator - typedef std::vector::const_iterator cit; - - /// \brief First element of numbers range - cit nums_begin; - /// \brief End of numbers range, the interval is [nums_begin,nums_end) - cit nums_end; - /// \brief First element of complementary numbers range \see enetNode::compl_offset - cit nums_compl_begin; - /// \brief End of complementary numbers range, the interval is [nums_compl_begin,nums_compl_end) - cit nums_compl_end; -}; - -/// \brief Represents range of nodes with fixed P(x), Q(x) -struct nodeRangesPtr -{ - /// \brief Type of the ring elements - typedef ring_int ri; - /// \brief Type of ranges iterator - typedef std::vector::const_iterator cit; - - /// \brief First element of numbers range - cit nums_begin; - /// \brief End of numbers range, the interval is [nums_begin,nums_end) - cit nums_end; - /// \brief First element of complementary numbers range \see enetNode::compl_offset - cit nums_compl_begin; - /// \brief End of complementary numbers range, the interval is [nums_compl_begin,nums_compl_end) - cit nums_compl_end; -}; - - - -/// \brief Serializable epsilon net made from the ring elements with a fixed power of \f$ \sqrt{2} \f$ in the denominator -class epsilonnet -{ -public: - /// \brief Type of the ring elements - typedef ring_int ri; - /// \brief Type for unit vectors over the ring - typedef vector2 vi; - /// \brief Type that is used for P(x) and Q(x) \see ring_int::ipxx() and ring_int::ipQxx() - typedef ri::pr_type ip_type; - /// \brief Simple complex 2 dimensional vector - typedef std::pair< std::complex< double> , std::complex< double> > vector2double; - - /// \brief Creates empty epsilon net - epsilonnet(); - - /// \brief Number of nodes in file - size_t nodesCount (const char* filename) const; - /// \brief Loads epsilon net from file - bool loadFromFile(const char* filename); - /// \brief Saves epsilon net to file - void saveToFile (const char* filename) const; - - /// \brief Adds vectors with P(x) = ip.first and Q(x) = ip.second, - /// \see ring_int::ipxx() and ring_int::ipQxx() - /// \param ranges Defines location of unit vectors - void addNode( const std::pair& ip, const nodeRangesPtr& ranges ); - - /// \brief Adds unit vectors with P(x) = ipxx and Q(x) = ipQxx - /// \see ring_int::ipxx() and ring_int::ipQxx() - /// \param ranges Defines location of unit vectors - void addNode( ip_type ipxx, ip_type ipQxx, const nodeRanges& ranges ); - - /// \brief Provides access to node by id - void getNode( size_t node_id, nodeRanges& ranges ) const; - /// \brief Finds offset of complementary part for given node - size_t complOffset( size_t nodeId ) const; - /// \brief Returns de of a base\f$ 2 \f$ for given \f$\varepsilon-\f$ net. Assumes that it is the same for all elements. - int denominatorExponent2() const; - /// \brief Returns sde of a base\f$ \sqrt{2} \f$ for given \f$\varepsilon-\f$ net. Assumes that it is the same for all elements. - int sde() const; - /// \brief Exhaustively finds the best approximating vector withing given epsilon net. - /// \note If you create epsilon net on the fly ( not loading it from file ), you need to initialize denominator_exponent before using this method. - /// \returns Euclidean distance squared to the best approximating vector - double findExhaustiveApproximation( const vector2double& vec, vi& result ) const; - - /// \brief Vector of epsilon node - std::vector nodes; - /// \brief Vector of numbers that appears in epsilon net - std::vector numbers; - /// \brief Denominator exponent of epsilon net elements - int denominator_exponent; - - /// \brief Finds exhaustive approximation within fixed node - double findExhaustiveApproximation( const vector2double& vec, vi& result, int node_id ) const; - /// \brief Finds exhaustive approximation within fixed node only if distance to the best possible vector is less than ndist. - /// Do nothing otherwise. Useful to reduce amount of copy operations - double findExhaustiveApproximation( const vector2double& vec, vi& result, int node_id, double& bdist ) const; - -}; - - -#endif // EPSILONNET_H diff --git a/Rotations/sqct/exactdecomposer.cpp b/Rotations/sqct/exactdecomposer.cpp deleted file mode 100644 index 35df64e76..000000000 --- a/Rotations/sqct/exactdecomposer.cpp +++ /dev/null @@ -1,84 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#include "exactdecomposer.h" -#include "matrix2x2.h" -#include "output.h" - -#include -#include -#include - -using namespace std; - -exactDecomposer::exactDecomposer() -{ - for( int i = 0; i < gen_count ; ++i) - { - generators[i] = M::T(8-i) * M::H() ; - generators_ctr[i] = M::H() * M::T(i); - } -} - -void exactDecomposer::decompose( const matrix2x2& matr, circuit& c) -{ - typedef ring_int< resring<8> > rr8; - typedef matrix2x2< resring<8> > mrr8; - - c.clear(); - M current(matr); - current.reduce(); - M t; - - int curr_sde = current.max_sde_abs2(); - while( curr_sde > 3 ) - { - bool found = false; - mrr8 mr( current ), tr; //the only last 8 bits matter - int curr_gde = mr.d[0][0].abs2().gde(); - - for( int i = 0; i < gen_count; ++i ) - { - - mr.mul_TkH(8-i,tr); - int gde_got = tr.d[0][0].abs2().gde(); - if( gde_got == curr_gde + 3 ) - { - curr_sde--; - c.push_back( i ); - c.push_back( gateLibrary::H ); - - current.mul_TkH(8-i,t); - - if( gde_got == 3 ) - t.reduce(1); - else - t.reduce(2); - - current = t; - found = true; - break; - } - } - if( !found ) return; - } - - circuit r; - slC.find(current,r); - c.push_back(r); -} diff --git a/Rotations/sqct/exactdecomposer.h b/Rotations/sqct/exactdecomposer.h deleted file mode 100644 index 80fd60f2b..000000000 --- a/Rotations/sqct/exactdecomposer.h +++ /dev/null @@ -1,49 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#ifndef EXACTDECOMPOSER_H -#define EXACTDECOMPOSER_H - -#include "matrix2x2.h" -#include "gatelibrary.h" -#include "seqlookupcliff.h" - -/// \brief Uses Algorithm 1 from http://arxiv.org/abs/1206.5236 to get circuit for exact unitary -class exactDecomposer -{ -public: - /// \brief Initializes generators - exactDecomposer(); - /// \brief Decomposes matr into circuit c - void decompose( const matrix2x2 &matr, circuit& c ); -private: - /// \brief Matrix over the ring type used during decomposition - typedef matrix2x2 M; - /// \brief Ring type used during decomposition - typedef ring_int ri; - /// \brief Number of generators used to perform decomposition - static const int gen_count = 4; - /// \brief Generators used for decomposition - M generators[gen_count]; - /// \brief Inverses of generators used for decomposition - M generators_ctr[gen_count]; - /// \brief Object of class to lookup T-optimal sequences for unitaries with \f$ sde(|\cdot|^2) < 4 \f$ - seqLookupCliff slC; -}; - -#endif // EXACTDECOMPOSER_H diff --git a/Rotations/sqct/gatelibrary.cpp b/Rotations/sqct/gatelibrary.cpp deleted file mode 100644 index 78fa3d374..000000000 --- a/Rotations/sqct/gatelibrary.cpp +++ /dev/null @@ -1,321 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#include "gatelibrary.h" -#include "output.h" - -#include - -using namespace std; - -gateLibrary::gateLibrary() : - name(GLw7 + 1), name_qc(GLw7 + 1), - matrix_str( GLw7 + 1), matrix( GLw7 + 1), - inverse(GLw7 + 1), cost( GLw7 + 1,0 ) -{ - name[Id] = "I"; - name[T] = "T"; - name[P] = "P"; - name[TP] = "tZ"; - name[Z] = "Z"; - name[TZ] = "TZ"; - name[Pd] = "p"; - name[Td] = "t"; - name[H] = "H"; - name[X] = "X"; - name[Y] = "Y"; - - name_qc[Id] = "Id 1"; - name_qc[T] = "T 1"; - name_qc[P] = "P 1"; - name_qc[TP] = "T* 1\nZ 1"; - name_qc[Z] = "Z 1"; - name_qc[TZ] = "T 1\nZ 1"; - name_qc[Pd] = "P* 1"; - name_qc[Td] = "T* 1"; - name_qc[H] = "H 1"; - name_qc[X] = "X 1"; - name_qc[Y] = "Y 1"; - - for( int i = 1; i < 8; i++ ) - { - stringstream ss; - ss << "GLw" << i ; - name_qc[(GLw1 - 1 + i)] = ss.str(); - name[(GLw1 - 1 + i)] = ss.str(); - } - - matrix_str[Id] = "Id"; - matrix_str[T] = "T"; - matrix_str[P] = "P"; - matrix_str[TP] = "Td.Z"; - matrix_str[Z] = "Z"; - matrix_str[TZ] = "T.Z"; - matrix_str[Pd] = "Pd"; - matrix_str[Td] = "Td"; - matrix_str[H] = "H"; - matrix_str[X] = "X"; - matrix_str[Y] = "Y"; - - for( int i = 1; i < 8; i++ ) - { - stringstream ss; - ss << "(omega^" << i <<"*Id)" ; - matrix_str[(GLw1 - 1 + i)] = ss.str(); - } - - matrix[Id] = m::Id(); - matrix[T] = m::T(1); - matrix[P] = m::P(); - matrix[TP] = m::T(3); - matrix[Z] = m::Z(); - matrix[TZ] = m::T(5); - matrix[Pd] = m::T(6); - matrix[Td] = m::T(7); - matrix[H] = m::H(); - matrix[X] = m::X(); - matrix[Y] = m::Y(); - - for( int i = 1; i < 8; i++ ) - matrix[(GLw1 - 1 + i)] = m::Id(i); - - inverse[Id] = Id; - inverse[T] = Td; - inverse[Td] = T; - inverse[P] = Pd; - inverse[Pd] = P; - inverse[TP] = TZ; - inverse[TZ] = TP; - - inverse[Z] = Z; - inverse[X] = X; - inverse[Y] = Y; - inverse[H] = H; - - for( int i = 0; i < 8; ++i ) - inverse[GLw1 + i ] = inverse[GLw1 + 7 - i ]; - - symbols['T'] = T; - symbols['t'] = Td; - - symbols['P'] = P; - symbols['p'] = Pd; - symbols['S'] = P; - symbols['s'] = Pd; - - symbols['Z'] = Z; - symbols['z'] = Z; - - symbols['X'] = X; - symbols['x'] = X; - - symbols['Y'] = Y; - symbols['y'] = Y; - - symbols['H'] = H; - symbols['h'] = H; - - cost[Td] = cost[T] = 1000; - cost[H] = 10; - cost[P] = cost[Pd] = 40; - cost[X] = cost[Z] = 1; - cost[Y] = 2; - cost[TP] = cost[Z] + cost[Td]; //interpret TP as Td Z - cost[TZ] = cost[T] + cost[Z]; -} - -const gateLibrary &gateLibrary::instance() -{ - static gateLibrary gl; - return gl; -} - -vector gateLibrary::toCliffordT(const vector &val) -{ - auto res = val; - res[T] += res[TZ]; - res[Z] += res[TZ]; - res[TZ] = 0; - - res[T] += res[TP]; //interpret TP as Td Z - res[Z] += res[TP]; //interpret TP as Td Z - res[TP] = 0; - - res[T] += res[Td]; - res[Td] = 0; - - res[P] += res[Pd]; - res[Pd] = 0; - - return res; -} - -void circuit::convert(circuit::m& res) const -{ - const circuit& c = *this; - static const gateLibrary& gl = gateLibrary::instance(); - res = gl.matrix[gl.Id]; - for( int i = 0; i < size(); ++i ) - { - m tmp = gl.matrix[ c[i] ] * res; - res = tmp; - //cout << res << endl; - } - res.reduce(); -} - -circuit::operator matrix2x2 () const -{ - circuit::m res; - convert(res); - return res; -} - -void circuit::toStream(ostream &out) const -{ - const circuit& c = *this; - static const gateLibrary& gl = gateLibrary::instance(); - if( size() == 0 ) - { - out << gl.name_qc[gl.Id] << endl; - return; - } - - for( int i = 0; i < size(); ++i ) - out << gl.name_qc[ c[i] ] << endl; -} - -string circuit::toString() const -{ - stringstream ss; - const circuit& c = *this; - static const gateLibrary& gl = gateLibrary::instance(); - if( size() == 0 ) - { - ss << gl.name[gl.Id] << endl; - return ss.str(); - } - - for( int i = 0; i < size(); ++i ) - ss << gl.name[ c[i] ]; - return ss.str(); -} - -void circuit::toStreamSym(ostream &out) const -{ - const circuit& c = *this; - static const gateLibrary& gl = gateLibrary::instance(); - - if( size() == 0 ) - { - out << gl.name[gl.Id] ; - return; - } - - for( int i = 0; i < size() - 1; ++i ) - out << gl.name[ c[i] ] << " "; - out << gl.name[ c.back() ]; -} - -void circuit::toMathStream(ostream &out) const -{ - const circuit& c = *this; - static const gateLibrary& gl = gateLibrary::instance(); - - if( size() == 0 ) - { - out << gl.matrix_str[gl.Id]; - return; - } - - for( int i = size() - 1; i > 0 ; --i ) - out << gl.matrix_str[ c[i] ] << "."; - out << gl.matrix_str[ c.front() ]; -} - -void circuit::push_front(const circuit &c) -{ - for( int i = c.size() - 1; i >= 0; --i ) - push_front(c[i]); -} - -void circuit::push_front(int v) -{ - std::deque::push_front(v); -} - -void circuit::push_back( int v ) -{ - std::deque::push_back(v); -} - -void circuit::push_back( const circuit& c ) -{ - for( auto i : c ) - push_back(i); -} - -vector circuit::count() -{ - static const gateLibrary& gl = gateLibrary::instance(); - vector res( gl.GLw7 + 1,0 ); - for( auto i : *this ) - res[i]++; - - return res; -} - -void circuit::fromStream(istream &in, bool reverse) -{ - static const gateLibrary& gl = gateLibrary::instance(); - while(true) - { - string line; - getline(in,line); - if( !in ) - break; - - if ( reverse ) - for( char c : line ) - { - if( gl.symbols.count(c) != 0 ) - push_front(gl.symbols.find(c)->second); - else if( c == '*' || c == 'd' ) - front() = gl.inverse[ front() ]; - } - else - for( char c : line ) - { - if( gl.symbols.count(c) != 0 ) - push_back(gl.symbols.find(c)->second); - else if( c == '*' || c == 'd' ) - back() = gl.inverse[ back() ]; - } - - } -} - -int circuit::cost() -{ - static const gateLibrary& gl = gateLibrary::instance(); - int sum = 0; - for( int i = 0; i < size(); ++i ) - sum += gl.cost[ at(i) ]; - return sum; -} - diff --git a/Rotations/sqct/gatelibrary.h b/Rotations/sqct/gatelibrary.h deleted file mode 100644 index 94fafc319..000000000 --- a/Rotations/sqct/gatelibrary.h +++ /dev/null @@ -1,122 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#ifndef GATELIBRARY_H -#define GATELIBRARY_H - -#include -#include -#include -#include -#include -#include "matrix2x2.h" - -/// \brief Contains information about gates, e.g. corresponding strings etc -class gateLibrary -{ -public: - /// \name Gate constants - /// @{ - static const int Id = 0; ///< Identity (\f$ I \f$ ) - static const int T = 1; ///< \f$T\f$ gate, corresponding unitary is \f$ \left(\begin{array}{cc} 1 & 0\\ 0 & e^{i\frac{\pi}{4}} \end{array}\right) \f$ - static const int P = 2; ///< Phase gate (\f$ P=T^2 \f$) - static const int TP = 3; ///< \f$T^3\f$ or \f$ T P \f$ - static const int Z = 4; ///< Pauli Z gate (\f$ Z=T^4 \f$) - static const int TZ = 5; ///< \f$T^5\f$ or \f$ T Z \f$ - static const int Pd = 6; ///< Inverse of Phase gate (\f$P^{\dagger}=T^6 \f$) - static const int Td = 7; ///< Inverse of T gate (\f$ T^{\dagger}=T^7 \f$) - static const int H = 9; ///< Hadamard gate, unitary is \f$ \frac{1}{\sqrt{2}}\left(\begin{array}{cc} 1 & 1\\1 & -1 \end{array}\right) \f$ - static const int X = 10; ///< Pauli X gate (\f$ HZH \f$) - static const int Y = 11; ///< Pauli Y gate (\f$ iXZ \f$) - static const int GLw1 = 12; ///< Global phase (\f$ \omega I, \omega = e^{i\frac{\pi}{4}} \f$ ) - static const int GLw2 = 13; ///< Global phase (\f$ \omega^2 I \f$ ) - static const int GLw3 = 14; ///< Global phase (\f$ \omega^3 I \f$ ) - static const int GLw4 = 15; ///< Global phase (\f$ \omega^4 I \f$ ) - static const int GLw5 = 16; ///< Global phase (\f$ \omega^5 I \f$ ) - static const int GLw6 = 17; ///< Global phase (\f$ \omega^6 I \f$ ) - static const int GLw7 = 18; ///< Global phase (\f$ \omega^7 I \f$ ) - /// @} - - /// \brief Type of matrices used to store gates - typedef matrix2x2 m; - /// \brief Gate names, name[gate_id] returns the name of the gate - std::vector name; - /// \brief Dot qc friendly names of gates - std::vector name_qc; - /// \brief Mathematica friendly names of gates - std::vector matrix_str; - /// \brief Matrices corresponding to each gate - std::vector< m > matrix; - /// \brief Map between symbols corresponding to gates and there id's - std::map symbols; - /// \brief Identifiers corresponding to inverse gates - std::vector< int > inverse; - /// \brief Cost of each gate - std::vector< int > cost; - /// \brief Fills all information about gates - gateLibrary(); - - /// \brief Instance of gate library - static const gateLibrary& instance(); - - /// \brief Converts a general cost vector to cost vector over Clifford and T library. - /// Combines cost of T and Td, P and Pd under T and P entries correspondingly. - /// \see circuit class and circuit::count() function for more details - static std::vector toCliffordT( const std::vector& val); -}; - -/// \brief Represents circuit -class circuit : public std::deque -{ -public: - /// \brief Matrix type when circuit converted to unitary - typedef matrix2x2 m; - /// \brief Conversion operator to unitary - operator matrix2x2 () const; - /// \brief Converts circuit to unitary and writes result into res - void convert( m& res ) const; - /// \brief Outputs circuit to stream in Dot QC friendly way - void toStream( std::ostream& out ) const; - /// \brief Outputs circuit to string in Scaffold friendly way - std::string toString() const; - /// \brief Outputs circuit to stream using name vector of gateLibrary - void toStreamSym( std::ostream &out) const; - /// \brief Outputs string that is product of matrices corresponding - /// to operation performed by circuit, in Mathematica format - void toMathStream( std::ostream& out ) const; - /// \brief Concatenetes circuit from the beginning - void push_front( const circuit& c ); - /// \brief Concatenetes gate from the beginning - void push_front( int gateId ); - /// \brief Concatenetes circuit from the end - void push_back( const circuit& c ); - /// \brief Concatenetes gate from the end - void push_back( int gateId); - /// \brief Returns vector with number of gates with each gateId. - /// For resulting vector \b res, the number \b res[gateId] gives a number of gates with - /// specific id in the circuit. - /// \see gateLibrary class for the list of ids - std::vector count(); - /// \brief Reads circuit from stream in line by line mode. Lines beginning with # - /// are skipped. All charachters that are not gate symbols or '*','d' are ignored. - /// If gate symbol is followed by * or d it repplaced by its inverse. - void fromStream( std::istream& in, bool reverse = false ); - /// \brief Returns total cost of the circuit defined by gateLibrary::cost vector - int cost(); -}; -#endif // GATELIBRARY_H diff --git a/Rotations/sqct/gcommdecomposer.cpp b/Rotations/sqct/gcommdecomposer.cpp deleted file mode 100644 index 3f5de510a..000000000 --- a/Rotations/sqct/gcommdecomposer.cpp +++ /dev/null @@ -1,219 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#include "gcommdecomposer.h" -#include -#include -#include -#include -#include "output.h" -#include "rint.h" -#include "vector3hpr.h" -#include "hprhelpers.h" - -using namespace std; - -/// \brief Type for high precision real numbers -typedef ring_int::mpclass mpclass; -/// \brief Type for high precision matrices -typedef matrix2x2hpr M; -/// \brief Type for high precision matrices -typedef Vector3hpr V; - -/// \brief Returns rotation by angle \f$ \theta \f$ around axis V: -/// \f$ I\cos\left(\frac{\theta}{2}\right)-i\sin\left(\frac{\theta}{2}\right)\left(n_{x}X+n_{y}Y+n_{z}Z\right) \f$, -/// where X,Y,Z -- Pauli matrices -/// \param sinTheta2 \f$ sin(\theta / 2) \f$ -M rot( const mpclass& sinTheta2, V& axis ) -{ - static const mpclass& one = hprHelpers::one(); - mpclass cosTheta2 = sqrt( one - sinTheta2 * sinTheta2 ); - return M::Id() * cosTheta2 + M::scalar(0,-sinTheta2) * ( axis.v[0] *M::X() + axis.v[1]*M::Y() + axis.v[2]*M::Z() ); -} - -/// \brief Returns group comutator of rotations around X and Y axis by angle \f$ \theta \f$ -M gc( const mpclass& sinTheta2 ) -{ - static V x(1.,0.,0.); - static V y(0.,1.,0.); - M r1 = rot(sinTheta2,x); - M r2 = rot(sinTheta2,y); - return r1 * r2 * r1.adjoint() * r2.adjoint(); -} - -/// \brief Computes rotations by angle \f$ \theta \f$ around X and Y axis conjugated by M -/// \param sinTheta2 \f$ \sin(\theta / 2 ) \f$ -void corrGC( const M& corr, mpclass sinTheta2, M &U, M &W ) -{ - static V x(1.,0.,0.); - static V y(0.,1.,0.); - M r1 = rot(sinTheta2,x); - M r2 = rot(sinTheta2,y); - U = corr * r1 * corr.adjoint(); - W = corr * r2 * corr.adjoint(); -} - -/// \brief Computes rotation axes of input unitary and stores result -struct axisAngle -{ - /// \brief Type for high precision real numbers - typedef ring_int::mpclass mpclass; - /// \brief Type for high precision matrices - typedef matrix2x2hpr M; - /// \brief Type for high precision matrices - typedef Vector3hpr V; - - /// \brief Computes rotation axes of input unitary - axisAngle( const M& U ) - { - static const mpclass& mh = hprHelpers::mhalf(); - coeffs = V( mh * ( U * M::X() ).trace().imag(), - mh * ( U * M::Y() ).trace().imag(), - mh * ( U * M::Z() ).trace().imag() ); - s = coeffs.squaredNorm(); - axis = coeffs / sqrt(s); - } - - V coeffs; ///< Coefficients of matrix decomposition into Pauli basis - mpclass s; ///< The values \f$ s = \sin( \theta / 2 )^2 \f$, where \f$ \theta \f$ rotation angle of input unitary - V axis; ///< Rotation axis corresponding to input unitary -}; - -void GC::decompose(const M &U, M &Vr, M &W) -{ - //// step by step check !!!!!!!!!!!! - static const mpclass& one = hprHelpers::one(); - static const mpclass& two = hprHelpers::two(); - static const mpclass& half = hprHelpers::half(); - - axisAngle aaU(U); - - // Here we are solving equation (10) from section 4.1 of http://arxiv.org/abs/quant-ph/0505030 - // aaU.s = sin( \theta / 2 )^2 - mpclass min_root = half * ( one - sqrt(one - aaU.s)); - - // p = sin( \phi /2 ) - mpclass p = sqrt( sqrt( min_root )); - - // Steps to find matrix S - M gcxy = gc(p); - axisAngle aaGC(gcxy); - - V cr = aaGC.axis.cross( aaU.axis ); - mpclass ip = aaGC.axis.dot( aaU.axis ); - mpclass sinTheta2 = sqrt( half *( one - ip )); - V newAxis = cr / cr.norm(); - M S = rot( sinTheta2, newAxis ); //this corresponds to S matrix after equation (11) - - corrGC( S, p, Vr, W ); // Vr = \tilde{V}, W = \tilde{W} from the paper -} - -/////////////////////////////////////////////////////////////////////// - -bool eq( double a, double b ) -{ - if( fabs( a - b ) < 1e-6 ) - return true; - return false; -} - -matrix2x2hpr Rotation::matrix() -{ - static const mpclass& pi = hprHelpers::pi(); - mpclass denh(den); - mpclass numh(num); - mpclass ang = (pi * numh) / denh; - mpclass r = mpfr::sin( ang ); - V vec( nx,ny,nz); - V vec_n = vec / vec.norm(); //normalize to reduce rounding off errors - return rot( r , vec_n ); -} - -string Rotation::symbolic() const -{ - stringstream circ_s; - char tag = isSpecial(); - if( tag != 'N' ) - { - int d = floor(den); - int n = floor(num); - if( n == 1 ) - circ_s << "Id*cos(Pi/" << d << ")-i*sin(Pi/" << d - << ")*" << tag; - else - circ_s << "Id*cos(" << n << "*Pi/" << d << ")-i*sin(" - << n << "*Pi/" << d - << ")*" << tag; - - } - else - circ_s << "Id*cos(" << num << "*Pi/" << den << ")-i*sin(" << num << "*Pi/" - << den << ")*(X*" << nx << "+Y*" << ny << "+Z*" << nz << ")"; - - return circ_s.str(); -} - -string Rotation::CSV() const -{ - stringstream circ_s; - circ_s << num << "," << den << "," << nx << "," << ny << "," << nz; - return circ_s.str(); -} - -string Rotation::Mathematica() const -{ - stringstream circ_s; - circ_s.precision(10); - circ_s.setf( ios_base::fixed ); // use fixed as mathematica does not understand scientific c++ format - circ_s << "Rot[" << num << "," << den << "," << nx << "," << ny << "," << nz << "]"; - return circ_s.str(); -} - -string Rotation::name() const -{ - stringstream circ_s; - char tag = isSpecial(); - int d = floor(den); - int n = floor(num); - if( tag != 'N' ) - circ_s << "R" << tag << n << "d" << d ; - else - circ_s << "Rot"; - return circ_s.str(); -} - - -char Rotation::isSpecial() const -{ - if( ! eq( den , floor(den) ) ) - return 'N'; - - if( ! eq( num, floor(num) ) ) - return 'N'; - - char tag = 'N'; - - if( eq(nx,1.) && eq(ny,0.) && eq(nz,0.) ) - tag = 'X'; - if( eq(nx,0.) && eq(ny,1.) && eq(nz,0.) ) - tag = 'Y'; - if( eq(nx,0.) && eq(ny,0.) && eq(nz,1.) ) - tag = 'Z'; - - return tag; -} diff --git a/Rotations/sqct/gcommdecomposer.h b/Rotations/sqct/gcommdecomposer.h deleted file mode 100644 index eeea72d27..000000000 --- a/Rotations/sqct/gcommdecomposer.h +++ /dev/null @@ -1,71 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#ifndef GCOMMDECOMPOSER_H -#define GCOMMDECOMPOSER_H - -#include "rint.h" -#include "matrix2x2.h" -#include "vector3hpr.h" - -/// \brief Represents rotation by angle \f$ \frac{num\cdot\pi}{den} \f$ -/// around axis (nx,ny,nz) -struct Rotation -{ - double num; ///< Multiple of \f$\pi\f$ in the numerator of rotation angle - double den; ///< Denominator of rotation angle - double nx; ///< x coordinate of rotation axis - double ny; ///< y coordinate of rotation axis - double nz; ///< z coordinate of rotation axis - - /// \brief High precision unitary matrix corresponding to rotation: - /// \f$ I\cos\left(\frac{num\cdot\pi}{den}\right)-i\sin\left(\frac{num\cdot\pi}{den}\right)\left(n_{x}X+n_{y}Y+n_{z}Z\right) \f$ - matrix2x2hpr matrix(); - - /// \brief Symbolic form of the matrix representing rotation - std::string symbolic() const; - /// \brief Rotation representation for CSV file - std::string CSV() const; - /// \brief Mathematica friendly representation of rotation - std::string Mathematica() const; - /// \brief File name prefix for special rotations - std::string name() const; - /// \brief Returns label X,Y,Z if rotation axis either x,y or z and angle is a rational multiplier of Pi, - /// returns 'N' otherwise. - char isSpecial() const; -}; - -/// \brief Finds balanced group commutator decomposition of a unitary. -/// Provides helper functions to compute high precision single qubit rotations -class GC -{ -public: - /// \brief Type for high precision real numbers - typedef ring_int::mpclass mpclass; - /// \brief Type for high precision matrices - typedef matrix2x2hpr M; - /// \brief Type for high precision matrices - typedef Vector3hpr V; - - /// \brief Performes balanced group commutator decomposition of U - /// \see Section 4.1 of http://arxiv.org/abs/quant-ph/0505030 - static void decompose( const M& U, M& Vr, M& W); - -}; - -#endif // GCOMMDECOMPOSER_H diff --git a/Rotations/sqct/hoptimalitytest.cpp b/Rotations/sqct/hoptimalitytest.cpp deleted file mode 100644 index af3829062..000000000 --- a/Rotations/sqct/hoptimalitytest.cpp +++ /dev/null @@ -1,100 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#include "hoptimalitytest.h" -#include "output.h" -#include "exactdecomposer.h" -#include "numbers-stat.h" - -#include -#include -using namespace std; - - -static void print_list( std::vector& a, std::vector& b, std::vector& c) -{ - cout << "sde(|.|^2) total min-H max-H" << endl; - cout << " gates gates" << endl; - - for( int i = 0; i < a.size(); ++i ) - if( a[i] != 0 ) - cout << setw (10) << i << ":" << - setw (7) << a[i] << " " << - setw (7) << b[i] << " " << - setw (7) << c[i] << endl; -} - -hoptimalitytest::hoptimalitytest() -{ - init(); -} - -//assumes that initial node is identity matrix -static void getCircuit( circuit& res, const optNode* node, const vector& genIdToGateId ) -{ - const optNode* current = node; - while( current->parent != 0 ) - { - res.push_front( genIdToGateId[current->gen_id] ); - current = current->parent; - } -} - -void hoptimalitytest::init() -{ - const bool verbose = true; - - static gateLibrary gl; - typedef matrix2x2 m; - ogc.m_generators = { m::X(), m::Y(), m::Z(), m::T(), m::T().conjugateTranspose(), m::P(), m::P().conjugateTranspose() }; - vector genIdToGateId = { gl.X, gl.Y, gl.Z, gl.T, gl.Td, gl.P, gl.Pd }; - ogc.m_cost = { 1,2,1,40,40,10,10 }; - ogc.m_initial = { m::Id() }; - vector initialGates = { gl.Id }; - ogc.m_initial_cost = {0}; - ogc.generate(); - - //produce couning bounds - typedef columnsCounter<8> cC; - unique_ptr cp( new cC ); - cp->generate_all_numbers(); - cp->count_all_columns(); - - //setup bounds - for( int i = 0 ; i < cp->sde_stat.size() ; ++i ) - og.m_sde_required.at(i) = cp->sde_stat[i]; - - m_clifford.resize( ogc.unique_elements().size() ); - auto k = m_clifford.begin(); - - for( auto i : ogc.unique_elements() ) - { - getCircuit(*k,i.get(),genIdToGateId); - if( verbose ) { k->toStreamSym(cout); cout << "," << endl; } - - og.m_generators.push_back( i->unitary * m::H() ); - og.m_cost.push_back( 1 ); - og.m_initial.push_back( i->unitary ); - ++k; - } - - og.m_initial_cost.resize( og.m_initial.size(), 0 ); - og.generate(); - if( verbose ) print_list( og.m_sde_found, og.m_min_cost, og.m_max_cost ); -} - diff --git a/Rotations/sqct/hoptimalitytest.h b/Rotations/sqct/hoptimalitytest.h deleted file mode 100644 index fba4d5ca0..000000000 --- a/Rotations/sqct/hoptimalitytest.h +++ /dev/null @@ -1,45 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#ifndef HOPTIMALITYTEST_H -#define HOPTIMALITYTEST_H - -#include "optsequencegenerator.h" -#include "gatelibrary.h" - -/// \brief Performs brute force check required for proof of -/// Appendix 2, http://arxiv.org/abs/1206.5236 -/// Shows connection between optimal number of H gates and sde -/// when using (X,Y,Z,T,P) + H library -class hoptimalitytest -{ -public: - /// \brief Initialized by call of init() - hoptimalitytest(); - /// \brief Prints minimal and maximal number of H gates in optimal circuit per sde - void init(); -private: - /// \brief Optimal sequence generator used to get short circuits for Clifford group unitaries - optSequenceGenerator ogc; - /// \brief Optimal sequence generator used to get T-optimal circuits - optSequenceGeneratorSdeLim og; - /// \brief Circuits for Clifford group unitaries - std::vector< circuit > m_clifford; -}; - -#endif // HOPTIMALITYTEST_H diff --git a/Rotations/sqct/hprhelpers.cpp b/Rotations/sqct/hprhelpers.cpp deleted file mode 100644 index d449f73d2..000000000 --- a/Rotations/sqct/hprhelpers.cpp +++ /dev/null @@ -1,94 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#define MPFR_REAL_DATA_PUBLIC -#include "hprhelpers.h" - -void hprHelpers::convert(const hprHelpers::hpr_complex &in, std::complex &out) -{ - out = std::complex( mpfr_get_d( in.real()._x , MPFR_RNDN) , mpfr_get_d( in.imag()._x , MPFR_RNDN) ); -} - -void hprHelpers::convert(const hprHelpers::hpr_real &from, double &to) -{ - to = mpfr_get_d( from._x , MPFR_RNDN); -} - -double hprHelpers::toMachine(const hprHelpers::hpr_real &from) -{ - return mpfr_get_d( from._x , MPFR_RNDN); -} - -std::complex hprHelpers::toMachine(const hprHelpers::hpr_complex &in) -{ - return std::complex( mpfr_get_d( in.real()._x , MPFR_RNDN) , mpfr_get_d( in.imag()._x , MPFR_RNDN) ); -} - -/// \brief Holds string for Pi computed with high precision -struct piData -{ - hprHelpers::hpr_real pi;///< Pi - piData() - { - pi = std::string( "3.14159265358979323846264338327950288419716939937510582097494459230781640628620899862803482534211706798" - "2148086513282306647093844609550582231725359408128481117450284102701938521105559644622948954930381964428810975665933446128475648233786" - "78316527120190914564856692346034861045432664821339360726024914127372458700660631558817488152092096282925409171536436789259036001133053054882" - "04665213841469519415116094330572703657595919530921861173819326117931051185480744623799627495673518857527248912279381830119491298336733" - "62440656643086021394946395224737190702179860943702770539217176293176752384674818467669405132000568127145263560827785771342757789609173637" - "1787214684409012249534301465495853710507922796892589235420199561121290219608640344181598136297747713099605187072113499999983729780499510597317" - "328160963185950244594553469083026425223082533446850352619311881710100031378387528865875332083" - "8142061717766914730359825349042875546873115956286388235378759375195778185778053217122680661300192787661119590921642" - "0198938095257201065485863279" ); - } -}; - -const hprHelpers::hpr_real &hprHelpers::pi() -{ - static piData d; - return d.pi; -} - -const hprHelpers::hpr_real &hprHelpers::one() -{ - static hpr_real m_one(1.0); - return m_one; -} - -const hprHelpers::hpr_real &hprHelpers::two() -{ - static hpr_real m_two(2.0); - return m_two; -} - -const hprHelpers::hpr_real &hprHelpers::half() -{ - static hpr_real m_half( one() / two() ); - return m_half; -} - -const hprHelpers::hpr_real &hprHelpers::mhalf() -{ - static hpr_real m_mhalf( - one() / two() ); - return m_mhalf; -} - -const hprHelpers::hpr_real &hprHelpers::sqrt2ov2() -{ - static hpr_real m_s( sqrt(two()) / two() ); - return m_s; -} diff --git a/Rotations/sqct/hprhelpers.h b/Rotations/sqct/hprhelpers.h deleted file mode 100644 index 22db9337e..000000000 --- a/Rotations/sqct/hprhelpers.h +++ /dev/null @@ -1,56 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#ifndef HPRHELPERS_H -#define HPRHELPERS_H - -#include "real.hpp" -#include - -/// \brief Helper functions and data for high precision arithmetic -class hprHelpers -{ -public: - /// \brief High precision real type used in the project - typedef mpfr::real<4096> hpr_real; - /// \brief High precision complex type used in the project - typedef std::complex hpr_complex; - /// \brief Transforms high precision complex number into machine complex - static void convert( const hpr_complex& from, std::complex& to ); - /// \brief Transforms high precision real number into double - static void convert( const hpr_real& from, double& to ); - /// \brief Transforms high precision real number into double - static double toMachine( const hpr_real& from ); - /// \brief Transforms high precision complex number into machine complex - static std::complex toMachine( const hpr_complex& from ); - - /// \brief High precision \f$ \pi \f$ - static const hpr_real& pi(); - /// \brief High precision one - static const hpr_real& one(); - /// \brief High precision one - static const hpr_real& two(); - /// \brief High precision 1/2 - static const hpr_real& half(); - /// \brief High precision -1/2 - static const hpr_real& mhalf(); - /// \brief High precision \f$ \frac{\sqrt{2}}{2} \f$ - static const hpr_real& sqrt2ov2(); -}; - -#endif // HPRHELPERS_H diff --git a/Rotations/sqct/main.cpp b/Rotations/sqct/main.cpp deleted file mode 100644 index 401cac101..000000000 --- a/Rotations/sqct/main.cpp +++ /dev/null @@ -1,803 +0,0 @@ -// Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com, Dmitri Maslov, Michele Mosca -// -// This file is part of SQCT. -// -// SQCT is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// SQCT 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 Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with SQCT. If not, see . -// - -#include "sk.h" -#include "exactdecomposer.h" -#include "gcommdecomposer.h" - -#include "theoremverification.h" -#include "toptimalitytest.h" -#include "hoptimalitytest.h" - -#include "netgenerator.h" - -#include "output.h" - -#include -#include -#include - -#include -#include -#include - -// command line parcing code based on http://www.boost.org/doc/libs/1_49_0/doc/html/program_options/tutorial.html#id2499896 -// and BOOST_ROOT/libs/program_options/example/first.cpp -namespace po = boost::program_options; -namespace btm = boost::timer; - -using namespace std; - -////////////////////////////////////////////////////////////////////////////// - -/// \brief Option of SK execution -struct SKOptions -{ - SKOptions() : - math_fr( false ), write_dot_qc(false), angle(false) {}; - - string in_filename; ///< input filename - string out_filename; ///< output statistics filename - bool math_fr; ///< should output be mathematica friendly - int iterations_default; ///< number of SK iterations to perform by default - bool write_dot_qc;///< should we output dot qc or not - string out_dir;///< path where we should output dotqc files - bool angle;///< how we interpret first element \b val of each input line ( Pi/\b val or just \b val) - int max_sde;///< maximal value of sde to use during basic approximation step -}; - -////////////////////////////////////////////////////////////////////////////// - -/// \brief Result of application of the SK algorithm -struct ApplicationResult -{ - circuit c; ///< Circuit - int hc; ///< Hadamard counts - int tc; ///< T and inverse of T gates counts - int pc; ///< Phase and inverse of Phase gate counts - int plc; ///< Pauli matrices counts - int total; ///< Total cost using cost function defined by vector gateLibrary::cost - double dst; ///< Trace distance to approximation - double tappr; ///< Time required to do an approximation - double tdecomp; ///< Time required to do a decomposition - int nr; ///< Number of iterations performed - int denom_reduction; ///< Difference between \f$ sde(|\cdot|^2) \f$ - /// before and after conversion to canonical form - int denom ; ///< \f$ sde(|\cdot|^2) \f$ of resulting unitary - matrix2x2 exact_uni; /// exact unitary corresponding to the circuit c - - - /// \brief Summarize gate statistics for Clifford + T library - void updateForCliffordT() - { - typedef gateLibrary gl; - total = c.cost(); - auto counts = gl::toCliffordT( c.count() ); - hc = counts[ gl::H ]; - tc = counts[ gl::T ]; - pc = counts[ gl::P ]; - plc = counts[ gl::Z ] + counts[ gl::X ] + counts[ gl::Y ]; - } - - /// \brief Outputs results in CSV format - void toCSVStream( std::ostream& out ) const - { - out.precision(5); - out.setf( ios_base::scientific ); - out << nr << "," - << tc << "," - << hc << "," - << pc << "," - << plc << "," - << dst << "," - << tappr << "," - << tdecomp << "," << denom_reduction << "," << denom ; - } - - /// \brief Outputs results in Mathematica friendly format - void toMathematicaStream( std::ostream& out ) const - { - out.precision(10); - out.setf( ios_base::fixed ); // use fixed as mathematica does not understand scientific c++ format - out << "AppResult[" - << nr << "," - << tc << "," - << hc << "," - << pc << "," - << plc << ","; - out.precision(60); - out << dst << "," ; - out.precision(10); - out << tappr << "," - << tdecomp << "," << denom_reduction << "," << denom << "]"; - } - - /// \brief Outputs dot qc file with circuit and adds information about genration process into comments - void generateDotQc( std::string filename, std::string circuit_name, std::string symbolic_form ) - { - ofstream ofs(filename.c_str()); - if( !ofs ) - { - cout << "Unable to open file:" << filename << " for output" <> val >> r.nx >> r.ny >> r.nz >> iter; - if( ! opt.angle ) - { - r.num = 1.0; - r.den = val; - } - else - { - r.num = val; - r.den = TwoPi; - } - - calculate( r.matrix() , iter, ar ); - - stringstream fname; - fname << opt.out_dir << "/"; - if( r.isSpecial() != 'N' ) - fname << r.name() << "-" << iter; - else - fname << opt.out_filename << "." << line_number; - fname << ".qc" ; - - if( opt.write_dot_qc ) - ar.generateDotQc( fname.str() , - r.name(), - r.symbolic() ); - - if( opt.math_fr ) - { - ofs << "{" << r.Mathematica() << ","; - ar.toMathematicaStream(ofs); - ofs << "}" << endl; - } - else - { - ofs << r.CSV() << ","; - ar.toCSVStream(ofs); - ofs << endl; - } - - line_number++; - } - } -private: - const SKOptions& opt; - sk skd; - exactDecomposer ed; -}; - -/////////////////////////////////////////////////////////////////// - -bool print_help( const string& topic ) -{ - map hi; - hi["in"] = "Each line of input file must have the followoing form:\n" - "val,nx,ny,nz,[iter]\n" - "val -- interpreted depending on the value of option --angle\n" - " if --angle is specified then val interpreted as rotation\n" - " angle phi. Otherwise rotation angle phi = 2 Pi / val.\n" - "nx -- projection of rotation axis on, x\n" - "ny -- projection of rotation axis on, y\n" - "nz -- projection of rotation axis on, z\n" - "iter -- optional parameter defining number of iterations used for approximation.\n" - "The matrix that will be approximated is I*cos(phi/2) - \n" - "i sin(phi/2) (nx * X + ny * Y + nz * Z). If the number of iterations is not specified,\n" - "the default values is used. It can be set using --iterations option.\n" - "\n" - "Default output format is CSV and each line of it contains the following:\n" - "num,den,nx,ny,nz,N,Tc,Hc,Pc,Plc,dst,tappr,tdecomp,denom_red,denom \n" - "[num,den,nx,ny,nz] determines input rotation with phi = num * 2Pi / den\n" - "N -- number of iterations of SK algorithm used" - "Tc-- number of T gates in the resulting circuit\n" - "Hc-- number of Hadamard gates in the circuit\n" - "Pc-- number of Phase gates in the circuit\n" - "Plc-- number of Pauli gates in the circuit\n" - "dst-- distance to approximation, see \n" - "(Formula (1) in http://arxiv.org/abs/quant-ph/0411206)\n" - "tappr-- time required for approximation (seconds) \n" - "tdecomp-- time required for exact decomposition (seconds)\n" - "tdecomp-- time required for exact decomposition (seconds)\n" - "denom_red -- change of the power of sqrt(2) in the denominator\n" - "after conversion to canonical form.\n" - "denom -- power of sqrt(2) in the denominator of the exact unitary in\n" - "the canonical form. In the case of Mathematica output numbers are \n" - "decorated with Rot and AppResult list headers.\n"; - if( hi.count(topic) ) - { - cout << hi[topic] << endl; - return true; - } - - return false; -} - -///////////////////////////////////////////////////////////////////// - -struct ResynthOptions -{ - ResynthOptions() : - reverse(false) - {} - vector circuit_files; - bool reverse; - bool math_fr; -}; - -//////////////////////////////////////////////////////////////////// - -/// \brief Resyntheisizes circuits using exact decomposition algoritm -struct ResynthApplication -{ - ResynthApplication( const ResynthOptions& opt ) : - ro(opt) - {} - - void process() - { - for( const auto& fn : ro.circuit_files ) - process(fn); - } - - void process( const string& filename ) - { - const gateLibrary& gl = gateLibrary::instance(); - ifstream ifs(filename.c_str()); - ofstream ofs( (filename + ".out").c_str() ); - // read circuit first - circuit in, out; - in.fromStream(ifs,ro.reverse); - ed.decompose(in,out); - - auto in_cost = in.count(); - int in_total = in.cost(); - in_cost = gl.toCliffordT(in_cost); - - auto out_cost = out.count(); - int out_total = out.cost(); - out_cost = gl.toCliffordT(out_cost); - - string cb = "# "; - string ce = ""; - if( ro.math_fr ) - cb = "(* ",ce = " *)"; - - ofs << cb << "Computed by SQCT, based on arXiv:1206.5236" << ce << endl; - ofs << cb << "Software published at: http://code.google.com/p/sqct/"<< ce << endl; - ofs << cb << "Gate counts for input circuit [T+Td,H,P+Pd,X,Z,Y] : [" - << in_cost[gl.T] << "," << in_cost[gl.H] << "," - << in_cost[gl.P] << "," << in_cost[gl.X] << "," - << in_cost[gl.Z] << "," << in_cost[gl.Y] << "]" << ce << endl; - ofs << cb << "Total cost of input:" << in_total << ce << endl; - - ofs << cb << "Gate counts for output circuit [T+Td,H,P+Pd,X,Z,Y] : [" - << out_cost[gl.T] << "," << out_cost[gl.H] << "," - << out_cost[gl.P] << "," << out_cost[gl.X] << "," - << out_cost[gl.Z] << "," << out_cost[gl.Y] << "]" << ce << endl; - ofs << cb << "Total cost of output:" << out_total << ce << endl; - - if( ro.math_fr ) - out.toMathStream(ofs); - else - out.toStreamSym(ofs); - - ofs.close(); - ifs.close(); - } - - exactDecomposer ed; - const ResynthOptions& ro; -}; - -//////////////////////////////////////////////////////////////////// - -/// \brief Options for epsilon net generation -struct enetOptions -{ - /// \brief If one element specified -- upper bound for sde of epsilon net to be - /// generated. If two elements specified -- interval of sde to be generated. - vector epsilon_net_layers; -}; - -//////////////////////////////////////////////////////////////////// - -struct enetApplication -{ - enetApplication( const enetOptions& options ) : - m_options(options) - {} - - /// \brief Checks if all layers generated on initial state are available - void check_initial() - { - initial_ok = true; - if( m_layers[0] == 0 ) - initial_ok = false; - - for( int i = 2; (i < initial_end) && initial_ok ; ++i ) - if( m_layers[i] == 0 ) initial_ok = false; - } - - /// \brief Collects information about parts of epsilon net available - void check_files() - { - m_layers.resize(100,0); - // collect information about available layers - for( int i = 0; i < 100; ++i ) - { - string name = netGenerator::fileName(i); - ifstream ifs(name); - if( !ifs ) - m_layers[i] = 0; - else - m_layers[i] = 1; - } - } - - /// \brief Generates all layers with \f$ sde(|\cdot|^2) \f$ in the interval [st,end) - void generate( int st, int end ) - { - if( ! initial_ok && st < initial_end ) - m_ng.generateInitial(); - - for( int i = max(initial_end,st) ; i < end; ++i ) - { - if( m_layers[i] == 0 ) - { - epsilonnet base_net; - base_net.loadFromFile( netGenerator::fileName(i-1).c_str() ); - unique_ptr res( netGenerator::generate( base_net ) ); - res->saveToFile( netGenerator::fileName(i).c_str() ); - } - } - } - - /// \brief Do the work - void process() - { - check_files(); - check_initial(); - - int sz = m_options.epsilon_net_layers.size(); - int b = m_options.epsilon_net_layers[0]; - switch( sz ) - { - case 1: - generate(0,b + 1); - break; - case 2: - generate(b,m_options.epsilon_net_layers[1] + 1); - break; - default: - std::cerr << "Wrong number of parameters. See help." << endl; - } - } - - void print_error_message() - { - cout << "Epsilon net files a not available, use --epsilon-net option" << endl - << "to generate them." << endl; - } - - bool check() - { - int st = 0; - int end = m_options.epsilon_net_layers[0] + 1; - check_files(); - check_initial(); - - if( ! initial_ok && st < initial_end ) - { - print_error_message(); - return false; - } - - for( int i = max(initial_end,st) ; i < end; ++i ) - { - if( m_layers[i] == 0 ) - { - print_error_message(); - return false; - } - } - return true; - } - - const enetOptions& m_options; ///< Application options - std::vector m_layers; ///< Ones for available layers, zeros for not availible layers - static const int initial_end; ///< Maximal layer generated on initial state - bool initial_ok; ///< If all initial layers are availible - netGenerator m_ng; ///< Epsilon net generator -}; - -const int enetApplication::initial_end = 21; - -//////////////////////////////////////////////////////////////////// - -struct RandomRotationsOpts -{ - string filename; - int samples; -}; - -//////////////////////////////////////////////////////////////////// - -struct RotationGeneratorApp -{ - RotationGeneratorApp( RandomRotationsOpts& opts) : - m_opt(opts) - {} - /// \brief Generates file with rotations by random angle around random axis - void process() - { - ofstream ofs( m_opt.filename.c_str() ); - unsigned seed = std::chrono::system_clock::now().time_since_epoch().count(); - std::default_random_engine generator (seed); - static const double PI = 3.1415926535897932384626433832795028841971693993751; - normal_distribution nd(0.0,1.0); - uniform_real_distribution urd( 0.0, 2*PI ); - - for( int i = 0; i < m_opt.samples; ++i ) - { - double x = nd(generator); - double y = nd(generator); - double z = nd(generator); - double norm = sqrt(x*x + y*y + z*z); - x /= norm; - y /= norm; - z /= norm; - double phi = urd(generator); - ofs << phi << " " << x << " " << y << " " << z << endl; - } - } - - const RandomRotationsOpts& m_opt; -}; - -//////////////////////////////////////////////////////////////////// -struct exactDecompositionOpts -{ - std::string filename; -}; - -//////////////////////////////////////////////////////////////////// -struct exactDecompositionApplication -{ - exactDecompositionApplication( const exactDecompositionOpts& opts ) : - m_opts(opts) - { - } - - void run() - { - ifstream ifs; - ifs.exceptions(std::fstream::badbit | std::fstream::failbit); - ifs.open(m_opts.filename); - matrix2x2 exact_uni; - circuit c; - ifs >> exact_uni; - cout << exact_uni << endl; - ed.decompose(exact_uni,c); - c.toStream(cout); - } - - exactDecompositionOpts m_opts; - exactDecomposer ed; -}; - -//////////////////////////////////////////////////////////////////// - -void print_about_message() -{ -cout << "Copyright (c) 2012 Vadym Kliuchnikov sqct(dot)software(at)gmail(dot)com" << endl << endl; -cout << "SQCT is free software: you can redistribute it and/or modify" << endl; -cout << "it under the terms of the GNU Lesser General Public License as published by" << endl; -cout << "the Free Software Foundation, either version 3 of the License, or" << endl; -cout << "(at your option) any later version." << endl; -cout << "" << endl; -cout << "SQCT is distributed in the hope that it will be useful," << endl; -cout << "but WITHOUT ANY WARRANTY; without even the implied warranty of" << endl; -cout << "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the" << endl; -cout << "GNU Lesser General Public License for more details." << endl; -cout << "" << endl; -cout << "You should have received a copy of the GNU Lesser General Public License" << endl; -cout << "along with SQCT. If not, see ." << endl; -cout << "" << endl; -cout << "The program code based on results of http://arxiv.org/abs/1206.5236." << endl; -cout << "It also implements the version of Solovay Kitaev algorithm described" << endl; -cout << "in http://arxiv.org/abs/quant-ph/0505030. " << endl; -cout << "" << endl; -cout << "The list of used libraries, corresponding licenses and authors:" << endl<< endl; -cout << "Boost | Boost Software License" << endl<< endl; -cout << "The GNU Multiple Precision Arithmetic Library | GNU Lesser General Public License v3" << endl; -cout << "(by Free Software Foundation, Inc.)" << endl<< endl; -cout << "The GNU MPFR Library the library | GNU Lesser General Public License v3" << endl; -cout << "(by Free Software Foundation, Inc.," << endl; -cout << " Contributed by the AriC and Caramel projects, INRIA. )" << endl << endl; -cout << "mpfr::real | GNU Lesser General Public License v3" << endl; -cout << "(by Christian Schneider )" << endl; -cout << "" << endl; -cout << "Source code of this program can be obtained from: " << endl; -} - -//////////////////////////////////////////////////////////////////// - -int main(int ac, char* av[]) -{ - // help - string help_topic = ""; - // sk application parameters - SKOptions sko; - // epsilon net generation - enetOptions eopt; - // resynthesise - ResynthOptions ro; - // randomized rotations - RandomRotationsOpts rro; - // exact decomposition - exactDecompositionOpts edo; - - try { - - po::options_description desc("Allowed options"); - desc.add_options() - - ("help,H", po::value< string >(&help_topic)->implicit_value(""), - "Produce help message, see help