finitary-derive 2.2.0.0 → 2.2.0.1
raw patch · 12 files changed
+2337/−2336 lines, 12 filesdep ~basedep ~binarydep ~bitvecsetup-changednew-uploaderPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: base, binary, bitvec, finitary, ghc-typelits-extra
API changes (from Hackage documentation)
Files
- CHANGELOG.md +39/−35
- LICENSE.md +675/−675
- README.md +141/−140
- Setup.hs +3/−3
- finitary-derive.cabal +68/−66
- src/Data/Finitary/Finiteness.hs +144/−145
- src/Data/Finitary/PackBits.hs +240/−241
- src/Data/Finitary/PackBits/Unsafe.hs +250/−251
- src/Data/Finitary/PackBytes.hs +232/−233
- src/Data/Finitary/PackInto.hs +196/−197
- src/Data/Finitary/PackWords.hs +243/−244
- test/Main.hs +106/−106
CHANGELOG.md view
@@ -1,35 +1,39 @@-# Revision history for finitary-derive--## 2.2.0.0 -- 2019-11-27--* Fix definition of ``Packed`` for ``PackInto`` to actually agree with the- documentation.--## 2.1.0.0 -- 2019-11-24--* Fix bug in ``Ord`` instances for the ``Pack*`` types.-* Fix definition of ``Packed`` pattern to actually agree with the documentation.-* Define a ``newtype`` wrapper for better provision of ``Binary`` and- ``Hashable`` instances for ``Vector``s of ``PackBits`` types.-* Remove ``Hashable`` and ``Binary`` instances for ``PackBits`` (both- varieties).-* Fix documentation typoes.--## 2.0.0.0 -- 2019-11-23--* Remove ``Data.Finitary.Pack``.-* Add ``Data.Finitary.PackBits``, ``Data.Finitary.PackWords``,- ``Data.Finitary.PackBytes``, ``Data.Finitary.PackBits.Unsafe`` and- ``Data.Finitary.PackInto``-* Refactor 'packing-agnostic' functionality into ``Data.Finitary.Finiteness``.-* A lot of documentation changes.--## 1.0.0.1 -- 2019-09-21--* Fix documentation.-* Raise bounds on ``finitary`` to avoid critical bugs.-* Raise bounds on ``base`` for test (for honesty reasons).--## 1.0.0.0 -- 2019-09-17--* First version. Released on an unsuspecting world.+# Revision history for finitary-derive + +## 2.2.0.1 -- 2021-02-09 + +* Update bounds for compatibility with GHC 9.0 + +## 2.2.0.0 -- 2019-11-27 + +* Fix definition of ``Packed`` for ``PackInto`` to actually agree with the + documentation. + +## 2.1.0.0 -- 2019-11-24 + +* Fix bug in ``Ord`` instances for the ``Pack*`` types. +* Fix definition of ``Packed`` pattern to actually agree with the documentation. +* Define a ``newtype`` wrapper for better provision of ``Binary`` and + ``Hashable`` instances for ``Vector``s of ``PackBits`` types. +* Remove ``Hashable`` and ``Binary`` instances for ``PackBits`` (both + varieties). +* Fix documentation typoes. + +## 2.0.0.0 -- 2019-11-23 + +* Remove ``Data.Finitary.Pack``. +* Add ``Data.Finitary.PackBits``, ``Data.Finitary.PackWords``, + ``Data.Finitary.PackBytes``, ``Data.Finitary.PackBits.Unsafe`` and + ``Data.Finitary.PackInto`` +* Refactor 'packing-agnostic' functionality into ``Data.Finitary.Finiteness``. +* A lot of documentation changes. + +## 1.0.0.1 -- 2019-09-21 + +* Fix documentation. +* Raise bounds on ``finitary`` to avoid critical bugs. +* Raise bounds on ``base`` for test (for honesty reasons). + +## 1.0.0.0 -- 2019-09-17 + +* First version. Released on an unsuspecting world.
LICENSE.md view
@@ -1,675 +1,675 @@-### GNU GENERAL PUBLIC LICENSE--Version 3, 29 June 2007--Copyright (C) 2007 Free Software Foundation, Inc.-<https://fsf.org/>--Everyone is permitted to copy and distribute verbatim copies of this-license document, but changing it is not allowed.--### Preamble--The GNU General Public License is a free, copyleft license for-software and other kinds of works.--The licenses for most software and other practical works are designed-to take away your freedom to share and change the works. By contrast,-the GNU General Public License is intended to guarantee your freedom-to share and change all versions of a program--to make sure it remains-free software for all its users. We, the Free Software Foundation, use-the GNU General Public License for most of our software; it applies-also to any other work released this way by its authors. You can apply-it to your programs, too.--When we speak of free software, we are referring to freedom, not-price. Our General Public Licenses are designed to make sure that you-have the freedom to distribute copies of free software (and charge for-them if you wish), that you receive source code or can get it if you-want it, that you can change the software or use pieces of it in new-free programs, and that you know you can do these things.--To protect your rights, we need to prevent others from denying you-these rights or asking you to surrender the rights. Therefore, you-have certain responsibilities if you distribute copies of the-software, or if you modify it: responsibilities to respect the freedom-of others.--For example, if you distribute copies of such a program, whether-gratis or for a fee, you must pass on to the recipients the same-freedoms that you received. You must make sure that they, too, receive-or can get the source code. And you must show them these terms so they-know their rights.--Developers that use the GNU GPL protect your rights with two steps:-(1) assert copyright on the software, and (2) offer you this License-giving you legal permission to copy, distribute and/or modify it.--For the developers' and authors' protection, the GPL clearly explains-that there is no warranty for this free software. For both users' and-authors' sake, the GPL requires that modified versions be marked as-changed, so that their problems will not be attributed erroneously to-authors of previous versions.--Some devices are designed to deny users access to install or run-modified versions of the software inside them, although the-manufacturer can do so. This is fundamentally incompatible with the-aim of protecting users' freedom to change the software. The-systematic pattern of such abuse occurs in the area of products for-individuals to use, which is precisely where it is most unacceptable.-Therefore, we have designed this version of the GPL to prohibit the-practice for those products. If such problems arise substantially in-other domains, we stand ready to extend this provision to those-domains in future versions of the GPL, as needed to protect the-freedom of users.--Finally, every program is threatened constantly by software patents.-States should not allow patents to restrict development and use of-software on general-purpose computers, but in those that do, we wish-to avoid the special danger that patents applied to a free program-could make it effectively proprietary. To prevent this, the GPL-assures that patents cannot be used to render the program non-free.--The precise terms and conditions for copying, distribution and-modification follow.--### TERMS AND CONDITIONS--#### 0. Definitions.--"This License" refers to version 3 of the GNU General Public License.--"Copyright" also means copyright-like laws that apply to other kinds-of works, such as semiconductor masks.--"The Program" refers to any copyrightable work licensed under this-License. Each licensee is addressed as "you". "Licensees" and-"recipients" may be individuals or organizations.--To "modify" a work means to copy from or adapt all or part of the work-in a fashion requiring copyright permission, other than the making of-an exact copy. The resulting work is called a "modified version" of-the earlier work or a work "based on" the earlier work.--A "covered work" means either the unmodified Program or a work based-on the Program.--To "propagate" a work means to do anything with it that, without-permission, would make you directly or secondarily liable for-infringement under applicable copyright law, except executing it on a-computer or modifying a private copy. Propagation includes copying,-distribution (with or without modification), making available to the-public, and in some countries other activities as well.--To "convey" a work means any kind of propagation that enables other-parties to make or receive copies. Mere interaction with a user-through a computer network, with no transfer of a copy, is not-conveying.--An interactive user interface displays "Appropriate Legal Notices" to-the extent that it includes a convenient and prominently visible-feature that (1) displays an appropriate copyright notice, and (2)-tells the user that there is no warranty for the work (except to the-extent that warranties are provided), that licensees may convey the-work under this License, and how to view a copy of this License. If-the interface presents a list of user commands or options, such as a-menu, a prominent item in the list meets this criterion.--#### 1. Source Code.--The "source code" for a work means the preferred form of the work for-making modifications to it. "Object code" means any non-source form of-a work.--A "Standard Interface" means an interface that either is an official-standard defined by a recognized standards body, or, in the case of-interfaces specified for a particular programming language, one that-is widely used among developers working in that language.--The "System Libraries" of an executable work include anything, other-than the work as a whole, that (a) is included in the normal form of-packaging a Major Component, but which is not part of that Major-Component, and (b) serves only to enable use of the work with that-Major Component, or to implement a Standard Interface for which an-implementation is available to the public in source code form. A-"Major Component", in this context, means a major essential component-(kernel, window system, and so on) of the specific operating system-(if any) on which the executable work runs, or a compiler used to-produce the work, or an object code interpreter used to run it.--The "Corresponding Source" for a work in object code form means all-the source code needed to generate, install, and (for an executable-work) run the object code and to modify the work, including scripts to-control those activities. However, it does not include the work's-System Libraries, or general-purpose tools or generally available free-programs which are used unmodified in performing those activities but-which are not part of the work. For example, Corresponding Source-includes interface definition files associated with source files for-the work, and the source code for shared libraries and dynamically-linked subprograms that the work is specifically designed to require,-such as by intimate data communication or control flow between those-subprograms and other parts of the work.--The Corresponding Source need not include anything that users can-regenerate automatically from other parts of the Corresponding Source.--The Corresponding Source for a work in source code form is that same-work.--#### 2. Basic Permissions.--All rights granted under this License are granted for the term of-copyright on the Program, and are irrevocable provided the stated-conditions are met. This License explicitly affirms your unlimited-permission to run the unmodified Program. The output from running a-covered work is covered by this License only if the output, given its-content, constitutes a covered work. This License acknowledges your-rights of fair use or other equivalent, as provided by copyright law.--You may make, run and propagate covered works that you do not convey,-without conditions so long as your license otherwise remains in force.-You may convey covered works to others for the sole purpose of having-them make modifications exclusively for you, or provide you with-facilities for running those works, provided that you comply with the-terms of this License in conveying all material for which you do not-control copyright. Those thus making or running the covered works for-you must do so exclusively on your behalf, under your direction and-control, on terms that prohibit them from making any copies of your-copyrighted material outside their relationship with you.--Conveying under any other circumstances is permitted solely under the-conditions stated below. Sublicensing is not allowed; section 10 makes-it unnecessary.--#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.--No covered work shall be deemed part of an effective technological-measure under any applicable law fulfilling obligations under article-11 of the WIPO copyright treaty adopted on 20 December 1996, or-similar laws prohibiting or restricting circumvention of such-measures.--When you convey a covered work, you waive any legal power to forbid-circumvention of technological measures to the extent such-circumvention is effected by exercising rights under this License with-respect to the covered work, and you disclaim any intention to limit-operation or modification of the work as a means of enforcing, against-the work's users, your or third parties' legal rights to forbid-circumvention of technological measures.--#### 4. Conveying Verbatim Copies.--You may convey verbatim copies of the Program's source code as you-receive it, in any medium, provided that you conspicuously and-appropriately publish on each copy an appropriate copyright notice;-keep intact all notices stating that this License and any-non-permissive terms added in accord with section 7 apply to the code;-keep intact all notices of the absence of any warranty; and give all-recipients a copy of this License along with the Program.--You may charge any price or no price for each copy that you convey,-and you may offer support or warranty protection for a fee.--#### 5. Conveying Modified Source Versions.--You may convey a work based on the Program, or the modifications to-produce it from the Program, in the form of source code under the-terms of section 4, provided that you also meet all of these-conditions:--- a) The work must carry prominent notices stating that you modified- it, and giving a relevant date.-- b) The work must carry prominent notices stating that it is- released under this License and any conditions added under- section 7. This requirement modifies the requirement in section 4- to "keep intact all notices".-- c) You must license the entire work, as a whole, under this- License to anyone who comes into possession of a copy. This- License will therefore apply, along with any applicable section 7- additional terms, to the whole of the work, and all its parts,- regardless of how they are packaged. This License gives no- permission to license the work in any other way, but it does not- invalidate such permission if you have separately received it.-- d) If the work has interactive user interfaces, each must display- Appropriate Legal Notices; however, if the Program has interactive- interfaces that do not display Appropriate Legal Notices, your- work need not make them do so.--A compilation of a covered work with other separate and independent-works, which are not by their nature extensions of the covered work,-and which are not combined with it such as to form a larger program,-in or on a volume of a storage or distribution medium, is called an-"aggregate" if the compilation and its resulting copyright are not-used to limit the access or legal rights of the compilation's users-beyond what the individual works permit. Inclusion of a covered work-in an aggregate does not cause this License to apply to the other-parts of the aggregate.--#### 6. Conveying Non-Source Forms.--You may convey a covered work in object code form under the terms of-sections 4 and 5, provided that you also convey the machine-readable-Corresponding Source under the terms of this License, in one of these-ways:--- a) Convey the object code in, or embodied in, a physical product- (including a physical distribution medium), accompanied by the- Corresponding Source fixed on a durable physical medium- customarily used for software interchange.-- b) Convey the object code in, or embodied in, a physical product- (including a physical distribution medium), accompanied by a- written offer, valid for at least three years and valid for as- long as you offer spare parts or customer support for that product- model, to give anyone who possesses the object code either (1) a- copy of the Corresponding Source for all the software in the- product that is covered by this License, on a durable physical- medium customarily used for software interchange, for a price no- more than your reasonable cost of physically performing this- conveying of source, or (2) access to copy the Corresponding- Source from a network server at no charge.-- c) Convey individual copies of the object code with a copy of the- written offer to provide the Corresponding Source. This- alternative is allowed only occasionally and noncommercially, and- only if you received the object code with such an offer, in accord- with subsection 6b.-- d) Convey the object code by offering access from a designated- place (gratis or for a charge), and offer equivalent access to the- Corresponding Source in the same way through the same place at no- further charge. You need not require recipients to copy the- Corresponding Source along with the object code. If the place to- copy the object code is a network server, the Corresponding Source- may be on a different server (operated by you or a third party)- that supports equivalent copying facilities, provided you maintain- clear directions next to the object code saying where to find the- Corresponding Source. Regardless of what server hosts the- Corresponding Source, you remain obligated to ensure that it is- available for as long as needed to satisfy these requirements.-- e) Convey the object code using peer-to-peer transmission,- provided you inform other peers where the object code and- Corresponding Source of the work are being offered to the general- public at no charge under subsection 6d.--A separable portion of the object code, whose source code is excluded-from the Corresponding Source as a System Library, need not be-included in conveying the object code work.--A "User Product" is either (1) a "consumer product", which means any-tangible personal property which is normally used for personal,-family, or household purposes, or (2) anything designed or sold for-incorporation into a dwelling. In determining whether a product is a-consumer product, doubtful cases shall be resolved in favor of-coverage. For a particular product received by a particular user,-"normally used" refers to a typical or common use of that class of-product, regardless of the status of the particular user or of the way-in which the particular user actually uses, or expects or is expected-to use, the product. A product is a consumer product regardless of-whether the product has substantial commercial, industrial or-non-consumer uses, unless such uses represent the only significant-mode of use of the product.--"Installation Information" for a User Product means any methods,-procedures, authorization keys, or other information required to-install and execute modified versions of a covered work in that User-Product from a modified version of its Corresponding Source. The-information must suffice to ensure that the continued functioning of-the modified object code is in no case prevented or interfered with-solely because modification has been made.--If you convey an object code work under this section in, or with, or-specifically for use in, a User Product, and the conveying occurs as-part of a transaction in which the right of possession and use of the-User Product is transferred to the recipient in perpetuity or for a-fixed term (regardless of how the transaction is characterized), the-Corresponding Source conveyed under this section must be accompanied-by the Installation Information. But this requirement does not apply-if neither you nor any third party retains the ability to install-modified object code on the User Product (for example, the work has-been installed in ROM).--The requirement to provide Installation Information does not include a-requirement to continue to provide support service, warranty, or-updates for a work that has been modified or installed by the-recipient, or for the User Product in which it has been modified or-installed. Access to a network may be denied when the modification-itself materially and adversely affects the operation of the network-or violates the rules and protocols for communication across the-network.--Corresponding Source conveyed, and Installation Information provided,-in accord with this section must be in a format that is publicly-documented (and with an implementation available to the public in-source code form), and must require no special password or key for-unpacking, reading or copying.--#### 7. Additional Terms.--"Additional permissions" are terms that supplement the terms of this-License by making exceptions from one or more of its conditions.-Additional permissions that are applicable to the entire Program shall-be treated as though they were included in this License, to the extent-that they are valid under applicable law. If additional permissions-apply only to part of the Program, that part may be used separately-under those permissions, but the entire Program remains governed by-this License without regard to the additional permissions.--When you convey a copy of a covered work, you may at your option-remove any additional permissions from that copy, or from any part of-it. (Additional permissions may be written to require their own-removal in certain cases when you modify the work.) You may place-additional permissions on material, added by you to a covered work,-for which you have or can give appropriate copyright permission.--Notwithstanding any other provision of this License, for material you-add to a covered work, you may (if authorized by the copyright holders-of that material) supplement the terms of this License with terms:--- a) Disclaiming warranty or limiting liability differently from the- terms of sections 15 and 16 of this License; or-- b) Requiring preservation of specified reasonable legal notices or- author attributions in that material or in the Appropriate Legal- Notices displayed by works containing it; or-- c) Prohibiting misrepresentation of the origin of that material,- or requiring that modified versions of such material be marked in- reasonable ways as different from the original version; or-- d) Limiting the use for publicity purposes of names of licensors- or authors of the material; or-- e) Declining to grant rights under trademark law for use of some- trade names, trademarks, or service marks; or-- f) Requiring indemnification of licensors and authors of that- material by anyone who conveys the material (or modified versions- of it) with contractual assumptions of liability to the recipient,- for any liability that these contractual assumptions directly- impose on those licensors and authors.--All other non-permissive additional terms are considered "further-restrictions" within the meaning of section 10. If the Program as you-received it, or any part of it, contains a notice stating that it is-governed by this License along with a term that is a further-restriction, you may remove that term. If a license document contains-a further restriction but permits relicensing or conveying under this-License, you may add to a covered work material governed by the terms-of that license document, provided that the further restriction does-not survive such relicensing or conveying.--If you add terms to a covered work in accord with this section, you-must place, in the relevant source files, a statement of the-additional terms that apply to those files, or a notice indicating-where to find the applicable terms.--Additional terms, permissive or non-permissive, may be stated in the-form of a separately written license, or stated as exceptions; the-above requirements apply either way.--#### 8. Termination.--You may not propagate or modify a covered work except as expressly-provided under this License. Any attempt otherwise to propagate or-modify it is void, and will automatically terminate your rights under-this License (including any patent licenses granted under the third-paragraph of section 11).--However, if you cease all violation of this License, then your license-from a particular copyright holder is reinstated (a) provisionally,-unless and until the copyright holder explicitly and finally-terminates your license, and (b) permanently, if the copyright holder-fails to notify you of the violation by some reasonable means prior to-60 days after the cessation.--Moreover, your license from a particular copyright holder is-reinstated permanently if the copyright holder notifies you of the-violation by some reasonable means, this is the first time you have-received notice of violation of this License (for any work) from that-copyright holder, and you cure the violation prior to 30 days after-your receipt of the notice.--Termination of your rights under this section does not terminate the-licenses of parties who have received copies or rights from you under-this License. If your rights have been terminated and not permanently-reinstated, you do not qualify to receive new licenses for the same-material under section 10.--#### 9. Acceptance Not Required for Having Copies.--You are not required to accept this License in order to receive or run-a copy of the Program. Ancillary propagation of a covered work-occurring solely as a consequence of using peer-to-peer transmission-to receive a copy likewise does not require acceptance. However,-nothing other than this License grants you permission to propagate or-modify any covered work. These actions infringe copyright if you do-not accept this License. Therefore, by modifying or propagating a-covered work, you indicate your acceptance of this License to do so.--#### 10. Automatic Licensing of Downstream Recipients.--Each time you convey a covered work, the recipient automatically-receives a license from the original licensors, to run, modify and-propagate that work, subject to this License. You are not responsible-for enforcing compliance by third parties with this License.--An "entity transaction" is a transaction transferring control of an-organization, or substantially all assets of one, or subdividing an-organization, or merging organizations. If propagation of a covered-work results from an entity transaction, each party to that-transaction who receives a copy of the work also receives whatever-licenses to the work the party's predecessor in interest had or could-give under the previous paragraph, plus a right to possession of the-Corresponding Source of the work from the predecessor in interest, if-the predecessor has it or can get it with reasonable efforts.--You may not impose any further restrictions on the exercise of the-rights granted or affirmed under this License. For example, you may-not impose a license fee, royalty, or other charge for exercise of-rights granted under this License, and you may not initiate litigation-(including a cross-claim or counterclaim in a lawsuit) alleging that-any patent claim is infringed by making, using, selling, offering for-sale, or importing the Program or any portion of it.--#### 11. Patents.--A "contributor" is a copyright holder who authorizes use under this-License of the Program or a work on which the Program is based. The-work thus licensed is called the contributor's "contributor version".--A contributor's "essential patent claims" are all patent claims owned-or controlled by the contributor, whether already acquired or-hereafter acquired, that would be infringed by some manner, permitted-by this License, of making, using, or selling its contributor version,-but do not include claims that would be infringed only as a-consequence of further modification of the contributor version. For-purposes of this definition, "control" includes the right to grant-patent sublicenses in a manner consistent with the requirements of-this License.--Each contributor grants you a non-exclusive, worldwide, royalty-free-patent license under the contributor's essential patent claims, to-make, use, sell, offer for sale, import and otherwise run, modify and-propagate the contents of its contributor version.--In the following three paragraphs, a "patent license" is any express-agreement or commitment, however denominated, not to enforce a patent-(such as an express permission to practice a patent or covenant not to-sue for patent infringement). To "grant" such a patent license to a-party means to make such an agreement or commitment not to enforce a-patent against the party.--If you convey a covered work, knowingly relying on a patent license,-and the Corresponding Source of the work is not available for anyone-to copy, free of charge and under the terms of this License, through a-publicly available network server or other readily accessible means,-then you must either (1) cause the Corresponding Source to be so-available, or (2) arrange to deprive yourself of the benefit of the-patent license for this particular work, or (3) arrange, in a manner-consistent with the requirements of this License, to extend the patent-license to downstream recipients. "Knowingly relying" means you have-actual knowledge that, but for the patent license, your conveying the-covered work in a country, or your recipient's use of the covered work-in a country, would infringe one or more identifiable patents in that-country that you have reason to believe are valid.--If, pursuant to or in connection with a single transaction or-arrangement, you convey, or propagate by procuring conveyance of, a-covered work, and grant a patent license to some of the parties-receiving the covered work authorizing them to use, propagate, modify-or convey a specific copy of the covered work, then the patent license-you grant is automatically extended to all recipients of the covered-work and works based on it.--A patent license is "discriminatory" if it does not include within the-scope of its coverage, prohibits the exercise of, or is conditioned on-the non-exercise of one or more of the rights that are specifically-granted under this License. You may not convey a covered work if you-are a party to an arrangement with a third party that is in the-business of distributing software, under which you make payment to the-third party based on the extent of your activity of conveying the-work, and under which the third party grants, to any of the parties-who would receive the covered work from you, a discriminatory patent-license (a) in connection with copies of the covered work conveyed by-you (or copies made from those copies), or (b) primarily for and in-connection with specific products or compilations that contain the-covered work, unless you entered into that arrangement, or that patent-license was granted, prior to 28 March 2007.--Nothing in this License shall be construed as excluding or limiting-any implied license or other defenses to infringement that may-otherwise be available to you under applicable patent law.--#### 12. No Surrender of Others' Freedom.--If conditions are imposed on you (whether by court order, agreement or-otherwise) that contradict the conditions of this License, they do not-excuse you from the conditions of this License. If you cannot convey a-covered work so as to satisfy simultaneously your obligations under-this License and any other pertinent obligations, then as a-consequence you may not convey it at all. For example, if you agree to-terms that obligate you to collect a royalty for further conveying-from those to whom you convey the Program, the only way you could-satisfy both those terms and this License would be to refrain entirely-from conveying the Program.--#### 13. Use with the GNU Affero General Public License.--Notwithstanding any other provision of this License, you have-permission to link or combine any covered work with a work licensed-under version 3 of the GNU Affero General Public License into a single-combined work, and to convey the resulting work. The terms of this-License will continue to apply to the part which is the covered work,-but the special requirements of the GNU Affero General Public License,-section 13, concerning interaction through a network will apply to the-combination as such.--#### 14. Revised Versions of this License.--The Free Software Foundation may publish revised and/or new versions-of the GNU General Public License from time to time. Such new versions-will be similar in spirit to the present version, but may differ in-detail to address new problems or concerns.--Each version is given a distinguishing version number. If the Program-specifies that a certain numbered version of the GNU General Public-License "or any later version" applies to it, you have the option of-following the terms and conditions either of that numbered version or-of any later version published by the Free Software Foundation. If the-Program does not specify a version number of the GNU General Public-License, you may choose any version ever published by the Free-Software Foundation.--If the Program specifies that a proxy can decide which future versions-of the GNU General Public License can be used, that proxy's public-statement of acceptance of a version permanently authorizes you to-choose that version for the Program.--Later license versions may give you additional or different-permissions. However, no additional obligations are imposed on any-author or copyright holder as a result of your choosing to follow a-later version.--#### 15. Disclaimer of Warranty.--THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT-WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR-A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND-PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE-DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR-CORRECTION.--#### 16. Limitation of Liability.--IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR-CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES-ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT-NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR-LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM-TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER-PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.--#### 17. Interpretation of Sections 15 and 16.--If the disclaimer of warranty and limitation of liability provided-above cannot be given local legal effect according to their terms,-reviewing courts shall apply local law that most closely approximates-an absolute waiver of all civil liability in connection with the-Program, unless a warranty or assumption of liability accompanies a-copy of the Program in return for a fee.--END OF TERMS AND CONDITIONS--### How to Apply These Terms to Your New Programs--If you develop a new program, and you want it to be of the greatest-possible use to the public, the best way to achieve this is to make it-free software which everyone can redistribute and change under these-terms.--To do so, attach the following notices to the program. It is safest to-attach them to the start of each source file to most effectively state-the exclusion of warranty; and each file should have at least the-"copyright" line and a pointer to where the full notice is found.-- <one line to give the program's name and a brief idea of what it does.>- Copyright (C) <year> <name of author>-- This program is free software: you can redistribute it and/or modify- it under the terms of the GNU General Public License as published by- the Free Software Foundation, either version 3 of the License, or- (at your option) any later version.-- This program is distributed in the hope that it will be useful,- but WITHOUT ANY WARRANTY; without even the implied warranty of- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the- GNU General Public License for more details.-- You should have received a copy of the GNU General Public License- along with this program. If not, see <https://www.gnu.org/licenses/>.--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:-- <program> Copyright (C) <year> <name of author>- 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 <https://www.gnu.org/licenses/>.--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 <https://www.gnu.org/licenses/why-not-lgpl.html>.+### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. +<https://fsf.org/> + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 <https://www.gnu.org/licenses/>. + +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 <https://www.gnu.org/licenses/why-not-lgpl.html>.
README.md view
@@ -1,140 +1,141 @@-# ``finitary-derive``--## What's this all about, then?--Have you ever written an ``Unbox`` instance for a user-defined type? I hope not,-because it's a [uniquely tedious chore][1]. If your type is more complex, this-can be difficult, fiddly, and frustrating. ``Storable`` is not much better. This-is the kind of 'work' that we as Haskellers ought not to put up with.--Now, you don't have to! As long as your type is [``Finitary``][2], you can now-get ``Unbox`` and ``Storable`` (as well as a whole bunch of other) instances -_almost_ automagically:--```haskell-{-# LANGUAGE DeriveAnyClass #-}-{-# LANGUAGE DeriveGeneric #-}-{-# LANGUAGE DerivingVia #-}--import Data.Finitary-import Data.Finitary.Finiteness-import Data.Finitary.PackInto-import Data.Word-import Data.Hashable--import qualified Data.Vector.Unboxed as VU-import qualified Data.Vector.Storable as VS--data Foo = Bar | Baz (Word8, Word8) | Quux Word16- deriving (Eq, Generic, Finitary)- deriving (Ord, Bounded, Hashable, NFData, Binary) via (Finiteness Foo)--someVector :: VU.Vector (PackInto Foo Word64)-someVector = VU.fromList . fmap Packed $ [Bar, Baz 0x0 0xf, Quux 0x134]--someStorableVector :: VS.Vector (PackInto Foo Word64)-someStorableVector = VS.fromList . fmap Packed $ [Bar, Baz 0x0 0xf, Quux 0x134]-```--If you don't have access to ``DerivingVia``, you can still get the benefits of-this library -- just use ``Finitary a`` instead of ``a``. As it is a ``newtype``, -you can ``coerce`` through it if you care about efficiency.--## What's the deal with ``Unbox`` and ``Storable`` exactly? What's with all the ``Pack`` types?--Essentially, being ``Finitary`` means that there's a finite set of indexes, one-for each inhabitant. That means we can essentially represent any inhabitant as a-fixed-length number. It's on the basis of this that we can 'magic up'-``Storable`` and ``Unbox``.--However, how we _represent_ this fixed-length number isn't immediately obvious.-We have a couple of options:--- A string of bits-- A string of bytes-- An array of machine words--Additionally, if we have _another_ finitary type whose cardinality is not-smaller, we could potentially 'borrow' its instances as well. Which of these-choices is appropriate isn't obvious in general: it depends on whether you care-about space or speed, the cardinality of the type, and a bunch of other things-too. As we believe that the best people to judge tradeoffs like these are the-people using our library, we provide _all_ of these options for you to choose-from, so that you can choose the one that best suits you.--## So... what's the difference exactly?--``PackBits`` represents indexes as strings of bits. This is the most compact-representation possible (honestly, [maths says so][6]), but the least efficient, -as accessing individual bits is slower on most architectures than whole bytes or words.-Unless you've got large ``Vector``s, you probably don't need this encoding, but-if space is at an absolute premium, this is the best choice. --``PackBytes`` instead represents indexes as byte strings. This is a more-efficient choice than a string of bits, but can still be slow for architectures-which prefer whole-word access. It's also fairly compact, especially if your-architecture has big ``Word``s.--``PackWords`` represents indexes as fixed-length arrays of ``Word``s. This is-the most efficient encoding from the point of view of random reads and writes,-but will likely waste a lot of space, unless your type is _extremely_ large (as-in, multiple copies of ``Word`` large). --Lastly, ``PackInto`` lets you choose another finitary type whose instances you-want to 'borrow', and will use that type as a representation. This is the most-flexible, and should be preferred whenever possible. However, it requires that a-type of appropriate cardinality (at least as big as the one you want to encode)-exists, and has the appropriate instances. --## Why can't I ``DerivingVia`` through these ``Pack`` types?--For ``Unbox``, the short answer is 'role restrictions on unboxed vectors'. If-you want a more detailed explanation, check out the [GHC wiki on roles][3], as-well as the [implementation of ``Data.Vector.Unboxed``][4]. You might also want-to check out [stuff about data families][5]. --Additionally, there is some tension in the design. We could have made one of two-choices: either define ``Pack`` types as transparent ``newtype``s, and encode or-decode whenever a type class method required it; or define ``Pack`` types as-opaque, and encode or decode only when the values were constructed or-deconstructed. Ultimately, we went with the second option, as it makes the-occurences of encodes and decodes explicit to the user. Had we gone with the-first choice, it would be unclear where encodes and decodes occur, especially-when using functions built from type class methods. We believe this clarity is-worth the inability to use ``DerivingVia`` to define ``Storable`` instances.--## Why do ``PackBytes``, ``PackWords`` and ``PackInto`` have ``Storable`` instances, but not ``PackBits``?--Because it's not clear what this instance should look like. Let's suppose you want to bit-pack a-type ``Giraffe`` with cardinality 11 - what should ``sizeOf`` for ``PackBits-Giraffe`` be? How about ``alignment``? The only obvious solution is padding, but-in this case, you might as well use ``PackBytes``, ``PackWords`` or-``PackInto``, since then you'll at least know what you're getting, and are-explicit about it.--## Sounds good! Can I use it?--Certainly - we've tested on the following (all x86_64 only):--* __GNU/Linux:__ GHC 8.4.4, 8.6.5, 8.8.1-* __macOS:__ GHC 8.8.1--If you would like support for any additional GHC versions, let us know.-Unfortunately, while the library will _build_ on 8.4.4, due to-``hedgehog-classes`` being limited to 8.6+, tests cannot be run on this version.--If you build and use this library successfully on any other platforms, we'd like-to know too - it'd be beneficial even if nothing breaks, and _especially_ if-something does.--## License--This library is under the GNU General Public License, version 3 or later (SPDX-code ``GPL-3.0-or-later``). For more details, see the ``LICENSE.md`` file.--[1]: http://hackage.haskell.org/package/vector-0.12.0.3/docs/Data-Vector-Unboxed.html-[2]: https://hackage.haskell.org/package/finitary-1.0.0.1/docs/Data-Finitary.html#t:Finitary-[3]: https://gitlab.haskell.org/ghc/ghc/wikis/roles-[4]: http://hackage.haskell.org/package/vector-0.12.0.3/docs/src/Data.Vector.Unboxed.Base.html-[5]: https://wiki.haskell.org/GHC/Type_families-[6]: https://en.wikipedia.org/wiki/Kraft%E2%80%93McMillan_inequality+# ``finitary-derive`` + +## What's this all about, then? + +Have you ever written an ``Unbox`` instance for a user-defined type? I hope not, +because it's a [uniquely tedious chore][1]. If your type is more complex, this +can be difficult, fiddly, and frustrating. ``Storable`` is not much better. This +is the kind of 'work' that we as Haskellers ought not to put up with. + +Now, you don't have to! As long as your type is [``Finitary``][2], you can now +get ``Unbox`` and ``Storable`` (as well as a whole bunch of other) instances +_almost_ automagically: + +```haskell +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DerivingVia #-} + +import Data.Finitary +import Data.Finitary.Finiteness +import Data.Finitary.PackInto +import Data.Word +import Data.Hashable + +import qualified Data.Vector.Unboxed as VU +import qualified Data.Vector.Storable as VS + +data Foo = Bar | Baz (Word8, Word8) | Quux Word16 + deriving (Eq, Generic, Finitary) + deriving (Ord, Bounded, Hashable, NFData, Binary) via (Finiteness Foo) + +someVector :: VU.Vector (PackInto Foo Word64) +someVector = VU.fromList . fmap Packed $ [Bar, Baz 0x0 0xf, Quux 0x134] + +someStorableVector :: VS.Vector (PackInto Foo Word64) +someStorableVector = VS.fromList . fmap Packed $ [Bar, Baz 0x0 0xf, Quux 0x134] +``` + +If you don't have access to ``DerivingVia``, you can still get the benefits of +this library -- just use ``Finitary a`` instead of ``a``. As it is a ``newtype``, +you can ``coerce`` through it if you care about efficiency. + +## What's the deal with ``Unbox`` and ``Storable`` exactly? What's with all the ``Pack`` types? + +Essentially, being ``Finitary`` means that there's a finite set of indexes, one +for each inhabitant. That means we can essentially represent any inhabitant as a +fixed-length number. It's on the basis of this that we can 'magic up' +``Storable`` and ``Unbox``. + +However, how we _represent_ this fixed-length number isn't immediately obvious. +We have a couple of options: + +- A string of bits +- A string of bytes +- An array of machine words + +Additionally, if we have _another_ finitary type whose cardinality is not +smaller, we could potentially 'borrow' its instances as well. Which of these +choices is appropriate isn't obvious in general: it depends on whether you care +about space or speed, the cardinality of the type, and a bunch of other things +too. As we believe that the best people to judge tradeoffs like these are the +people using our library, we provide _all_ of these options for you to choose +from, so that you can choose the one that best suits you. + +## So... what's the difference exactly? + +``PackBits`` represents indexes as strings of bits. This is the most compact +representation possible (honestly, [maths says so][6]), but the least efficient, +as accessing individual bits is slower on most architectures than whole bytes or words. +Unless you've got large ``Vector``s, you probably don't need this encoding, but +if space is at an absolute premium, this is the best choice. + +``PackBytes`` instead represents indexes as byte strings. This is a more +efficient choice than a string of bits, but can still be slow for architectures +which prefer whole-word access. It's also fairly compact, especially if your +architecture has big ``Word``s. + +``PackWords`` represents indexes as fixed-length arrays of ``Word``s. This is +the most efficient encoding from the point of view of random reads and writes, +but will likely waste a lot of space, unless your type is _extremely_ large (as +in, multiple copies of ``Word`` large). + +Lastly, ``PackInto`` lets you choose another finitary type whose instances you +want to 'borrow', and will use that type as a representation. This is the most +flexible, and should be preferred whenever possible. However, it requires that a +type of appropriate cardinality (at least as big as the one you want to encode) +exists, and has the appropriate instances. + +## Why can't I ``DerivingVia`` through these ``Pack`` types? + +For ``Unbox``, the short answer is 'role restrictions on unboxed vectors'. If +you want a more detailed explanation, check out the [GHC wiki on roles][3], as +well as the [implementation of ``Data.Vector.Unboxed``][4]. You might also want +to check out [stuff about data families][5]. + +Additionally, there is some tension in the design. We could have made one of two +choices: either define ``Pack`` types as transparent ``newtype``s, and encode or +decode whenever a type class method required it; or define ``Pack`` types as +opaque, and encode or decode only when the values were constructed or +deconstructed. Ultimately, we went with the second option, as it makes the +occurences of encodes and decodes explicit to the user. Had we gone with the +first choice, it would be unclear where encodes and decodes occur, especially +when using functions built from type class methods. We believe this clarity is +worth the inability to use ``DerivingVia`` to define ``Storable`` instances. + +## Why do ``PackBytes``, ``PackWords`` and ``PackInto`` have ``Storable`` instances, but not ``PackBits``? + +Because it's not clear what this instance should look like. Let's suppose you want to bit-pack a +type ``Giraffe`` with cardinality 11 - what should ``sizeOf`` for ``PackBits +Giraffe`` be? How about ``alignment``? The only obvious solution is padding, but +in this case, you might as well use ``PackBytes``, ``PackWords`` or +``PackInto``, since then you'll at least know what you're getting, and are +explicit about it. + +## Sounds good! Can I use it? + +Certainly - we've tested on the following (all x86_64 only): + +* __GNU/Linux:__ GHC 8.4.4, 8.6.5, 8.8.1 +* __macOS:__ GHC 8.8.1 +* __Windows:__ GHC 8.10.4, 9.0.1 + +If you would like support for any additional GHC versions, let us know. +Unfortunately, while the library will _build_ on 8.4.4, due to +``hedgehog-classes`` being limited to 8.6+, tests cannot be run on this version. + +If you build and use this library successfully on any other platforms, we'd like +to know too - it'd be beneficial even if nothing breaks, and _especially_ if +something does. + +## License + +This library is under the GNU General Public License, version 3 or later (SPDX +code ``GPL-3.0-or-later``). For more details, see the ``LICENSE.md`` file. + +[1]: http://hackage.haskell.org/package/vector-0.12.0.3/docs/Data-Vector-Unboxed.html +[2]: https://hackage.haskell.org/package/finitary-1.0.0.1/docs/Data-Finitary.html#t:Finitary +[3]: https://gitlab.haskell.org/ghc/ghc/wikis/roles +[4]: http://hackage.haskell.org/package/vector-0.12.0.3/docs/src/Data.Vector.Unboxed.Base.html +[5]: https://wiki.haskell.org/GHC/Type_families +[6]: https://en.wikipedia.org/wiki/Kraft%E2%80%93McMillan_inequality
Setup.hs view
@@ -1,3 +1,3 @@-import Distribution.Simple--main = defaultMain+import Distribution.Simple + +main = defaultMain
finitary-derive.cabal view
@@ -1,66 +1,68 @@-cabal-version: 2.2-name: finitary-derive--- PVP summary: +-+------- breaking API changes--- | | +----- non-breaking API additions--- | | | +--- code changes with no API change-version: 2.2.0.0-synopsis: Flexible and easy deriving of type classes for finitary- types.-description: Provides a collection of wrappers, allowing you to easily- define (among others) Unbox, Storable, Hashable and- Binary instances for finitary types with flexibility in- terms of representation and efficiency. Never write an- Unbox instance by hand again!-homepage: https://notabug.org/koz.ross/finitary-derive-license: GPL-3.0-or-later-license-file: LICENSE.md-author: Koz Ross-maintainer: koz.ross@retro-freedom.nz-copyright: (C) Koz Ross 2019-category: Data-tested-with: GHC == 8.4.4,- GHC == 8.6.5,- GHC == 8.8.1-build-type: Simple-extra-source-files: CHANGELOG.md,- README.md--library- exposed-modules: Data.Finitary.Finiteness,- Data.Finitary.PackBits,- Data.Finitary.PackBits.Unsafe,- Data.Finitary.PackBytes,- Data.Finitary.PackWords,- Data.Finitary.PackInto- build-depends: base >= 4.11 && < 4.14,- finitary >= 1.2.0.0 && < 1.3.0.0,- vector >= 0.12.0.3 && < 0.13.0.0,- coercible-utils >= 0.0.0 && < 0.1.0,- finite-typelits >= 0.1.4.2 && < 0.2.0.0,- binary >= 0.8.5.1 && < 0.9.0.0,- deepseq >= 1.4.3.0 && < 1.5.0.0,- hashable >= 1.3.0.0 && < 1.4.0.0,- ghc-typelits-extra >= 0.3.1 && < 0.4.0,- ghc-typelits-knownnat >= 0.7 && < 0.8,- vector-instances >= 3.4 && < 3.5,- transformers >= 0.5.5.0 && < 0.6.0.0,- bitvec >= 1.0.2.0 && < 1.1.0.0,- vector-binary-instances >= 0.2.5.1 && < 0.3.0.0- hs-source-dirs: src- default-language: Haskell2010--test-suite tests- type: exitcode-stdio-1.0- main-is: Main.hs- ghc-options: -O2 -threaded -rtsopts -with-rtsopts=-N- hs-source-dirs: test- build-depends: base >= 4.12 && < 4.14,- hedgehog >= 1.0.1 && < 1.1,- hedgehog-classes >= 0.2.4 && < 0.3.0,- finitary-derive,- finitary,- finite-typelits,- hashable,- binary,- deepseq- default-language: Haskell2010+cabal-version: 2.2 +name: finitary-derive +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 2.2.0.1 +synopsis: Flexible and easy deriving of type classes for finitary + types. +description: Provides a collection of wrappers, allowing you to easily + define (among others) Unbox, Storable, Hashable and + Binary instances for finitary types with flexibility in + terms of representation and efficiency. Never write an + Unbox instance by hand again! +homepage: https://notabug.org/sheaf/finitary-derive +license: GPL-3.0-or-later +license-file: LICENSE.md +author: Koz Ross +maintainer: Sam Derbyshire +copyright: (C) Koz Ross 2019 +category: Data +tested-with: GHC == 8.4.4, + GHC == 8.6.5, + GHC == 8.8.1, + GHC == 8.10.4, + GHC == 9.0.1 +build-type: Simple +extra-source-files: CHANGELOG.md, + README.md + +library + exposed-modules: Data.Finitary.Finiteness, + Data.Finitary.PackBits, + Data.Finitary.PackBits.Unsafe, + Data.Finitary.PackBytes, + Data.Finitary.PackWords, + Data.Finitary.PackInto + build-depends: base >= 4.11 && < 4.16, + finitary >= 1.2.0.0 && < 2.2, + vector >= 0.12.0.3 && < 0.13.0.0, + coercible-utils >= 0.0.0 && < 0.1.0, + finite-typelits >= 0.1.4.2 && < 0.2.0.0, + binary >= 0.8.5.1 && < 0.11.0.0, + deepseq >= 1.4.3.0 && < 1.5.0.0, + hashable >= 1.3.0.0 && < 1.4.0.0, + ghc-typelits-extra >= 0.3.1 && < 0.5, + ghc-typelits-knownnat >= 0.7 && < 0.8, + vector-instances >= 3.4 && < 3.5, + transformers >= 0.5.5.0 && < 0.6.0.0, + bitvec >= 1.0.2.0 && < 1.2.0.0, + vector-binary-instances >= 0.2.5.1 && < 0.3.0.0 + hs-source-dirs: src + default-language: Haskell2010 + +test-suite tests + type: exitcode-stdio-1.0 + main-is: Main.hs + ghc-options: -O2 -threaded -rtsopts -with-rtsopts=-N + hs-source-dirs: test + build-depends: base >= 4.12 && < 4.16, + hedgehog >= 1.0.1 && < 1.1, + hedgehog-classes >= 0.2.4 && < 0.3.0, + finitary-derive, + finitary, + finite-typelits, + hashable, + binary, + deepseq + default-language: Haskell2010
src/Data/Finitary/Finiteness.hs view
@@ -1,145 +1,144 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# LANGUAGE TypeInType #-}-{-# LANGUAGE DeriveDataTypeable #-}-{-# LANGUAGE GeneralizedNewtypeDeriving #-}-{-# LANGUAGE DeriveFunctor #-}-{-# LANGUAGE Trustworthy #-}-{-# LANGUAGE TypeOperators #-}-{-# LANGUAGE TypeFamilies #-}-{-# LANGUAGE TypeApplications #-}---- |--- Module: Data.Finitary.Finiteness--- Description: Newtype wrapper for deriving various typeclasses for--- @Finitary@ types.--- Copyright: (C) Koz Ross 2019--- License: GPL version 3.0 or later--- Maintainer: koz.ross@retro-freedom.nz--- Stability: Experimental--- Portability: GHC only------ Knowing that a type @a@ is an instance of @Finitary@ gives us the knowledge--- that there is an isomorphism between @a@ and @Finite n@ for some @KnownNat--- n@. This gives us a lot of information, which we can exploit to automagically--- derive a range of type class instances.------ 'Finiteness' is a @newtype@ wrapper providing this functionality, while--- 're-exporting' as many type class instances of the underlying type as--- possible. It is designed for use with @DerivingVia@ - an example of use:------ > {-# LANGUAGE DerivingVia #-}--- > {-# LANGUAGE DeriveAnyClass #-}--- > {-# LANGUAGE DeriveGeneric #-}--- >--- > import GHC.Generics--- > import Data.Finitary--- > import Data.Finitary.Finiteness--- > import Data.Word--- > import Control.DeepSeq--- > import Data.Hashable--- > import Data.Binary--- > --- > data Foo = Bar | Baz (Word8, Word8) | Quux Word16--- > deriving (Eq, Generic, Finitary)--- > deriving (Ord, Bounded, NFData, Hashable, Binary) via (Finiteness Foo)------ Currently, the following type class instances can be derived in this manner:------ * 'Ord'--- * 'Bounded'--- * 'NFData'--- * 'Hashable'--- * 'Binary'------ Additionally, 'Finiteness' \'forwards\' definitions of the following type--- classes:------ * 'Eq'--- * 'Show'--- * 'Read'--- * 'Typeable'--- * 'Data'--- * 'Semigroup'--- * 'Monoid'-module Data.Finitary.Finiteness -(- Finiteness(..)-) where--import GHC.TypeNats-import Data.Typeable (Typeable)-import Data.Data (Data)-import Data.Finitary (Finitary(..))-import Data.Ord (comparing)-import Control.DeepSeq (NFData(..))-import Data.Hashable (Hashable(..))-import Data.Binary (Binary(..))---- | Essentially 'Data.Functor.Identity' with a different name. Named this way due to the--- wordplay you get from use with @DerivingVia@.-newtype Finiteness a = Finiteness { unFiniteness :: a }- deriving (Eq, Show, Read, Typeable, Data, Functor, Semigroup, Monoid)---- | 'Finiteness' merely replicates the @Finitary@ behaviour of the underlying--- type.-instance (Finitary a) => Finitary (Finiteness a) where- type Cardinality (Finiteness a) = Cardinality a- {-# INLINE fromFinite #-}- fromFinite = Finiteness . fromFinite- {-# INLINE toFinite #-}- toFinite = toFinite . unFiniteness- {-# INLINE start #-}- start = Finiteness start- {-# INLINE end #-}- end = Finiteness end- {-# INLINE previous #-}- previous = fmap Finiteness . previous . unFiniteness- {-# INLINE next #-}- next = fmap Finiteness . next . unFiniteness---- | 'Ord' can be derived by deferring to the order on @Finite (Cardinality a)@.-instance (Finitary a) => Ord (Finiteness a) where- {-# INLINE compare #-}- compare (Finiteness x) (Finiteness y) = comparing toFinite x y---- | Since any inhabited 'Finitary' type is also 'Bounded', we can forward this--- definition also.-instance (Finitary a, 1 <= Cardinality a) => Bounded (Finiteness a) where- {-# INLINE minBound #-}- minBound = Finiteness start- {-# INLINE maxBound #-}- maxBound = Finiteness end---- | We can force evaluation of a 'Finitary' type by converting it to its index.-instance (Finitary a) => NFData (Finiteness a) where- {-# INLINE rnf #-}- rnf = rnf . toFinite . unFiniteness---- | Any 'Finitary' type can be hashed by hashing its index.-instance (Finitary a) => Hashable (Finiteness a) where - {-# INLINE hashWithSalt #-}- hashWithSalt salt = hashWithSalt salt . fromIntegral @_ @Integer . toFinite . unFiniteness---- | Any 'Finitary' type can be converted to a binary representation by--- converting its index.-instance (Finitary a) => Binary (Finiteness a) where- {-# INLINE put #-}- put = put . fromIntegral @_ @Integer . toFinite . unFiniteness- {-# INLINE get #-}- get = Finiteness . fromFinite . fromIntegral @Integer <$> get+{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE DeriveFunctor #-} +{-# LANGUAGE Trustworthy #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeApplications #-} + +-- | +-- Module: Data.Finitary.Finiteness +-- Description: Newtype wrapper for deriving various typeclasses for +-- @Finitary@ types. +-- Copyright: (C) Koz Ross 2019 +-- License: GPL version 3.0 or later +-- Stability: Experimental +-- Portability: GHC only +-- +-- Knowing that a type @a@ is an instance of @Finitary@ gives us the knowledge +-- that there is an isomorphism between @a@ and @Finite n@ for some @KnownNat +-- n@. This gives us a lot of information, which we can exploit to automagically +-- derive a range of type class instances. +-- +-- 'Finiteness' is a @newtype@ wrapper providing this functionality, while +-- 're-exporting' as many type class instances of the underlying type as +-- possible. It is designed for use with @DerivingVia@ - an example of use: +-- +-- > {-# LANGUAGE DerivingVia #-} +-- > {-# LANGUAGE DeriveAnyClass #-} +-- > {-# LANGUAGE DeriveGeneric #-} +-- > +-- > import GHC.Generics +-- > import Data.Finitary +-- > import Data.Finitary.Finiteness +-- > import Data.Word +-- > import Control.DeepSeq +-- > import Data.Hashable +-- > import Data.Binary +-- > +-- > data Foo = Bar | Baz (Word8, Word8) | Quux Word16 +-- > deriving (Eq, Generic, Finitary) +-- > deriving (Ord, Bounded, NFData, Hashable, Binary) via (Finiteness Foo) +-- +-- Currently, the following type class instances can be derived in this manner: +-- +-- * 'Ord' +-- * 'Bounded' +-- * 'NFData' +-- * 'Hashable' +-- * 'Binary' +-- +-- Additionally, 'Finiteness' \'forwards\' definitions of the following type +-- classes: +-- +-- * 'Eq' +-- * 'Show' +-- * 'Read' +-- * 'Typeable' +-- * 'Data' +-- * 'Semigroup' +-- * 'Monoid' +module Data.Finitary.Finiteness +( + Finiteness(..) +) where + +import GHC.TypeNats +import Data.Typeable (Typeable) +import Data.Data (Data) +import Data.Finitary (Finitary(..)) +import Data.Ord (comparing) +import Control.DeepSeq (NFData(..)) +import Data.Hashable (Hashable(..)) +import Data.Binary (Binary(..)) + +-- | Essentially 'Data.Functor.Identity' with a different name. Named this way due to the +-- wordplay you get from use with @DerivingVia@. +newtype Finiteness a = Finiteness { unFiniteness :: a } + deriving (Eq, Show, Read, Typeable, Data, Functor, Semigroup, Monoid) + +-- | 'Finiteness' merely replicates the @Finitary@ behaviour of the underlying +-- type. +instance (Finitary a) => Finitary (Finiteness a) where + type Cardinality (Finiteness a) = Cardinality a + {-# INLINE fromFinite #-} + fromFinite = Finiteness . fromFinite + {-# INLINE toFinite #-} + toFinite = toFinite . unFiniteness + {-# INLINE start #-} + start = Finiteness start + {-# INLINE end #-} + end = Finiteness end + {-# INLINE previous #-} + previous = fmap Finiteness . previous . unFiniteness + {-# INLINE next #-} + next = fmap Finiteness . next . unFiniteness + +-- | 'Ord' can be derived by deferring to the order on @Finite (Cardinality a)@. +instance (Finitary a) => Ord (Finiteness a) where + {-# INLINE compare #-} + compare (Finiteness x) (Finiteness y) = comparing toFinite x y + +-- | Since any inhabited 'Finitary' type is also 'Bounded', we can forward this +-- definition also. +instance (Finitary a, 1 <= Cardinality a) => Bounded (Finiteness a) where + {-# INLINE minBound #-} + minBound = Finiteness start + {-# INLINE maxBound #-} + maxBound = Finiteness end + +-- | We can force evaluation of a 'Finitary' type by converting it to its index. +instance (Finitary a) => NFData (Finiteness a) where + {-# INLINE rnf #-} + rnf = rnf . toFinite . unFiniteness + +-- | Any 'Finitary' type can be hashed by hashing its index. +instance (Finitary a) => Hashable (Finiteness a) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = hashWithSalt salt . fromIntegral @_ @Integer . toFinite . unFiniteness + +-- | Any 'Finitary' type can be converted to a binary representation by +-- converting its index. +instance (Finitary a) => Binary (Finiteness a) where + {-# INLINE put #-} + put = put . fromIntegral @_ @Integer . toFinite . unFiniteness + {-# INLINE get #-} + get = Finiteness . fromFinite . fromIntegral @Integer <$> get
src/Data/Finitary/PackBits.hs view
@@ -1,241 +1,240 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-}-{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}--{-# LANGUAGE ViewPatterns #-}-{-# LANGUAGE PatternSynonyms #-}-{-# LANGUAGE RoleAnnotations #-}-{-# LANGUAGE AllowAmbiguousTypes #-}-{-# LANGUAGE ScopedTypeVariables #-}-{-# LANGUAGE TypeInType #-}-{-# LANGUAGE TypeOperators #-}-{-# LANGUAGE TypeFamilies #-}-{-# LANGUAGE TypeApplications #-}-{-# LANGUAGE Trustworthy #-}-{-# LANGUAGE MultiParamTypeClasses #-}-{-# LANGUAGE UndecidableInstances #-}-{-# LANGUAGE StandaloneDeriving #-}-{-# LANGUAGE GeneralizedNewtypeDeriving #-}---- |--- Module: Data.Finitary.PackBits--- Description: Scheme for bit-packing @Finitary@ types.--- Copyright: (C) Koz Ross 2019--- License: GPL version 3.0 or later--- Maintainer: koz.ross@retro-freedom.nz--- Stability: Experimental--- Portability: GHC only------ From the [Kraft-McMillan--- inequality](https://en.wikipedia.org/wiki/Kraft%E2%80%93McMillan_inequality)--- and --- the fact that we are not able to have \'fractional\' bits, we can derive a--- fixed-length code into a bitstring for any 'Finitary' type @a@, with code--- length \(\lceil \log_{2}(\texttt{Cardinality a}) \rceil\) bits. This code is--- essentially a binary representation of the index of each inhabitant of @a@.--- On that basis, we can derive an 'VU.Unbox' instance, representing--- the entire 'VU.Vector' as an unboxed [bit--- array](https://en.wikipedia.org/wiki/Bit_array).------ This encoding is advantageous from the point of view of space - there is no--- tighter possible packing that preserves \(\Theta(1)\) random access and also--- allows the full range of 'VU.Vector' operations. If you are concerned about--- space usage above all, this is the best choice for you. ------ Because access to individual bits is slower than whole bytes or words, this--- encoding adds some overhead. Additionally, a primary advantage of bit arrays--- (the ability to perform \'bulk\' operations on bits efficiently) is not made--- use of here. Therefore, if speed matters more than compactness, this encoding--- is suboptimal.------ This encoding is __thread-safe__, and thus slightly slower. If you are certain --- that race conditions cannot occur for your code, you can gain a speed improvement --- by using "Data.Finitary.PackBits.Unsafe" instead.-module Data.Finitary.PackBits -(- PackBits, pattern Packed,- BulkPack, exposeVector-) where--import GHC.TypeLits.Extra-import Data.Proxy (Proxy(..))-import Numeric.Natural (Natural)-import GHC.TypeNats-import CoercibleUtils (op, over, over2)-import Data.Kind (Type)-import Data.Hashable (Hashable(..))-import Data.Vector.Instances ()-import Data.Vector.Binary ()-import Control.DeepSeq (NFData(..))-import Data.Finitary(Finitary(..))-import Data.Finite (Finite)-import Control.Monad.Trans.State.Strict (evalState, get, modify, put)-import Data.Semigroup (Dual(..))--import qualified Data.Binary as Bin-import qualified Data.Bit.ThreadSafe as BT-import qualified Data.Vector.Generic as VG-import qualified Data.Vector.Generic.Mutable as VGM-import qualified Data.Vector.Unboxed as VU---- | An opaque wrapper around @a@, representing each value as a 'bit-packed'--- encoding.-newtype PackBits (a :: Type) = PackBits (VU.Vector BT.Bit)- deriving (Eq, Show)--type role PackBits nominal---- | To provide (something that resembles a) data constructor for 'PackBits', we--- provide the following pattern. It can be used like any other data--- constructor:------ > import Data.Finitary.PackBits--- >--- > anInt :: PackBits Int--- > anInt = Packed 10--- >--- > isPackedEven :: PackBits Int -> Bool--- > isPackedEven (Packed x) = even x------ __Every__ pattern match, and data constructor call, performs a--- \(\Theta(\log_{2}(\texttt{Cardinality a}))\) encoding or decoding operation. --- Use with this in mind.-pattern Packed :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackBits a-pattern Packed x <- (unpackBits -> x)- where Packed x = packBits x--instance Ord (PackBits a) where- compare (PackBits v1) (PackBits v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2- where go input order = (order <>) . Dual . uncurry compare $ input--instance NFData (PackBits a) where- {-# INLINE rnf #-}- rnf = rnf . op PackBits--instance (Finitary a, 1 <= Cardinality a) => Finitary (PackBits a) where- type Cardinality (PackBits a) = Cardinality a- {-# INLINE fromFinite #-}- fromFinite = PackBits . intoBits- {-# INLINE toFinite #-}- toFinite = outOfBits . op PackBits--instance (Finitary a, 1 <= Cardinality a) => Bounded (PackBits a) where- {-# INLINE minBound #-}- minBound = start- {-# INLINE maxBound #-}- maxBound = end--newtype instance VU.MVector s (PackBits a) = MV_PackBits (VU.MVector s BT.Bit)--instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackBits a) where- {-# INLINE basicLength #-}- basicLength = over MV_PackBits ((`div` bitLength @a) . VGM.basicLength)- {-# INLINE basicOverlaps #-}- basicOverlaps = over2 MV_PackBits VGM.basicOverlaps- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over MV_PackBits (VGM.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a))- {-# INLINE basicUnsafeNew #-}- basicUnsafeNew len = fmap MV_PackBits (VGM.basicUnsafeNew (len * bitLength @a))- {-# INLINE basicInitialize #-}- basicInitialize = VGM.basicInitialize . op MV_PackBits- {-# INLINE basicUnsafeRead #-}- basicUnsafeRead (MV_PackBits v) i = fmap PackBits . VG.freeze . VGM.unsafeSlice (i * bitLength @a) (bitLength @a) $ v- {-# INLINE basicUnsafeWrite #-}- basicUnsafeWrite (MV_PackBits v) i (PackBits x) = let slice = VGM.unsafeSlice (i * bitLength @a) (bitLength @a) v in- VG.unsafeCopy slice x--newtype instance VU.Vector (PackBits a) = V_PackBits (VU.Vector BT.Bit)--instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackBits a) where- {-# INLINE basicLength #-}- basicLength = over V_PackBits ((`div` bitLength @a) . VG.basicLength)- {-# INLINE basicUnsafeFreeze #-}- basicUnsafeFreeze = fmap V_PackBits . VG.basicUnsafeFreeze . op MV_PackBits- {-# INLINE basicUnsafeThaw #-}- basicUnsafeThaw = fmap MV_PackBits . VG.basicUnsafeThaw . op V_PackBits- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over V_PackBits (VG.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a))- {-# INLINE basicUnsafeIndexM #-}- basicUnsafeIndexM (V_PackBits v) i = pure . PackBits . VG.unsafeSlice (i * bitLength @a) (bitLength @a) $ v--instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackBits a)---- | This wrapper provides an efficient 'Hashable' instance (hash the entire--- underlying bit-packed vector, rather than each element individually), as well--- as a 'Bin.Binary' instance (which stores or reads the entire blob of--- bits \'in one go\').-newtype BulkPack a = BulkPack { exposeVector :: VU.Vector (PackBits a) }- deriving (NFData)--deriving instance (Finitary a, 1 <= Cardinality a) => Eq (BulkPack a)--deriving instance (Finitary a, 1 <= Cardinality a) => Ord (BulkPack a)--instance Hashable (BulkPack a) where- {-# INLINE hashWithSalt #-}- hashWithSalt salt = hashWithSalt salt . BT.cloneToWords . op V_PackBits . op BulkPack--instance Bin.Binary (BulkPack a) where- {-# INLINE put #-}- put = Bin.put . BT.cloneToWords . op V_PackBits . op BulkPack- {-# INLINE get #-}- get = BulkPack . V_PackBits . BT.castFromWords <$> Bin.get---- Helpers--type BitLength a = CLog 2 (Cardinality a)--{-# INLINE packBits #-}-packBits :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackBits a-packBits = fromFinite . toFinite--{-# INLINE unpackBits #-}-unpackBits :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - PackBits a -> a-unpackBits = fromFinite . toFinite--{-# INLINE bitLength #-}-bitLength :: forall (a :: Type) (b :: Type) . - (Finitary a, 1 <= Cardinality a, Num b) => - b-bitLength = fromIntegral . natVal $ (Proxy :: Proxy (BitLength a))--{-# INLINE intoBits #-}-intoBits :: forall (n :: Nat) .- (KnownNat n, 1 <= n) => - Finite n -> VU.Vector BT.Bit-intoBits = evalState (VU.replicateM (bitLength @(Finite n)) go) . fromIntegral @_ @Natural- where go = do remaining <- get- let (d, r) = quotRem remaining 2- put d >> pure (BT.Bit . toEnum . fromIntegral $ r)- -{-# INLINE outOfBits #-}-outOfBits :: forall (n :: Nat) .- (KnownNat n) => - VU.Vector BT.Bit -> Finite n-outOfBits v = evalState (VU.foldM' go 0 v) 1- where go old (BT.Bit b) = do power <- get- let placeValue = power * (fromIntegral . fromEnum $ b)- modify (* 2)- return (old + placeValue)+{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-} +{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-} + +{-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE RoleAnnotations #-} +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE Trustworthy #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE UndecidableInstances #-} +{-# LANGUAGE StandaloneDeriving #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +-- | +-- Module: Data.Finitary.PackBits +-- Description: Scheme for bit-packing @Finitary@ types. +-- Copyright: (C) Koz Ross 2019 +-- License: GPL version 3.0 or later +-- Stability: Experimental +-- Portability: GHC only +-- +-- From the [Kraft-McMillan +-- inequality](https://en.wikipedia.org/wiki/Kraft%E2%80%93McMillan_inequality) +-- and +-- the fact that we are not able to have \'fractional\' bits, we can derive a +-- fixed-length code into a bitstring for any 'Finitary' type @a@, with code +-- length \(\lceil \log_{2}(\texttt{Cardinality a}) \rceil\) bits. This code is +-- essentially a binary representation of the index of each inhabitant of @a@. +-- On that basis, we can derive an 'VU.Unbox' instance, representing +-- the entire 'VU.Vector' as an unboxed [bit +-- array](https://en.wikipedia.org/wiki/Bit_array). +-- +-- This encoding is advantageous from the point of view of space - there is no +-- tighter possible packing that preserves \(\Theta(1)\) random access and also +-- allows the full range of 'VU.Vector' operations. If you are concerned about +-- space usage above all, this is the best choice for you. +-- +-- Because access to individual bits is slower than whole bytes or words, this +-- encoding adds some overhead. Additionally, a primary advantage of bit arrays +-- (the ability to perform \'bulk\' operations on bits efficiently) is not made +-- use of here. Therefore, if speed matters more than compactness, this encoding +-- is suboptimal. +-- +-- This encoding is __thread-safe__, and thus slightly slower. If you are certain +-- that race conditions cannot occur for your code, you can gain a speed improvement +-- by using "Data.Finitary.PackBits.Unsafe" instead. +module Data.Finitary.PackBits +( + PackBits, pattern Packed, + BulkPack, exposeVector +) where + +import GHC.TypeLits.Extra +import Data.Proxy (Proxy(..)) +import Numeric.Natural (Natural) +import GHC.TypeNats +import CoercibleUtils (op, over, over2) +import Data.Kind (Type) +import Data.Hashable (Hashable(..)) +import Data.Vector.Instances () +import Data.Vector.Binary () +import Control.DeepSeq (NFData(..)) +import Data.Finitary(Finitary(..)) +import Data.Finite (Finite) +import Control.Monad.Trans.State.Strict (evalState, get, modify, put) +import Data.Semigroup (Dual(..)) + +import qualified Data.Binary as Bin +import qualified Data.Bit.ThreadSafe as BT +import qualified Data.Vector.Generic as VG +import qualified Data.Vector.Generic.Mutable as VGM +import qualified Data.Vector.Unboxed as VU + +-- | An opaque wrapper around @a@, representing each value as a 'bit-packed' +-- encoding. +newtype PackBits (a :: Type) = PackBits (VU.Vector BT.Bit) + deriving (Eq, Show) + +type role PackBits nominal + +-- | To provide (something that resembles a) data constructor for 'PackBits', we +-- provide the following pattern. It can be used like any other data +-- constructor: +-- +-- > import Data.Finitary.PackBits +-- > +-- > anInt :: PackBits Int +-- > anInt = Packed 10 +-- > +-- > isPackedEven :: PackBits Int -> Bool +-- > isPackedEven (Packed x) = even x +-- +-- __Every__ pattern match, and data constructor call, performs a +-- \(\Theta(\log_{2}(\texttt{Cardinality a}))\) encoding or decoding operation. +-- Use with this in mind. +pattern Packed :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackBits a +pattern Packed x <- (unpackBits -> x) + where Packed x = packBits x + +instance Ord (PackBits a) where + compare (PackBits v1) (PackBits v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2 + where go input order = (order <>) . Dual . uncurry compare $ input + +instance NFData (PackBits a) where + {-# INLINE rnf #-} + rnf = rnf . op PackBits + +instance (Finitary a, 1 <= Cardinality a) => Finitary (PackBits a) where + type Cardinality (PackBits a) = Cardinality a + {-# INLINE fromFinite #-} + fromFinite = PackBits . intoBits + {-# INLINE toFinite #-} + toFinite = outOfBits . op PackBits + +instance (Finitary a, 1 <= Cardinality a) => Bounded (PackBits a) where + {-# INLINE minBound #-} + minBound = start + {-# INLINE maxBound #-} + maxBound = end + +newtype instance VU.MVector s (PackBits a) = MV_PackBits (VU.MVector s BT.Bit) + +instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackBits a) where + {-# INLINE basicLength #-} + basicLength = over MV_PackBits ((`div` bitLength @a) . VGM.basicLength) + {-# INLINE basicOverlaps #-} + basicOverlaps = over2 MV_PackBits VGM.basicOverlaps + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over MV_PackBits (VGM.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a)) + {-# INLINE basicUnsafeNew #-} + basicUnsafeNew len = fmap MV_PackBits (VGM.basicUnsafeNew (len * bitLength @a)) + {-# INLINE basicInitialize #-} + basicInitialize = VGM.basicInitialize . op MV_PackBits + {-# INLINE basicUnsafeRead #-} + basicUnsafeRead (MV_PackBits v) i = fmap PackBits . VG.freeze . VGM.unsafeSlice (i * bitLength @a) (bitLength @a) $ v + {-# INLINE basicUnsafeWrite #-} + basicUnsafeWrite (MV_PackBits v) i (PackBits x) = let slice = VGM.unsafeSlice (i * bitLength @a) (bitLength @a) v in + VG.unsafeCopy slice x + +newtype instance VU.Vector (PackBits a) = V_PackBits (VU.Vector BT.Bit) + +instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackBits a) where + {-# INLINE basicLength #-} + basicLength = over V_PackBits ((`div` bitLength @a) . VG.basicLength) + {-# INLINE basicUnsafeFreeze #-} + basicUnsafeFreeze = fmap V_PackBits . VG.basicUnsafeFreeze . op MV_PackBits + {-# INLINE basicUnsafeThaw #-} + basicUnsafeThaw = fmap MV_PackBits . VG.basicUnsafeThaw . op V_PackBits + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over V_PackBits (VG.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a)) + {-# INLINE basicUnsafeIndexM #-} + basicUnsafeIndexM (V_PackBits v) i = pure . PackBits . VG.unsafeSlice (i * bitLength @a) (bitLength @a) $ v + +instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackBits a) + +-- | This wrapper provides an efficient 'Hashable' instance (hash the entire +-- underlying bit-packed vector, rather than each element individually), as well +-- as a 'Bin.Binary' instance (which stores or reads the entire blob of +-- bits \'in one go\'). +newtype BulkPack a = BulkPack { exposeVector :: VU.Vector (PackBits a) } + deriving (NFData) + +deriving instance (Finitary a, 1 <= Cardinality a) => Eq (BulkPack a) + +deriving instance (Finitary a, 1 <= Cardinality a) => Ord (BulkPack a) + +instance Hashable (BulkPack a) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = hashWithSalt salt . BT.cloneToWords . op V_PackBits . op BulkPack + +instance Bin.Binary (BulkPack a) where + {-# INLINE put #-} + put = Bin.put . BT.cloneToWords . op V_PackBits . op BulkPack + {-# INLINE get #-} + get = BulkPack . V_PackBits . BT.castFromWords <$> Bin.get + +-- Helpers + +type BitLength a = CLog 2 (Cardinality a) + +{-# INLINE packBits #-} +packBits :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackBits a +packBits = fromFinite . toFinite + +{-# INLINE unpackBits #-} +unpackBits :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + PackBits a -> a +unpackBits = fromFinite . toFinite + +{-# INLINE bitLength #-} +bitLength :: forall (a :: Type) (b :: Type) . + (Finitary a, 1 <= Cardinality a, Num b) => + b +bitLength = fromIntegral . natVal $ (Proxy :: Proxy (BitLength a)) + +{-# INLINE intoBits #-} +intoBits :: forall (n :: Nat) . + (KnownNat n, 1 <= n) => + Finite n -> VU.Vector BT.Bit +intoBits = evalState (VU.replicateM (bitLength @(Finite n)) go) . fromIntegral @_ @Natural + where go = do remaining <- get + let (d, r) = quotRem remaining 2 + put d >> pure (BT.Bit . toEnum . fromIntegral $ r) + +{-# INLINE outOfBits #-} +outOfBits :: forall (n :: Nat) . + (KnownNat n) => + VU.Vector BT.Bit -> Finite n +outOfBits v = evalState (VU.foldM' go 0 v) 1 + where go old (BT.Bit b) = do power <- get + let placeValue = power * (fromIntegral . fromEnum $ b) + modify (* 2) + return (old + placeValue)
src/Data/Finitary/PackBits/Unsafe.hs view
@@ -1,251 +1,250 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-}-{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}--{-# LANGUAGE ViewPatterns #-}-{-# LANGUAGE PatternSynonyms #-}-{-# LANGUAGE RoleAnnotations #-}-{-# LANGUAGE AllowAmbiguousTypes #-}-{-# LANGUAGE ScopedTypeVariables #-}-{-# LANGUAGE TypeInType #-}-{-# LANGUAGE TypeOperators #-}-{-# LANGUAGE TypeFamilies #-}-{-# LANGUAGE TypeApplications #-}-{-# LANGUAGE Trustworthy #-}-{-# LANGUAGE MultiParamTypeClasses #-}-{-# LANGUAGE UndecidableInstances #-}-{-# LANGUAGE StandaloneDeriving #-}-{-# LANGUAGE GeneralizedNewtypeDeriving #-}---- |--- Module: Data.Finitary.PackBits.Unsafe--- Description: Scheme for bit-packing @Finitary@ types.--- Copyright: (C) Koz Ross 2019--- License: GPL version 3.0 or later--- Maintainer: koz.ross@retro-freedom.nz--- Stability: Experimental--- Portability: GHC only------ From the [Kraft-McMillan--- inequality](https://en.wikipedia.org/wiki/Kraft%E2%80%93McMillan_inequality)--- and --- the fact that we are not able to have \'fractional\' bits, we can derive a--- fixed-length code into a bitstring for any 'Finitary' type @a@, with code--- length \(\lceil \log_{2}(\texttt{Cardinality a}) \rceil\) bits. This code is--- essentially a binary representation of the index of each inhabitant of @a@.--- On that basis, we can derive an 'VU.Unbox' instance, representing--- the entire 'VU.Vector' as an unboxed [bit--- array](https://en.wikipedia.org/wiki/Bit_array).------ This encoding is advantageous from the point of view of space - there is no--- tighter possible packing that preserves \(\Theta(1)\) random access and also--- allows the full range of 'VU.Vector' operations. If you are concerned about--- space usage above all, this is the best choice for you. ------ Because access to individual bits is slower than whole bytes or words, this--- encoding adds some overhead. Additionally, a primary advantage of bit arrays--- (the ability to perform \'bulk\' operations on bits efficiently) is not made--- use of here. Therefore, if speed matters more than compactness, this encoding--- is suboptimal.------ This encoding is __not__ thread-safe, in exchange for performance. If you--- suspect race conditions are possible, it's better to use--- "Data.Finitary.PackBits" instead.-module Data.Finitary.PackBits.Unsafe -(- PackBits, pattern Packed,- BulkPack, exposeVector-) where--import GHC.TypeLits.Extra-import Data.Proxy (Proxy(..))-import Numeric.Natural (Natural)-import GHC.TypeNats-import CoercibleUtils (op, over, over2)-import Data.Kind (Type)-import Data.Hashable (Hashable(..))-import Data.Vector.Instances ()-import Data.Vector.Binary ()-import Control.DeepSeq (NFData(..))-import Data.Finitary(Finitary(..))-import Data.Finite (Finite)-import Control.Monad.Trans.State.Strict (evalState, get, modify, put)-import Data.Semigroup (Dual(..))--import qualified Data.Binary as Bin-import qualified Data.Bit as B-import qualified Data.Vector.Generic as VG-import qualified Data.Vector.Generic.Mutable as VGM-import qualified Data.Vector.Unboxed as VU---- | An opaque wrapper around @a@, representing each value as a 'bit-packed'--- encoding.-newtype PackBits (a :: Type) = PackBits (VU.Vector B.Bit)- deriving (Eq, Show)--type role PackBits nominal---- | To provide (something that resembles a) data constructor for 'PackBits', we--- provide the following pattern. It can be used like any other data--- constructor:------ > import Data.Finitary.PackBits--- >--- > anInt :: PackBits Int--- > anInt = Packed 10--- >--- > isPackedEven :: PackBits Int -> Bool--- > isPackedEven (Packed x) = even x------ __Every__ pattern match, and data constructor call, performs a--- \(\Theta(\log_{2}(\texttt{Cardinality a}))\) encoding or decoding operation. --- Use with this in mind.-pattern Packed :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackBits a-pattern Packed x <- (unpackBits -> x)- where Packed x = packBits x--instance Ord (PackBits a) where- compare (PackBits v1) (PackBits v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2- where go input order = (order <>) . Dual . uncurry compare $ input--instance Bin.Binary (PackBits a) where- {-# INLINE put #-}- put = Bin.put . B.cloneToWords . op PackBits- {-# INLINE get #-}- get = PackBits . B.castFromWords <$> Bin.get--instance Hashable (PackBits a) where- {-# INLINE hashWithSalt #-}- hashWithSalt salt = hashWithSalt salt . B.cloneToWords . op PackBits--instance NFData (PackBits a) where- {-# INLINE rnf #-}- rnf = rnf . op PackBits--instance (Finitary a, 1 <= Cardinality a) => Finitary (PackBits a) where- type Cardinality (PackBits a) = Cardinality a- {-# INLINE fromFinite #-}- fromFinite = PackBits . intoBits- {-# INLINE toFinite #-}- toFinite = outOfBits . op PackBits--instance (Finitary a, 1 <= Cardinality a) => Bounded (PackBits a) where- {-# INLINE minBound #-}- minBound = start- {-# INLINE maxBound #-}- maxBound = end--newtype instance VU.MVector s (PackBits a) = MV_PackBits (VU.MVector s B.Bit)--instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackBits a) where- {-# INLINE basicLength #-}- basicLength = over MV_PackBits ((`div` bitLength @a) . VGM.basicLength)- {-# INLINE basicOverlaps #-}- basicOverlaps = over2 MV_PackBits VGM.basicOverlaps- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over MV_PackBits (VGM.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a))- {-# INLINE basicUnsafeNew #-}- basicUnsafeNew len = fmap MV_PackBits (VGM.basicUnsafeNew (len * bitLength @a))- {-# INLINE basicInitialize #-}- basicInitialize = VGM.basicInitialize . op MV_PackBits- {-# INLINE basicUnsafeRead #-}- basicUnsafeRead (MV_PackBits v) i = fmap PackBits . VG.freeze . VGM.unsafeSlice (i * bitLength @a) (bitLength @a) $ v- {-# INLINE basicUnsafeWrite #-}- basicUnsafeWrite (MV_PackBits v) i (PackBits x) = let slice = VGM.unsafeSlice (i * bitLength @a) (bitLength @a) v in- VG.unsafeCopy slice x--newtype instance VU.Vector (PackBits a) = V_PackBits (VU.Vector B.Bit)--instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackBits a) where- {-# INLINE basicLength #-}- basicLength = over V_PackBits ((`div` bitLength @a) . VG.basicLength)- {-# INLINE basicUnsafeFreeze #-}- basicUnsafeFreeze = fmap V_PackBits . VG.basicUnsafeFreeze . op MV_PackBits- {-# INLINE basicUnsafeThaw #-}- basicUnsafeThaw = fmap MV_PackBits . VG.basicUnsafeThaw . op V_PackBits- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over V_PackBits (VG.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a))- {-# INLINE basicUnsafeIndexM #-}- basicUnsafeIndexM (V_PackBits v) i = pure . PackBits . VG.unsafeSlice (i * bitLength @a) (bitLength @a) $ v--instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackBits a)---- | This wrapper provides an efficient 'Hashable' instance (hash the entire--- underlying bit-packed vector, rather than each element individually), as well--- as a 'Bin.Binary' instance (which stores or reads the entire blob of--- bits \'in one go\').-newtype BulkPack a = BulkPack { exposeVector :: VU.Vector (PackBits a) }- deriving (NFData)--deriving instance (Finitary a, 1 <= Cardinality a) => Eq (BulkPack a)--deriving instance (Finitary a, 1 <= Cardinality a) => Ord (BulkPack a)--instance Hashable (BulkPack a) where- {-# INLINE hashWithSalt #-}- hashWithSalt salt = hashWithSalt salt . B.cloneToWords . op V_PackBits . op BulkPack--instance Bin.Binary (BulkPack a) where- {-# INLINE put #-}- put = Bin.put . B.cloneToWords . op V_PackBits . op BulkPack- {-# INLINE get #-}- get = BulkPack . V_PackBits . B.castFromWords <$> Bin.get---- Helpers--type BitLength a = CLog 2 (Cardinality a)--{-# INLINE packBits #-}-packBits :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackBits a-packBits = fromFinite . toFinite--{-# INLINE unpackBits #-}-unpackBits :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - PackBits a -> a-unpackBits = fromFinite . toFinite--{-# INLINE bitLength #-}-bitLength :: forall (a :: Type) (b :: Type) . - (Finitary a, 1 <= Cardinality a, Num b) => - b-bitLength = fromIntegral . natVal $ (Proxy :: Proxy (BitLength a))--{-# INLINE intoBits #-}-intoBits :: forall (n :: Nat) .- (KnownNat n, 1 <= n) => - Finite n -> VU.Vector B.Bit-intoBits = evalState (VU.replicateM (bitLength @(Finite n)) go) . fromIntegral @_ @Natural- where go = do remaining <- get- let (d, r) = quotRem remaining 2- put d >> pure (B.Bit . toEnum . fromIntegral $ r)- -{-# INLINE outOfBits #-}-outOfBits :: forall (n :: Nat) .- (KnownNat n) => - VU.Vector B.Bit -> Finite n-outOfBits v = evalState (VU.foldM' go 0 v) 1- where go old (B.Bit b) = do power <- get- let placeValue = power * (fromIntegral . fromEnum $ b)- modify (* 2)- return (old + placeValue)+{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-} +{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-} + +{-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE RoleAnnotations #-} +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE Trustworthy #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE UndecidableInstances #-} +{-# LANGUAGE StandaloneDeriving #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +-- | +-- Module: Data.Finitary.PackBits.Unsafe +-- Description: Scheme for bit-packing @Finitary@ types. +-- Copyright: (C) Koz Ross 2019 +-- License: GPL version 3.0 or later +-- Stability: Experimental +-- Portability: GHC only +-- +-- From the [Kraft-McMillan +-- inequality](https://en.wikipedia.org/wiki/Kraft%E2%80%93McMillan_inequality) +-- and +-- the fact that we are not able to have \'fractional\' bits, we can derive a +-- fixed-length code into a bitstring for any 'Finitary' type @a@, with code +-- length \(\lceil \log_{2}(\texttt{Cardinality a}) \rceil\) bits. This code is +-- essentially a binary representation of the index of each inhabitant of @a@. +-- On that basis, we can derive an 'VU.Unbox' instance, representing +-- the entire 'VU.Vector' as an unboxed [bit +-- array](https://en.wikipedia.org/wiki/Bit_array). +-- +-- This encoding is advantageous from the point of view of space - there is no +-- tighter possible packing that preserves \(\Theta(1)\) random access and also +-- allows the full range of 'VU.Vector' operations. If you are concerned about +-- space usage above all, this is the best choice for you. +-- +-- Because access to individual bits is slower than whole bytes or words, this +-- encoding adds some overhead. Additionally, a primary advantage of bit arrays +-- (the ability to perform \'bulk\' operations on bits efficiently) is not made +-- use of here. Therefore, if speed matters more than compactness, this encoding +-- is suboptimal. +-- +-- This encoding is __not__ thread-safe, in exchange for performance. If you +-- suspect race conditions are possible, it's better to use +-- "Data.Finitary.PackBits" instead. +module Data.Finitary.PackBits.Unsafe +( + PackBits, pattern Packed, + BulkPack, exposeVector +) where + +import GHC.TypeLits.Extra +import Data.Proxy (Proxy(..)) +import Numeric.Natural (Natural) +import GHC.TypeNats +import CoercibleUtils (op, over, over2) +import Data.Kind (Type) +import Data.Hashable (Hashable(..)) +import Data.Vector.Instances () +import Data.Vector.Binary () +import Control.DeepSeq (NFData(..)) +import Data.Finitary(Finitary(..)) +import Data.Finite (Finite) +import Control.Monad.Trans.State.Strict (evalState, get, modify, put) +import Data.Semigroup (Dual(..)) + +import qualified Data.Binary as Bin +import qualified Data.Bit as B +import qualified Data.Vector.Generic as VG +import qualified Data.Vector.Generic.Mutable as VGM +import qualified Data.Vector.Unboxed as VU + +-- | An opaque wrapper around @a@, representing each value as a 'bit-packed' +-- encoding. +newtype PackBits (a :: Type) = PackBits (VU.Vector B.Bit) + deriving (Eq, Show) + +type role PackBits nominal + +-- | To provide (something that resembles a) data constructor for 'PackBits', we +-- provide the following pattern. It can be used like any other data +-- constructor: +-- +-- > import Data.Finitary.PackBits +-- > +-- > anInt :: PackBits Int +-- > anInt = Packed 10 +-- > +-- > isPackedEven :: PackBits Int -> Bool +-- > isPackedEven (Packed x) = even x +-- +-- __Every__ pattern match, and data constructor call, performs a +-- \(\Theta(\log_{2}(\texttt{Cardinality a}))\) encoding or decoding operation. +-- Use with this in mind. +pattern Packed :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackBits a +pattern Packed x <- (unpackBits -> x) + where Packed x = packBits x + +instance Ord (PackBits a) where + compare (PackBits v1) (PackBits v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2 + where go input order = (order <>) . Dual . uncurry compare $ input + +instance Bin.Binary (PackBits a) where + {-# INLINE put #-} + put = Bin.put . B.cloneToWords . op PackBits + {-# INLINE get #-} + get = PackBits . B.castFromWords <$> Bin.get + +instance Hashable (PackBits a) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = hashWithSalt salt . B.cloneToWords . op PackBits + +instance NFData (PackBits a) where + {-# INLINE rnf #-} + rnf = rnf . op PackBits + +instance (Finitary a, 1 <= Cardinality a) => Finitary (PackBits a) where + type Cardinality (PackBits a) = Cardinality a + {-# INLINE fromFinite #-} + fromFinite = PackBits . intoBits + {-# INLINE toFinite #-} + toFinite = outOfBits . op PackBits + +instance (Finitary a, 1 <= Cardinality a) => Bounded (PackBits a) where + {-# INLINE minBound #-} + minBound = start + {-# INLINE maxBound #-} + maxBound = end + +newtype instance VU.MVector s (PackBits a) = MV_PackBits (VU.MVector s B.Bit) + +instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackBits a) where + {-# INLINE basicLength #-} + basicLength = over MV_PackBits ((`div` bitLength @a) . VGM.basicLength) + {-# INLINE basicOverlaps #-} + basicOverlaps = over2 MV_PackBits VGM.basicOverlaps + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over MV_PackBits (VGM.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a)) + {-# INLINE basicUnsafeNew #-} + basicUnsafeNew len = fmap MV_PackBits (VGM.basicUnsafeNew (len * bitLength @a)) + {-# INLINE basicInitialize #-} + basicInitialize = VGM.basicInitialize . op MV_PackBits + {-# INLINE basicUnsafeRead #-} + basicUnsafeRead (MV_PackBits v) i = fmap PackBits . VG.freeze . VGM.unsafeSlice (i * bitLength @a) (bitLength @a) $ v + {-# INLINE basicUnsafeWrite #-} + basicUnsafeWrite (MV_PackBits v) i (PackBits x) = let slice = VGM.unsafeSlice (i * bitLength @a) (bitLength @a) v in + VG.unsafeCopy slice x + +newtype instance VU.Vector (PackBits a) = V_PackBits (VU.Vector B.Bit) + +instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackBits a) where + {-# INLINE basicLength #-} + basicLength = over V_PackBits ((`div` bitLength @a) . VG.basicLength) + {-# INLINE basicUnsafeFreeze #-} + basicUnsafeFreeze = fmap V_PackBits . VG.basicUnsafeFreeze . op MV_PackBits + {-# INLINE basicUnsafeThaw #-} + basicUnsafeThaw = fmap MV_PackBits . VG.basicUnsafeThaw . op V_PackBits + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over V_PackBits (VG.basicUnsafeSlice (i * bitLength @a) (len * bitLength @a)) + {-# INLINE basicUnsafeIndexM #-} + basicUnsafeIndexM (V_PackBits v) i = pure . PackBits . VG.unsafeSlice (i * bitLength @a) (bitLength @a) $ v + +instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackBits a) + +-- | This wrapper provides an efficient 'Hashable' instance (hash the entire +-- underlying bit-packed vector, rather than each element individually), as well +-- as a 'Bin.Binary' instance (which stores or reads the entire blob of +-- bits \'in one go\'). +newtype BulkPack a = BulkPack { exposeVector :: VU.Vector (PackBits a) } + deriving (NFData) + +deriving instance (Finitary a, 1 <= Cardinality a) => Eq (BulkPack a) + +deriving instance (Finitary a, 1 <= Cardinality a) => Ord (BulkPack a) + +instance Hashable (BulkPack a) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = hashWithSalt salt . B.cloneToWords . op V_PackBits . op BulkPack + +instance Bin.Binary (BulkPack a) where + {-# INLINE put #-} + put = Bin.put . B.cloneToWords . op V_PackBits . op BulkPack + {-# INLINE get #-} + get = BulkPack . V_PackBits . B.castFromWords <$> Bin.get + +-- Helpers + +type BitLength a = CLog 2 (Cardinality a) + +{-# INLINE packBits #-} +packBits :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackBits a +packBits = fromFinite . toFinite + +{-# INLINE unpackBits #-} +unpackBits :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + PackBits a -> a +unpackBits = fromFinite . toFinite + +{-# INLINE bitLength #-} +bitLength :: forall (a :: Type) (b :: Type) . + (Finitary a, 1 <= Cardinality a, Num b) => + b +bitLength = fromIntegral . natVal $ (Proxy :: Proxy (BitLength a)) + +{-# INLINE intoBits #-} +intoBits :: forall (n :: Nat) . + (KnownNat n, 1 <= n) => + Finite n -> VU.Vector B.Bit +intoBits = evalState (VU.replicateM (bitLength @(Finite n)) go) . fromIntegral @_ @Natural + where go = do remaining <- get + let (d, r) = quotRem remaining 2 + put d >> pure (B.Bit . toEnum . fromIntegral $ r) + +{-# INLINE outOfBits #-} +outOfBits :: forall (n :: Nat) . + (KnownNat n) => + VU.Vector B.Bit -> Finite n +outOfBits v = evalState (VU.foldM' go 0 v) 1 + where go old (B.Bit b) = do power <- get + let placeValue = power * (fromIntegral . fromEnum $ b) + modify (* 2) + return (old + placeValue)
src/Data/Finitary/PackBytes.hs view
@@ -1,233 +1,232 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-}-{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}--{-# LANGUAGE AllowAmbiguousTypes #-}-{-# LANGUAGE ScopedTypeVariables #-}-{-# LANGUAGE RoleAnnotations #-}-{-# LANGUAGE Trustworthy #-}-{-# LANGUAGE TypeInType #-}-{-# LANGUAGE TypeFamilies #-}-{-# LANGUAGE TypeApplications #-}-{-# LANGUAGE PatternSynonyms #-}-{-# LANGUAGE ViewPatterns #-}-{-# LANGUAGE MultiParamTypeClasses #-}-{-# LANGUAGE TypeOperators #-}---- |--- Module: Data.Finitary.PackBytes--- Description: Scheme for byte-packing @Finitary@ types.--- Copyright: (C) Koz Ross 2019--- License: GPL version 3.0 or later--- Maintainer: koz.ross@retro-freedom.nz--- Stability: Experimental--- Portability: GHC only------ If a type @a@ is 'Finitary', each inhabitant of @a@ has an index, which can--- be represented as a byte string of a fixed length (as the number of indexes--- is finite). Essentially, we can represent any value of @a@ as a fixed-length--- string over an alphabet of cardinality \(256\). Based on this, we can derive--- a 'VU.Unbox' instance, representing a 'VU.Vector' as a large byte string.--- This also allows us to provide a 'Storable' instance for @a@.------ This encoding is fairly tight in terms of space use, especially for types--- whose cardinalities are large. Additionally, byte-access is considerably--- faster than bit-access on most architectures. If your types have large--- cardinalities, and minimal space use isn't a concern, this encoding is good.------ Some architectures prefer whole-word access - on these, there can be some--- overheads using this encoding. Additionally, the encoding and decoding step--- for this encoding is longer than the one for "Data.Finitary.PackWords". If --- @Cardinality a < Cardinality Word@, you should --- consider a different encoding - in particular, check "Data.Finitary.PackInto", --- which is more flexible and faster, with greater control over space usage.-module Data.Finitary.PackBytes -(- PackBytes, pattern Packed-) where--import Data.Proxy (Proxy(..))-import GHC.TypeLits.Extra-import GHC.TypeNats-import CoercibleUtils (op, over, over2)-import Data.Kind (Type)-import Data.Word (Word8)-import Data.Vector.Binary ()-import Data.Vector.Instances ()-import Data.Hashable (Hashable(..))-import Control.DeepSeq (NFData(..))-import Data.Finitary (Finitary(..))-import Foreign.Storable (Storable(..))-import Foreign.Ptr (castPtr, plusPtr)-import Numeric.Natural (Natural)-import Data.Finite (Finite)-import Control.Monad.Trans.State.Strict (evalState, get, modify, put)-import Data.Semigroup (Dual(..))--import qualified Data.Binary as Bin-import qualified Data.Vector.Unboxed as VU-import qualified Data.Vector.Generic as VG-import qualified Data.Vector.Generic.Mutable as VGM---- | An opaque wrapper around @a@, representing each value as a byte string.-newtype PackBytes (a :: Type) = PackBytes (VU.Vector Word8)- deriving (Eq, Show)--type role PackBytes nominal---- | To provide (something that resembles a) data constructor for 'PackBytes', we--- provide the following pattern. It can be used like any other data--- constructor:------ > import Data.Finitary.PackBytes--- >--- > anInt :: PackBytes Int--- > anInt = Packed 10--- >--- > isPackedEven :: PackBytes Int -> Bool--- > isPackedEven (Packed x) = even x------ __Every__ pattern match, and data constructor call, performs a--- \(\Theta(\log_{256}(\texttt{Cardinality a}))\) encoding or decoding of @a@.--- Use with this in mind.-pattern Packed :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackBytes a-pattern Packed x <- (unpackBytes -> x)- where Packed x = packBytes x--instance Ord (PackBytes a) where- compare (PackBytes v1) (PackBytes v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2- where go input order = (order <>) . Dual . uncurry compare $ input--instance Bin.Binary (PackBytes a) where- {-# INLINE put #-}- put = Bin.put . op PackBytes- {-# INLINE get #-}- get = PackBytes <$> Bin.get--instance Hashable (PackBytes a) where- {-# INLINE hashWithSalt #-}- hashWithSalt salt = hashWithSalt salt . op PackBytes--instance NFData (PackBytes a) where- {-# INLINE rnf #-}- rnf = rnf . op PackBytes--instance (Finitary a, 1 <= Cardinality a) => Finitary (PackBytes a) where- type Cardinality (PackBytes a) = Cardinality a- {-# INLINE fromFinite #-}- fromFinite = PackBytes . intoBytes- {-# INLINE toFinite #-}- toFinite = outOfBytes . op PackBytes--instance (Finitary a, 1 <= Cardinality a) => Bounded (PackBytes a) where- {-# INLINE minBound #-}- minBound = start- {-# INLINE maxBound #-}- maxBound = end--instance (Finitary a, 1 <= Cardinality a) => Storable (PackBytes a) where- {-# INLINE sizeOf #-}- sizeOf _ = byteLength @a- {-# INLINE alignment #-}- alignment _ = alignment (undefined :: Word8)- {-# INLINE peek #-}- peek ptr = do let bytePtr = castPtr ptr- PackBytes <$> VU.generateM (byteLength @a) (peek . plusPtr bytePtr)- {-# INLINE poke #-}- poke ptr (PackBytes v) = do let bytePtr = castPtr ptr- VU.foldM'_ go bytePtr v- where go p e = poke p e >> pure (plusPtr p 1)--newtype instance VU.MVector s (PackBytes a) = MV_PackBytes (VU.MVector s Word8)--instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackBytes a) where- {-# INLINE basicLength #-}- basicLength = over MV_PackBytes ((`div` byteLength @a) . VGM.basicLength)- {-# INLINE basicOverlaps #-}- basicOverlaps = over2 MV_PackBytes VGM.basicOverlaps- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over MV_PackBytes (VGM.basicUnsafeSlice (i * byteLength @a) (len * byteLength @a))- {-# INLINE basicUnsafeNew #-}- basicUnsafeNew len = MV_PackBytes <$> VGM.basicUnsafeNew (len * byteLength @a)- {-# INLINE basicInitialize #-}- basicInitialize = VGM.basicInitialize . op MV_PackBytes- {-# INLINE basicUnsafeRead #-}- basicUnsafeRead (MV_PackBytes v) i = fmap PackBytes . VG.freeze . VGM.unsafeSlice (i * byteLength @a) (byteLength @a) $ v- {-# INLINE basicUnsafeWrite #-}- basicUnsafeWrite (MV_PackBytes v) i (PackBytes x) = let slice = VGM.unsafeSlice (i * byteLength @a) (byteLength @a) v in- VG.unsafeCopy slice x--newtype instance VU.Vector (PackBytes a) = V_PackBytes (VU.Vector Word8)--instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackBytes a) where- {-# INLINE basicLength #-}- basicLength = over V_PackBytes ((`div` byteLength @a) . VG.basicLength)- {-# INLINE basicUnsafeFreeze #-}- basicUnsafeFreeze = fmap V_PackBytes . VG.basicUnsafeFreeze . op MV_PackBytes- {-# INLINE basicUnsafeThaw #-} - basicUnsafeThaw = fmap MV_PackBytes . VG.basicUnsafeThaw . op V_PackBytes- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over V_PackBytes (VG.basicUnsafeSlice (i * byteLength @a) (len * byteLength @a))- {-# INLINE basicUnsafeIndexM #-}- basicUnsafeIndexM (V_PackBytes v) i = pure . PackBytes . VG.unsafeSlice (i * byteLength @a) (byteLength @a) $ v--instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackBytes a)---- Helpers--type ByteLength a = CLog (Cardinality Word8) (Cardinality a)--{-# INLINE byteLength #-}-byteLength :: forall (a :: Type) (b :: Type) . - (Finitary a, 1 <= Cardinality a, Num b) =>- b-byteLength = fromIntegral . natVal $ (Proxy :: Proxy (ByteLength a)) --{-# INLINE packBytes #-}-packBytes :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackBytes a-packBytes = fromFinite . toFinite--{-# INLINE unpackBytes #-}-unpackBytes :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - PackBytes a -> a-unpackBytes = fromFinite . toFinite--{-# INLINE intoBytes #-}-intoBytes :: forall (n :: Nat) . - (KnownNat n, 1 <= n) => - Finite n -> VU.Vector Word8-intoBytes = evalState (VU.replicateM (byteLength @(Finite n)) go) . fromIntegral @_ @Natural- where go = do remaining <- get- let (d, r) = quotRem remaining 256- put d >> pure (fromIntegral r)--{-# INLINE outOfBytes #-}-outOfBytes :: forall (n :: Nat) . - (KnownNat n) =>- VU.Vector Word8 -> Finite n-outOfBytes v = evalState (VU.foldM' go 0 v) 1- where go old w = do power <- get- let placeValue = power * fromIntegral w- modify (* 256)- return (old + placeValue) +{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-} +{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-} + +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE RoleAnnotations #-} +{-# LANGUAGE Trustworthy #-} +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE TypeOperators #-} + +-- | +-- Module: Data.Finitary.PackBytes +-- Description: Scheme for byte-packing @Finitary@ types. +-- Copyright: (C) Koz Ross 2019 +-- License: GPL version 3.0 or later +-- Stability: Experimental +-- Portability: GHC only +-- +-- If a type @a@ is 'Finitary', each inhabitant of @a@ has an index, which can +-- be represented as a byte string of a fixed length (as the number of indexes +-- is finite). Essentially, we can represent any value of @a@ as a fixed-length +-- string over an alphabet of cardinality \(256\). Based on this, we can derive +-- a 'VU.Unbox' instance, representing a 'VU.Vector' as a large byte string. +-- This also allows us to provide a 'Storable' instance for @a@. +-- +-- This encoding is fairly tight in terms of space use, especially for types +-- whose cardinalities are large. Additionally, byte-access is considerably +-- faster than bit-access on most architectures. If your types have large +-- cardinalities, and minimal space use isn't a concern, this encoding is good. +-- +-- Some architectures prefer whole-word access - on these, there can be some +-- overheads using this encoding. Additionally, the encoding and decoding step +-- for this encoding is longer than the one for "Data.Finitary.PackWords". If +-- @Cardinality a < Cardinality Word@, you should +-- consider a different encoding - in particular, check "Data.Finitary.PackInto", +-- which is more flexible and faster, with greater control over space usage. +module Data.Finitary.PackBytes +( + PackBytes, pattern Packed +) where + +import Data.Proxy (Proxy(..)) +import GHC.TypeLits.Extra +import GHC.TypeNats +import CoercibleUtils (op, over, over2) +import Data.Kind (Type) +import Data.Word (Word8) +import Data.Vector.Binary () +import Data.Vector.Instances () +import Data.Hashable (Hashable(..)) +import Control.DeepSeq (NFData(..)) +import Data.Finitary (Finitary(..)) +import Foreign.Storable (Storable(..)) +import Foreign.Ptr (castPtr, plusPtr) +import Numeric.Natural (Natural) +import Data.Finite (Finite) +import Control.Monad.Trans.State.Strict (evalState, get, modify, put) +import Data.Semigroup (Dual(..)) + +import qualified Data.Binary as Bin +import qualified Data.Vector.Unboxed as VU +import qualified Data.Vector.Generic as VG +import qualified Data.Vector.Generic.Mutable as VGM + +-- | An opaque wrapper around @a@, representing each value as a byte string. +newtype PackBytes (a :: Type) = PackBytes (VU.Vector Word8) + deriving (Eq, Show) + +type role PackBytes nominal + +-- | To provide (something that resembles a) data constructor for 'PackBytes', we +-- provide the following pattern. It can be used like any other data +-- constructor: +-- +-- > import Data.Finitary.PackBytes +-- > +-- > anInt :: PackBytes Int +-- > anInt = Packed 10 +-- > +-- > isPackedEven :: PackBytes Int -> Bool +-- > isPackedEven (Packed x) = even x +-- +-- __Every__ pattern match, and data constructor call, performs a +-- \(\Theta(\log_{256}(\texttt{Cardinality a}))\) encoding or decoding of @a@. +-- Use with this in mind. +pattern Packed :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackBytes a +pattern Packed x <- (unpackBytes -> x) + where Packed x = packBytes x + +instance Ord (PackBytes a) where + compare (PackBytes v1) (PackBytes v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2 + where go input order = (order <>) . Dual . uncurry compare $ input + +instance Bin.Binary (PackBytes a) where + {-# INLINE put #-} + put = Bin.put . op PackBytes + {-# INLINE get #-} + get = PackBytes <$> Bin.get + +instance Hashable (PackBytes a) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = hashWithSalt salt . op PackBytes + +instance NFData (PackBytes a) where + {-# INLINE rnf #-} + rnf = rnf . op PackBytes + +instance (Finitary a, 1 <= Cardinality a) => Finitary (PackBytes a) where + type Cardinality (PackBytes a) = Cardinality a + {-# INLINE fromFinite #-} + fromFinite = PackBytes . intoBytes + {-# INLINE toFinite #-} + toFinite = outOfBytes . op PackBytes + +instance (Finitary a, 1 <= Cardinality a) => Bounded (PackBytes a) where + {-# INLINE minBound #-} + minBound = start + {-# INLINE maxBound #-} + maxBound = end + +instance (Finitary a, 1 <= Cardinality a) => Storable (PackBytes a) where + {-# INLINE sizeOf #-} + sizeOf _ = byteLength @a + {-# INLINE alignment #-} + alignment _ = alignment (undefined :: Word8) + {-# INLINE peek #-} + peek ptr = do let bytePtr = castPtr ptr + PackBytes <$> VU.generateM (byteLength @a) (peek . plusPtr bytePtr) + {-# INLINE poke #-} + poke ptr (PackBytes v) = do let bytePtr = castPtr ptr + VU.foldM'_ go bytePtr v + where go p e = poke p e >> pure (plusPtr p 1) + +newtype instance VU.MVector s (PackBytes a) = MV_PackBytes (VU.MVector s Word8) + +instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackBytes a) where + {-# INLINE basicLength #-} + basicLength = over MV_PackBytes ((`div` byteLength @a) . VGM.basicLength) + {-# INLINE basicOverlaps #-} + basicOverlaps = over2 MV_PackBytes VGM.basicOverlaps + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over MV_PackBytes (VGM.basicUnsafeSlice (i * byteLength @a) (len * byteLength @a)) + {-# INLINE basicUnsafeNew #-} + basicUnsafeNew len = MV_PackBytes <$> VGM.basicUnsafeNew (len * byteLength @a) + {-# INLINE basicInitialize #-} + basicInitialize = VGM.basicInitialize . op MV_PackBytes + {-# INLINE basicUnsafeRead #-} + basicUnsafeRead (MV_PackBytes v) i = fmap PackBytes . VG.freeze . VGM.unsafeSlice (i * byteLength @a) (byteLength @a) $ v + {-# INLINE basicUnsafeWrite #-} + basicUnsafeWrite (MV_PackBytes v) i (PackBytes x) = let slice = VGM.unsafeSlice (i * byteLength @a) (byteLength @a) v in + VG.unsafeCopy slice x + +newtype instance VU.Vector (PackBytes a) = V_PackBytes (VU.Vector Word8) + +instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackBytes a) where + {-# INLINE basicLength #-} + basicLength = over V_PackBytes ((`div` byteLength @a) . VG.basicLength) + {-# INLINE basicUnsafeFreeze #-} + basicUnsafeFreeze = fmap V_PackBytes . VG.basicUnsafeFreeze . op MV_PackBytes + {-# INLINE basicUnsafeThaw #-} + basicUnsafeThaw = fmap MV_PackBytes . VG.basicUnsafeThaw . op V_PackBytes + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over V_PackBytes (VG.basicUnsafeSlice (i * byteLength @a) (len * byteLength @a)) + {-# INLINE basicUnsafeIndexM #-} + basicUnsafeIndexM (V_PackBytes v) i = pure . PackBytes . VG.unsafeSlice (i * byteLength @a) (byteLength @a) $ v + +instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackBytes a) + +-- Helpers + +type ByteLength a = CLog (Cardinality Word8) (Cardinality a) + +{-# INLINE byteLength #-} +byteLength :: forall (a :: Type) (b :: Type) . + (Finitary a, 1 <= Cardinality a, Num b) => + b +byteLength = fromIntegral . natVal $ (Proxy :: Proxy (ByteLength a)) + +{-# INLINE packBytes #-} +packBytes :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackBytes a +packBytes = fromFinite . toFinite + +{-# INLINE unpackBytes #-} +unpackBytes :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + PackBytes a -> a +unpackBytes = fromFinite . toFinite + +{-# INLINE intoBytes #-} +intoBytes :: forall (n :: Nat) . + (KnownNat n, 1 <= n) => + Finite n -> VU.Vector Word8 +intoBytes = evalState (VU.replicateM (byteLength @(Finite n)) go) . fromIntegral @_ @Natural + where go = do remaining <- get + let (d, r) = quotRem remaining 256 + put d >> pure (fromIntegral r) + +{-# INLINE outOfBytes #-} +outOfBytes :: forall (n :: Nat) . + (KnownNat n) => + VU.Vector Word8 -> Finite n +outOfBytes v = evalState (VU.foldM' go 0 v) 1 + where go old w = do power <- get + let placeValue = power * fromIntegral w + modify (* 256) + return (old + placeValue)
src/Data/Finitary/PackInto.hs view
@@ -1,197 +1,196 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# LANGUAGE RoleAnnotations #-}-{-# LANGUAGE TypeInType #-}-{-# LANGUAGE TypeFamilies #-}-{-# LANGUAGE TypeOperators #-}-{-# LANGUAGE MultiParamTypeClasses #-}-{-# LANGUAGE ScopedTypeVariables #-}-{-# LANGUAGE ViewPatterns #-}-{-# LANGUAGE PatternSynonyms #-}-{-# LANGUAGE TypeApplications #-}---- |--- Module: Data.Finitary.PackInto--- Description: Scheme for packing @Finitary@ types into other @Finitary@--- types.--- Copyright: (C) Koz Ross 2019--- License: GPL version 3.0 or later--- Maintainer: koz.ross@retro-freedom.nz--- Stability: Experimental--- Portability: GHC only------ This allows us to \'borrow\' implementations of certain type classes from--- \'larger\' finitary types for \'smaller\' finitary types. Essentially, for--- any types @a@ and @b@, if both @a@ and @b@ are 'Finitary' and @Cardinality a--- <= Cardinality b@, the set of indexes for @a@ is a subset (strictly speaking,--- a prefix) of the set of indexes for @b@. Therefore, we have an injective--- mapping from @a@ to @b@, whose--- [preimage](https://en.wikipedia.org/wiki/Preimage)--- is also injective, witnessed by the function @fromFinite . toFinite@ in both--- directions. When combined with the monotonicity of @toFinite@ and--- @fromFinite@, we can operate on inhabitants of @b@ in certain ways while--- always being able to recover the \'equivalent\' inhabitant of @a@.------ On this basis, we can \'borrow\' both 'VU.Unbox' and 'Storable' instances--- from @b@. This is done by way of the @PackInto a b@ type; here, @a@ is the--- type to which instances are being \'lent\' and @b@ is the type from which--- instances are being \'borrowed\'. @PackInto a b@ does not store any values of--- type @a@ - construction and deconstruction of @PackInto@ performs a--- conversion as described above.------ If an existing 'Finitary' type exists with desired instances, this encoding--- is the most flexible and efficient. Unless you have good reasons to consider--- something else (such as space use), use this encoding. However, its--- usefulness is conditional on a suitable \'packing\' type existing of--- appropriate cardinality. Additionally, if @Cardinality a < Cardinality b@,--- any @PackInto a b@ will waste some space, with larger cardinality differences--- creating proportionately more waste.-module Data.Finitary.PackInto -(- PackInto, pattern Packed-) where--import GHC.TypeNats-import Data.Vector.Instances ()-import Data.Kind (Type)-import CoercibleUtils (op, over, over2)-import Data.Hashable (Hashable(..))-import Control.DeepSeq (NFData(..))-import Foreign.Storable (Storable(..))-import Foreign.Ptr (castPtr)-import Data.Finitary (Finitary(..))-import Data.Finite (weakenN, strengthenN)-import Data.Maybe (fromJust)-import Data.Ord (comparing)--import qualified Data.Vector.Unboxed as VU-import qualified Data.Vector.Generic as VG-import qualified Data.Vector.Generic.Mutable as VGM---- | An opaque wrapper, representing values of type @a@ as \'corresponding\'--- values of type @b@.-newtype PackInto (a :: Type) (b :: Type) = PackInto b- deriving (Eq, Show)--type role PackInto nominal nominal---- | To provide (something that resembles a) data constructor for 'PackInto', we--- provide the following pattern. It can be used like any other data--- constructor:------ > import Data.Finitary.PackInt--- >--- > anInt :: PackInto Int Word--- > anInt = Packed 10--- >--- > isPackedEven :: PackInto Int Word -> Bool--- > isPackedEven (Packed x) = even x------ __Every__ pattern match, and data constructor call, performs a re-encoding by--- way of @fromFinite . toFinite@ on @b@ and @a@ respectively. Use with this in--- mind.-pattern Packed :: forall (b :: Type) (a :: Type) . - (Finitary a, Finitary b, Cardinality a <= Cardinality b) =>- a -> PackInto a b-pattern Packed x <- (unpackOutOf -> x)- where Packed x = packInto x--instance (Ord a, Finitary a, Finitary b, Cardinality a <= Cardinality b) => Ord (PackInto a b) where- {-# INLINE compare #-}- compare = comparing @a (fromFinite . toFinite)--instance (Hashable b) => Hashable (PackInto a b) where- {-# INLINE hashWithSalt #-}- hashWithSalt salt = over PackInto (hashWithSalt salt)--instance (NFData b) => NFData (PackInto a b) where- {-# INLINE rnf #-}- rnf = over PackInto rnf--instance (Storable b) => Storable (PackInto a b) where- {-# INLINE sizeOf #-}- sizeOf = over PackInto sizeOf- {-# INLINE alignment #-}- alignment = over PackInto alignment- {-# INLINE peek #-}- peek = fmap PackInto . peek . castPtr- {-# INLINE poke #-}- poke ptr = poke (castPtr ptr) . op PackInto---- We can pack a into b if the cardinality of b is at least as large as a (could--- be larger)-instance (Finitary a, Finitary b, Cardinality a <= Cardinality b) => Finitary (PackInto a b) where- type Cardinality (PackInto a b) = Cardinality a- {-# INLINE fromFinite #-}- fromFinite = PackInto . fromFinite . weakenN- {-# INLINE toFinite #-}- toFinite = fromJust . strengthenN . toFinite . op PackInto--instance (Finitary a, Finitary b, 1 <= Cardinality a, Cardinality a <= Cardinality b) => Bounded (PackInto a b) where- {-# INLINE minBound #-}- minBound = start- {-# INLINE maxBound #-}- maxBound = end --newtype instance VU.MVector s (PackInto a b) = MV_PackInto (VU.MVector s b)--instance (VU.Unbox b) => VGM.MVector VU.MVector (PackInto a b) where- {-# INLINE basicLength #-}- basicLength = over MV_PackInto VGM.basicLength- {-# INLINE basicOverlaps #-}- basicOverlaps = over2 MV_PackInto VGM.basicOverlaps- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over MV_PackInto (VGM.basicUnsafeSlice i len)- {-# INLINE basicUnsafeNew #-}- basicUnsafeNew len = MV_PackInto <$> VGM.basicUnsafeNew len- {-# INLINE basicInitialize #-}- basicInitialize = VGM.basicInitialize . op MV_PackInto- {-# INLINE basicUnsafeRead #-}- basicUnsafeRead (MV_PackInto v) i = PackInto <$> VGM.basicUnsafeRead v i- {-# INLINE basicUnsafeWrite #-}- basicUnsafeWrite (MV_PackInto v) i (PackInto x) = VGM.basicUnsafeWrite v i x--newtype instance VU.Vector (PackInto a b) = V_PackInto (VU.Vector b)--instance (VU.Unbox b) => VG.Vector VU.Vector (PackInto a b) where- {-# INLINE basicLength #-}- basicLength = over V_PackInto VG.basicLength- {-# INLINE basicUnsafeFreeze #-}- basicUnsafeFreeze = fmap V_PackInto . VG.basicUnsafeFreeze . op MV_PackInto- {-# INLINE basicUnsafeThaw #-}- basicUnsafeThaw = fmap MV_PackInto . VG.basicUnsafeThaw . op V_PackInto- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over V_PackInto (VG.basicUnsafeSlice i len)- {-# INLINE basicUnsafeIndexM #-}- basicUnsafeIndexM (V_PackInto v) i = PackInto <$> VG.basicUnsafeIndexM v i--instance (VU.Unbox b) => VU.Unbox (PackInto a b)---- Helpers--{-# INLINE packInto #-}-packInto :: forall (b :: Type) (a :: Type) .- (Finitary a, Finitary b, Cardinality a <= Cardinality b) => - a -> PackInto a b-packInto = fromFinite . toFinite--{-# INLINE unpackOutOf #-}-unpackOutOf :: forall (b :: Type) (a :: Type) . - (Finitary a, Finitary b, Cardinality a <= Cardinality b) => - PackInto a b -> a-unpackOutOf = fromFinite . toFinite+{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# LANGUAGE RoleAnnotations #-} +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE TypeApplications #-} + +-- | +-- Module: Data.Finitary.PackInto +-- Description: Scheme for packing @Finitary@ types into other @Finitary@ +-- types. +-- Copyright: (C) Koz Ross 2019 +-- License: GPL version 3.0 or later +-- Stability: Experimental +-- Portability: GHC only +-- +-- This allows us to \'borrow\' implementations of certain type classes from +-- \'larger\' finitary types for \'smaller\' finitary types. Essentially, for +-- any types @a@ and @b@, if both @a@ and @b@ are 'Finitary' and @Cardinality a +-- <= Cardinality b@, the set of indexes for @a@ is a subset (strictly speaking, +-- a prefix) of the set of indexes for @b@. Therefore, we have an injective +-- mapping from @a@ to @b@, whose +-- [preimage](https://en.wikipedia.org/wiki/Preimage) +-- is also injective, witnessed by the function @fromFinite . toFinite@ in both +-- directions. When combined with the monotonicity of @toFinite@ and +-- @fromFinite@, we can operate on inhabitants of @b@ in certain ways while +-- always being able to recover the \'equivalent\' inhabitant of @a@. +-- +-- On this basis, we can \'borrow\' both 'VU.Unbox' and 'Storable' instances +-- from @b@. This is done by way of the @PackInto a b@ type; here, @a@ is the +-- type to which instances are being \'lent\' and @b@ is the type from which +-- instances are being \'borrowed\'. @PackInto a b@ does not store any values of +-- type @a@ - construction and deconstruction of @PackInto@ performs a +-- conversion as described above. +-- +-- If an existing 'Finitary' type exists with desired instances, this encoding +-- is the most flexible and efficient. Unless you have good reasons to consider +-- something else (such as space use), use this encoding. However, its +-- usefulness is conditional on a suitable \'packing\' type existing of +-- appropriate cardinality. Additionally, if @Cardinality a < Cardinality b@, +-- any @PackInto a b@ will waste some space, with larger cardinality differences +-- creating proportionately more waste. +module Data.Finitary.PackInto +( + PackInto, pattern Packed +) where + +import GHC.TypeNats +import Data.Vector.Instances () +import Data.Kind (Type) +import CoercibleUtils (op, over, over2) +import Data.Hashable (Hashable(..)) +import Control.DeepSeq (NFData(..)) +import Foreign.Storable (Storable(..)) +import Foreign.Ptr (castPtr) +import Data.Finitary (Finitary(..)) +import Data.Finite (weakenN, strengthenN) +import Data.Maybe (fromJust) +import Data.Ord (comparing) + +import qualified Data.Vector.Unboxed as VU +import qualified Data.Vector.Generic as VG +import qualified Data.Vector.Generic.Mutable as VGM + +-- | An opaque wrapper, representing values of type @a@ as \'corresponding\' +-- values of type @b@. +newtype PackInto (a :: Type) (b :: Type) = PackInto b + deriving (Eq, Show) + +type role PackInto nominal nominal + +-- | To provide (something that resembles a) data constructor for 'PackInto', we +-- provide the following pattern. It can be used like any other data +-- constructor: +-- +-- > import Data.Finitary.PackInt +-- > +-- > anInt :: PackInto Int Word +-- > anInt = Packed 10 +-- > +-- > isPackedEven :: PackInto Int Word -> Bool +-- > isPackedEven (Packed x) = even x +-- +-- __Every__ pattern match, and data constructor call, performs a re-encoding by +-- way of @fromFinite . toFinite@ on @b@ and @a@ respectively. Use with this in +-- mind. +pattern Packed :: forall (b :: Type) (a :: Type) . + (Finitary a, Finitary b, Cardinality a <= Cardinality b) => + a -> PackInto a b +pattern Packed x <- (unpackOutOf -> x) + where Packed x = packInto x + +instance (Ord a, Finitary a, Finitary b, Cardinality a <= Cardinality b) => Ord (PackInto a b) where + {-# INLINE compare #-} + compare = comparing @a (fromFinite . toFinite) + +instance (Hashable b) => Hashable (PackInto a b) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = over PackInto (hashWithSalt salt) + +instance (NFData b) => NFData (PackInto a b) where + {-# INLINE rnf #-} + rnf = over PackInto rnf + +instance (Storable b) => Storable (PackInto a b) where + {-# INLINE sizeOf #-} + sizeOf = over PackInto sizeOf + {-# INLINE alignment #-} + alignment = over PackInto alignment + {-# INLINE peek #-} + peek = fmap PackInto . peek . castPtr + {-# INLINE poke #-} + poke ptr = poke (castPtr ptr) . op PackInto + +-- We can pack a into b if the cardinality of b is at least as large as a (could +-- be larger) +instance (Finitary a, Finitary b, Cardinality a <= Cardinality b) => Finitary (PackInto a b) where + type Cardinality (PackInto a b) = Cardinality a + {-# INLINE fromFinite #-} + fromFinite = PackInto . fromFinite . weakenN + {-# INLINE toFinite #-} + toFinite = fromJust . strengthenN . toFinite . op PackInto + +instance (Finitary a, Finitary b, 1 <= Cardinality a, Cardinality a <= Cardinality b) => Bounded (PackInto a b) where + {-# INLINE minBound #-} + minBound = start + {-# INLINE maxBound #-} + maxBound = end + +newtype instance VU.MVector s (PackInto a b) = MV_PackInto (VU.MVector s b) + +instance (VU.Unbox b) => VGM.MVector VU.MVector (PackInto a b) where + {-# INLINE basicLength #-} + basicLength = over MV_PackInto VGM.basicLength + {-# INLINE basicOverlaps #-} + basicOverlaps = over2 MV_PackInto VGM.basicOverlaps + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over MV_PackInto (VGM.basicUnsafeSlice i len) + {-# INLINE basicUnsafeNew #-} + basicUnsafeNew len = MV_PackInto <$> VGM.basicUnsafeNew len + {-# INLINE basicInitialize #-} + basicInitialize = VGM.basicInitialize . op MV_PackInto + {-# INLINE basicUnsafeRead #-} + basicUnsafeRead (MV_PackInto v) i = PackInto <$> VGM.basicUnsafeRead v i + {-# INLINE basicUnsafeWrite #-} + basicUnsafeWrite (MV_PackInto v) i (PackInto x) = VGM.basicUnsafeWrite v i x + +newtype instance VU.Vector (PackInto a b) = V_PackInto (VU.Vector b) + +instance (VU.Unbox b) => VG.Vector VU.Vector (PackInto a b) where + {-# INLINE basicLength #-} + basicLength = over V_PackInto VG.basicLength + {-# INLINE basicUnsafeFreeze #-} + basicUnsafeFreeze = fmap V_PackInto . VG.basicUnsafeFreeze . op MV_PackInto + {-# INLINE basicUnsafeThaw #-} + basicUnsafeThaw = fmap MV_PackInto . VG.basicUnsafeThaw . op V_PackInto + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over V_PackInto (VG.basicUnsafeSlice i len) + {-# INLINE basicUnsafeIndexM #-} + basicUnsafeIndexM (V_PackInto v) i = PackInto <$> VG.basicUnsafeIndexM v i + +instance (VU.Unbox b) => VU.Unbox (PackInto a b) + +-- Helpers + +{-# INLINE packInto #-} +packInto :: forall (b :: Type) (a :: Type) . + (Finitary a, Finitary b, Cardinality a <= Cardinality b) => + a -> PackInto a b +packInto = fromFinite . toFinite + +{-# INLINE unpackOutOf #-} +unpackOutOf :: forall (b :: Type) (a :: Type) . + (Finitary a, Finitary b, Cardinality a <= Cardinality b) => + PackInto a b -> a +unpackOutOf = fromFinite . toFinite
src/Data/Finitary/PackWords.hs view
@@ -1,244 +1,243 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-}-{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}--{-# LANGUAGE AllowAmbiguousTypes #-}-{-# LANGUAGE TypeInType #-}-{-# LANGUAGE RoleAnnotations #-}-{-# LANGUAGE ScopedTypeVariables #-}-{-# LANGUAGE ViewPatterns #-}-{-# LANGUAGE PatternSynonyms #-}-{-# LANGUAGE TypeFamilies #-}-{-# LANGUAGE TypeApplications #-}-{-# LANGUAGE TypeOperators #-}-{-# LANGUAGE MultiParamTypeClasses #-}---- |--- Module: Data.Finitary.PackBytes--- Description: Scheme for packing @Finitary@ types into @Word@ arrays.--- Copyright: (C) Koz Ross 2019--- License: GPL version 3.0 or later--- Maintainer: koz.ross@retro-freedom.nz--- Stability: Experimental--- Portability: GHC only------ If a type @a@ is 'Finitary', each inhabitant of @a@ has an index, which can--- be represented as an unsigned integer, spread across one or more machine--- words. This unsigned integer will have fixed length (as the number of--- inhabitants of @a@ is finite). We can use this to derive a 'VU.Unbox'--- instance, by representing 'VU.Vector' as a large array of machine words. We--- can also derive a 'Storable' instance similarly.------ This is the most efficient encoding of an arbitrary finitary type, both due--- to the asymptotics of encoding and decoding (logarithmic in @Cardinality a@--- with base @Cardinality Word@) and the fact that word accesses are faster than--- byte and bit accesses on almost all architectures. Unless you have concerns--- regarding space, this encoding is a good choice.------ Unless your type's cardinality is extremely large (a non-trivial multiple of--- @Cardinality Word@), this encoding is wasteful. If your type's cardinality is--- smaller than that of @Word@, you should consider "Data.Finitary.PackInto"--- instead, as you will have much larger control over space usage at almost no--- performance penalty. -module Data.Finitary.PackWords -(- PackWords, pattern Packed-) where--import Data.Vector.Binary ()-import Data.Vector.Instances ()-import GHC.TypeNats-import Data.Proxy (Proxy(..))-import GHC.TypeLits.Extra-import CoercibleUtils (op, over, over2)-import Data.Kind (Type)-import Data.Finitary (Finitary(..))-import Data.Finite (Finite)-import Foreign.Storable (Storable(..))-import Foreign.Ptr (castPtr, plusPtr)-import Numeric.Natural (Natural)-import Data.Hashable (Hashable(..))-import Control.DeepSeq (NFData(..))-import Control.Monad.Trans.State.Strict (evalState, get, modify, put)-import Data.Semigroup (Dual(..))--import qualified Data.Binary as Bin-import qualified Data.Vector.Unboxed as VU-import qualified Data.Vector.Generic as VG-import qualified Data.Vector.Generic.Mutable as VGM---- | An opaque wrapper around @a@, representing each value as a fixed-length--- array of machine words.-newtype PackWords (a :: Type) = PackWords (VU.Vector Word)- deriving (Eq, Show)--type role PackWords nominal---- | To provide (something that resembles a) data constructor for 'PackWords', we--- provide the following pattern. It can be used like any other data--- constructor:------ > import Data.Finitary.PackWords--- >--- > anInt :: PackWords Int--- > anInt = Packed 10--- >--- > isPackedEven :: PackWords Int -> Bool--- > isPackedEven (Packed x) = even x------ __Every__ pattern match, and data constructor call, performs a--- \(\Theta(\log_{\texttt{Cardinality Word}}(\texttt{Cardinality a}))\) encoding or decoding of @a@.--- Use with this in mind.-pattern Packed :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackWords a-pattern Packed x <- (unpackWords -> x)- where Packed x = packWords x--instance Ord (PackWords a) where- compare (PackWords v1) (PackWords v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2- where go input order = (order <>) . Dual . uncurry compare $ input--instance Bin.Binary (PackWords a) where- {-# INLINE put #-}- put = Bin.put . op PackWords- {-# INLINE get #-}- get = PackWords <$> Bin.get--instance Hashable (PackWords a) where- {-# INLINE hashWithSalt #-}- hashWithSalt salt = hashWithSalt salt . op PackWords--instance NFData (PackWords a) where- {-# INLINE rnf #-}- rnf = rnf . op PackWords--instance (Finitary a, 1 <= Cardinality a) => Finitary (PackWords a) where- type Cardinality (PackWords a) = Cardinality a- {-# INLINE fromFinite #-}- fromFinite = PackWords . intoWords- {-# INLINE toFinite #-}- toFinite = outOfWords . op PackWords--instance (Finitary a, 1 <= Cardinality a) => Bounded (PackWords a) where- {-# INLINE minBound #-}- minBound = start- {-# INLINE maxBound #-}- maxBound = end--instance (Finitary a, 1 <= Cardinality a) => Storable (PackWords a) where- {-# INLINE sizeOf #-}- sizeOf _ = wordLength @a * bytesPerWord- {-# INLINE alignment #-}- alignment _ = alignment (undefined :: Word)- {-# INLINE peek #-}- peek ptr = do let wordPtr = castPtr ptr- PackWords <$> VU.generateM (wordLength @a) (peek . plusPtr wordPtr . (* bytesPerWord))- {-# INLINE poke #-}- poke ptr (PackWords v) = do let wordPtr = castPtr ptr- VU.foldM'_ go wordPtr v- where go p e = poke p e >> pure (plusPtr p bytesPerWord) --newtype instance VU.MVector s (PackWords a) = MV_PackWords (VU.MVector s Word)--instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackWords a) where- {-# INLINE basicLength #-}- basicLength = over MV_PackWords ((`div` wordLength @a) . VGM.basicLength)- {-# INLINE basicOverlaps #-}- basicOverlaps = over2 MV_PackWords VGM.basicOverlaps- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over MV_PackWords (VGM.basicUnsafeSlice (i * wordLength @a) (len * wordLength @a))- {-# INLINE basicUnsafeNew #-}- basicUnsafeNew len = MV_PackWords <$> VGM.basicUnsafeNew (len * wordLength @a)- {-# INLINE basicInitialize #-}- basicInitialize = VGM.basicInitialize . op MV_PackWords- {-# INLINE basicUnsafeRead #-}- basicUnsafeRead (MV_PackWords v) i = fmap PackWords . VG.freeze . VGM.unsafeSlice (i * wordLength @a) (wordLength @a) $ v- {-# INLINE basicUnsafeWrite #-}- basicUnsafeWrite (MV_PackWords v) i (PackWords x) = let slice = VGM.unsafeSlice (i * wordLength @a) (wordLength @a) v in- VG.unsafeCopy slice x--newtype instance VU.Vector (PackWords a) = V_PackWords (VU.Vector Word)--instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackWords a) where- {-# INLINE basicLength #-}- basicLength = over V_PackWords ((`div` wordLength @a) . VG.basicLength)- {-# INLINE basicUnsafeFreeze #-}- basicUnsafeFreeze = fmap V_PackWords . VG.basicUnsafeFreeze . op MV_PackWords- {-# INLINE basicUnsafeThaw #-}- basicUnsafeThaw = fmap MV_PackWords . VG.basicUnsafeThaw . op V_PackWords- {-# INLINE basicUnsafeSlice #-}- basicUnsafeSlice i len = over V_PackWords (VG.basicUnsafeSlice (i * wordLength @a) (len * wordLength @a))- {-# INLINE basicUnsafeIndexM #-}- basicUnsafeIndexM (V_PackWords v) i = pure . PackWords . VG.unsafeSlice (i * wordLength @a) (wordLength @a) $ v--instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackWords a)---- Helpers--type WordLength a = CLog (Cardinality Word) (Cardinality a)--{-# INLINE bitsPerWord #-}-bitsPerWord :: forall (a :: Type) . - (Num a) => - a-bitsPerWord = 8 * bytesPerWord--{-# INLINE bytesPerWord #-}-bytesPerWord :: forall (a :: Type) . - (Num a) => - a-bytesPerWord = fromIntegral . sizeOf $ (undefined :: Word)--{-# INLINE wordLength #-}-wordLength :: forall (a :: Type) (b :: Type) . - (Finitary a, 1 <= Cardinality a, Num b) => - b-wordLength = fromIntegral . natVal $ (Proxy :: Proxy (WordLength a))--{-# INLINE packWords #-}-packWords :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - a -> PackWords a-packWords = fromFinite . toFinite--{-# INLINE unpackWords #-}-unpackWords :: forall (a :: Type) . - (Finitary a, 1 <= Cardinality a) => - PackWords a -> a-unpackWords = fromFinite . toFinite--{-# INLINE intoWords #-}-intoWords :: forall (n :: Nat) . - (KnownNat n, 1 <= n) => - Finite n -> VU.Vector Word-intoWords = evalState (VU.replicateM (wordLength @(Finite n)) go) . fromIntegral @_ @Natural- where go = do remaining <- get- let (d, r) = quotRem remaining bitsPerWord- put d >> pure (fromIntegral r)--{-# INLINE outOfWords #-}-outOfWords :: forall (n :: Nat) . - (KnownNat n) => - VU.Vector Word -> Finite n-outOfWords v = evalState (VU.foldM' go 0 v) 1- where go old w = do power <- get- let placeValue = power * fromIntegral w- modify (* bitsPerWord)- return (old + placeValue)+{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# OPTIONS_GHC -fplugin GHC.TypeLits.Extra.Solver #-} +{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-} + +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE RoleAnnotations #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeOperators #-} +{-# LANGUAGE MultiParamTypeClasses #-} + +-- | +-- Module: Data.Finitary.PackBytes +-- Description: Scheme for packing @Finitary@ types into @Word@ arrays. +-- Copyright: (C) Koz Ross 2019 +-- License: GPL version 3.0 or later +-- Stability: Experimental +-- Portability: GHC only +-- +-- If a type @a@ is 'Finitary', each inhabitant of @a@ has an index, which can +-- be represented as an unsigned integer, spread across one or more machine +-- words. This unsigned integer will have fixed length (as the number of +-- inhabitants of @a@ is finite). We can use this to derive a 'VU.Unbox' +-- instance, by representing 'VU.Vector' as a large array of machine words. We +-- can also derive a 'Storable' instance similarly. +-- +-- This is the most efficient encoding of an arbitrary finitary type, both due +-- to the asymptotics of encoding and decoding (logarithmic in @Cardinality a@ +-- with base @Cardinality Word@) and the fact that word accesses are faster than +-- byte and bit accesses on almost all architectures. Unless you have concerns +-- regarding space, this encoding is a good choice. +-- +-- Unless your type's cardinality is extremely large (a non-trivial multiple of +-- @Cardinality Word@), this encoding is wasteful. If your type's cardinality is +-- smaller than that of @Word@, you should consider "Data.Finitary.PackInto" +-- instead, as you will have much larger control over space usage at almost no +-- performance penalty. +module Data.Finitary.PackWords +( + PackWords, pattern Packed +) where + +import Data.Vector.Binary () +import Data.Vector.Instances () +import GHC.TypeNats +import Data.Proxy (Proxy(..)) +import GHC.TypeLits.Extra +import CoercibleUtils (op, over, over2) +import Data.Kind (Type) +import Data.Finitary (Finitary(..)) +import Data.Finite (Finite) +import Foreign.Storable (Storable(..)) +import Foreign.Ptr (castPtr, plusPtr) +import Numeric.Natural (Natural) +import Data.Hashable (Hashable(..)) +import Control.DeepSeq (NFData(..)) +import Control.Monad.Trans.State.Strict (evalState, get, modify, put) +import Data.Semigroup (Dual(..)) + +import qualified Data.Binary as Bin +import qualified Data.Vector.Unboxed as VU +import qualified Data.Vector.Generic as VG +import qualified Data.Vector.Generic.Mutable as VGM + +-- | An opaque wrapper around @a@, representing each value as a fixed-length +-- array of machine words. +newtype PackWords (a :: Type) = PackWords (VU.Vector Word) + deriving (Eq, Show) + +type role PackWords nominal + +-- | To provide (something that resembles a) data constructor for 'PackWords', we +-- provide the following pattern. It can be used like any other data +-- constructor: +-- +-- > import Data.Finitary.PackWords +-- > +-- > anInt :: PackWords Int +-- > anInt = Packed 10 +-- > +-- > isPackedEven :: PackWords Int -> Bool +-- > isPackedEven (Packed x) = even x +-- +-- __Every__ pattern match, and data constructor call, performs a +-- \(\Theta(\log_{\texttt{Cardinality Word}}(\texttt{Cardinality a}))\) encoding or decoding of @a@. +-- Use with this in mind. +pattern Packed :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackWords a +pattern Packed x <- (unpackWords -> x) + where Packed x = packWords x + +instance Ord (PackWords a) where + compare (PackWords v1) (PackWords v2) = getDual . VU.foldr go (Dual EQ) . VU.zipWith (,) v1 $ v2 + where go input order = (order <>) . Dual . uncurry compare $ input + +instance Bin.Binary (PackWords a) where + {-# INLINE put #-} + put = Bin.put . op PackWords + {-# INLINE get #-} + get = PackWords <$> Bin.get + +instance Hashable (PackWords a) where + {-# INLINE hashWithSalt #-} + hashWithSalt salt = hashWithSalt salt . op PackWords + +instance NFData (PackWords a) where + {-# INLINE rnf #-} + rnf = rnf . op PackWords + +instance (Finitary a, 1 <= Cardinality a) => Finitary (PackWords a) where + type Cardinality (PackWords a) = Cardinality a + {-# INLINE fromFinite #-} + fromFinite = PackWords . intoWords + {-# INLINE toFinite #-} + toFinite = outOfWords . op PackWords + +instance (Finitary a, 1 <= Cardinality a) => Bounded (PackWords a) where + {-# INLINE minBound #-} + minBound = start + {-# INLINE maxBound #-} + maxBound = end + +instance (Finitary a, 1 <= Cardinality a) => Storable (PackWords a) where + {-# INLINE sizeOf #-} + sizeOf _ = wordLength @a * bytesPerWord + {-# INLINE alignment #-} + alignment _ = alignment (undefined :: Word) + {-# INLINE peek #-} + peek ptr = do let wordPtr = castPtr ptr + PackWords <$> VU.generateM (wordLength @a) (peek . plusPtr wordPtr . (* bytesPerWord)) + {-# INLINE poke #-} + poke ptr (PackWords v) = do let wordPtr = castPtr ptr + VU.foldM'_ go wordPtr v + where go p e = poke p e >> pure (plusPtr p bytesPerWord) + +newtype instance VU.MVector s (PackWords a) = MV_PackWords (VU.MVector s Word) + +instance (Finitary a, 1 <= Cardinality a) => VGM.MVector VU.MVector (PackWords a) where + {-# INLINE basicLength #-} + basicLength = over MV_PackWords ((`div` wordLength @a) . VGM.basicLength) + {-# INLINE basicOverlaps #-} + basicOverlaps = over2 MV_PackWords VGM.basicOverlaps + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over MV_PackWords (VGM.basicUnsafeSlice (i * wordLength @a) (len * wordLength @a)) + {-# INLINE basicUnsafeNew #-} + basicUnsafeNew len = MV_PackWords <$> VGM.basicUnsafeNew (len * wordLength @a) + {-# INLINE basicInitialize #-} + basicInitialize = VGM.basicInitialize . op MV_PackWords + {-# INLINE basicUnsafeRead #-} + basicUnsafeRead (MV_PackWords v) i = fmap PackWords . VG.freeze . VGM.unsafeSlice (i * wordLength @a) (wordLength @a) $ v + {-# INLINE basicUnsafeWrite #-} + basicUnsafeWrite (MV_PackWords v) i (PackWords x) = let slice = VGM.unsafeSlice (i * wordLength @a) (wordLength @a) v in + VG.unsafeCopy slice x + +newtype instance VU.Vector (PackWords a) = V_PackWords (VU.Vector Word) + +instance (Finitary a, 1 <= Cardinality a) => VG.Vector VU.Vector (PackWords a) where + {-# INLINE basicLength #-} + basicLength = over V_PackWords ((`div` wordLength @a) . VG.basicLength) + {-# INLINE basicUnsafeFreeze #-} + basicUnsafeFreeze = fmap V_PackWords . VG.basicUnsafeFreeze . op MV_PackWords + {-# INLINE basicUnsafeThaw #-} + basicUnsafeThaw = fmap MV_PackWords . VG.basicUnsafeThaw . op V_PackWords + {-# INLINE basicUnsafeSlice #-} + basicUnsafeSlice i len = over V_PackWords (VG.basicUnsafeSlice (i * wordLength @a) (len * wordLength @a)) + {-# INLINE basicUnsafeIndexM #-} + basicUnsafeIndexM (V_PackWords v) i = pure . PackWords . VG.unsafeSlice (i * wordLength @a) (wordLength @a) $ v + +instance (Finitary a, 1 <= Cardinality a) => VU.Unbox (PackWords a) + +-- Helpers + +type WordLength a = CLog (Cardinality Word) (Cardinality a) + +{-# INLINE bitsPerWord #-} +bitsPerWord :: forall (a :: Type) . + (Num a) => + a +bitsPerWord = 8 * bytesPerWord + +{-# INLINE bytesPerWord #-} +bytesPerWord :: forall (a :: Type) . + (Num a) => + a +bytesPerWord = fromIntegral . sizeOf $ (undefined :: Word) + +{-# INLINE wordLength #-} +wordLength :: forall (a :: Type) (b :: Type) . + (Finitary a, 1 <= Cardinality a, Num b) => + b +wordLength = fromIntegral . natVal $ (Proxy :: Proxy (WordLength a)) + +{-# INLINE packWords #-} +packWords :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + a -> PackWords a +packWords = fromFinite . toFinite + +{-# INLINE unpackWords #-} +unpackWords :: forall (a :: Type) . + (Finitary a, 1 <= Cardinality a) => + PackWords a -> a +unpackWords = fromFinite . toFinite + +{-# INLINE intoWords #-} +intoWords :: forall (n :: Nat) . + (KnownNat n, 1 <= n) => + Finite n -> VU.Vector Word +intoWords = evalState (VU.replicateM (wordLength @(Finite n)) go) . fromIntegral @_ @Natural + where go = do remaining <- get + let (d, r) = quotRem remaining bitsPerWord + put d >> pure (fromIntegral r) + +{-# INLINE outOfWords #-} +outOfWords :: forall (n :: Nat) . + (KnownNat n) => + VU.Vector Word -> Finite n +outOfWords v = evalState (VU.foldM' go 0 v) 1 + where go old w = do power <- get + let placeValue = power * fromIntegral w + modify (* bitsPerWord) + return (old + placeValue)
test/Main.hs view
@@ -1,106 +1,106 @@-{-- - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz>- -- - 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 <http://www.gnu.org/licenses/>.- -}--{-# LANGUAGE OverloadedStrings #-}-{-# LANGUAGE AllowAmbiguousTypes #-}-{-# LANGUAGE TypeInType #-}-{-# LANGUAGE ScopedTypeVariables #-}-{-# LANGUAGE TypeApplications #-}-{-# LANGUAGE DeriveGeneric #-}-{-# LANGUAGE DeriveAnyClass #-}-{-# LANGUAGE DerivingVia #-}--module Main where--import Data.Kind (Type)-import GHC.TypeNats-import GHC.Generics (Generic)-import Data.Word (Word8, Word16, Word64)-import Hedgehog-import Hedgehog.Classes-import Data.Finitary (Finitary(..))-import Data.Finite (Finite)-import Data.Proxy (Proxy(..))-import Control.DeepSeq (NFData)-import Data.Hashable (Hashable(..))-import Data.Binary (Binary)-import Foreign.Storable (Storable)--import qualified Hedgehog.Gen as G-import qualified Hedgehog.Range as R--import Data.Finitary.Finiteness (Finiteness(..))-import Data.Finitary.PackBytes (PackBytes)-import Data.Finitary.PackWords (PackWords)-import Data.Finitary.PackInto (PackInto)--import qualified Data.Finitary.PackBits as Safe-import qualified Data.Finitary.PackBits.Unsafe as Unsafe-import qualified Data.Finitary.PackBytes as PackBytes-import qualified Data.Finitary.PackWords as PackWords--data Foo = Bar | Baz Word8 Word8 | Quux Word16- deriving (Eq, Show, Generic, Finitary)- deriving (Ord, Bounded, NFData, Hashable, Binary) via (Finiteness Foo)--data Big = Big Word64 Word64- deriving (Eq, Show, Generic, Finitary)- deriving (Ord, Bounded, NFData, Hashable, Binary) via (Finiteness Big)---- Generators-choose :: forall (a :: Type) m . (MonadGen m, Finitary a) => m a-choose = fromFinite <$> chooseFinite--chooseFinite :: forall (n :: Nat) m . (KnownNat n, MonadGen m) => m (Finite n)-chooseFinite = fromIntegral <$> G.integral (R.linear 0 limit)- where limit = subtract @Integer 1 . fromIntegral . natVal @n $ Proxy--finitenessLaws :: (Show a, Binary a, Ord a) => Gen a -> [Laws]-finitenessLaws p = [binaryLaws p, ordLaws p]--packLaws :: (Eq a, Show a, Storable a) => Gen a -> [Laws]-packLaws p = [storableLaws p]--ordIsMonotonic :: forall (a :: Type) (t :: Type -> Type) . - (Finitary a, Show a, Ord a, Ord (t a)) => - (a -> t a) -> Property-ordIsMonotonic f = property $ do x <- forAll $ choose @a- y <- forAll $ choose @a- (x < y) === (f x < f y)--finitenessTests :: [(String, [Laws])]-finitenessTests = [("Small Finiteness", finitenessLaws @Foo choose),- ("Big Finiteness", finitenessLaws @Big choose)]--packTests :: [(String, [Laws])]-packTests = [("Small PackBytes", packLaws @(PackBytes Foo) choose),- ("Big PackBytes", packLaws @(PackBytes Big) choose),- ("Small PackWords", packLaws @(PackWords Foo) choose),- ("Big PackWords", packLaws @(PackWords Big) choose),- ("Small packed into Word64", packLaws @(PackInto Foo Word64) choose)]--main :: IO Bool-main = (&&) <$> checkLaws <*> checkMonotonicity- where checkLaws = (&&) <$> lawsCheckMany finitenessTests <*> lawsCheckMany packTests- checkMonotonicity = checkParallel . Group "Monotonicity" $ [("Small PackBits", ordIsMonotonic @Foo Safe.Packed),- ("Small unsafe PackBits", ordIsMonotonic @Foo Unsafe.Packed),- ("Small PackBytes", ordIsMonotonic @Foo PackBytes.Packed),- ("Small PackWords", ordIsMonotonic @Foo PackWords.Packed),- ("Big PackBits", ordIsMonotonic @Big Safe.Packed),- ("Big unsafe PackBits", ordIsMonotonic @Big Unsafe.Packed),- ("Big PackBytes", ordIsMonotonic @Big PackBytes.Packed),- ("Big PackWords", ordIsMonotonic @Big PackWords.Packed)]+{- + - Copyright (C) 2019 Koz Ross <koz.ross@retro-freedom.nz> + - + - 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 <http://www.gnu.org/licenses/>. + -} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE TypeInType #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DerivingVia #-} + +module Main where + +import Data.Kind (Type) +import GHC.TypeNats +import GHC.Generics (Generic) +import Data.Word (Word8, Word16, Word64) +import Hedgehog +import Hedgehog.Classes +import Data.Finitary (Finitary(..)) +import Data.Finite (Finite) +import Data.Proxy (Proxy(..)) +import Control.DeepSeq (NFData) +import Data.Hashable (Hashable(..)) +import Data.Binary (Binary) +import Foreign.Storable (Storable) + +import qualified Hedgehog.Gen as G +import qualified Hedgehog.Range as R + +import Data.Finitary.Finiteness (Finiteness(..)) +import Data.Finitary.PackBytes (PackBytes) +import Data.Finitary.PackWords (PackWords) +import Data.Finitary.PackInto (PackInto) + +import qualified Data.Finitary.PackBits as Safe +import qualified Data.Finitary.PackBits.Unsafe as Unsafe +import qualified Data.Finitary.PackBytes as PackBytes +import qualified Data.Finitary.PackWords as PackWords + +data Foo = Bar | Baz Word8 Word8 | Quux Word16 + deriving (Eq, Show, Generic, Finitary) + deriving (Ord, Bounded, NFData, Hashable, Binary) via (Finiteness Foo) + +data Big = Big Word64 Word64 + deriving (Eq, Show, Generic, Finitary) + deriving (Ord, Bounded, NFData, Hashable, Binary) via (Finiteness Big) + +-- Generators +choose :: forall (a :: Type) m . (MonadGen m, Finitary a) => m a +choose = fromFinite <$> chooseFinite + +chooseFinite :: forall (n :: Nat) m . (KnownNat n, MonadGen m) => m (Finite n) +chooseFinite = fromIntegral <$> G.integral (R.linear 0 limit) + where limit = subtract @Integer 1 . fromIntegral . natVal @n $ Proxy + +finitenessLaws :: (Show a, Binary a, Ord a) => Gen a -> [Laws] +finitenessLaws p = [binaryLaws p, ordLaws p] + +packLaws :: (Eq a, Show a, Storable a) => Gen a -> [Laws] +packLaws p = [storableLaws p] + +ordIsMonotonic :: forall (a :: Type) (t :: Type -> Type) . + (Finitary a, Show a, Ord a, Ord (t a)) => + (a -> t a) -> Property +ordIsMonotonic f = property $ do x <- forAll $ choose @a + y <- forAll $ choose @a + (x < y) === (f x < f y) + +finitenessTests :: [(String, [Laws])] +finitenessTests = [("Small Finiteness", finitenessLaws @Foo choose), + ("Big Finiteness", finitenessLaws @Big choose)] + +packTests :: [(String, [Laws])] +packTests = [("Small PackBytes", packLaws @(PackBytes Foo) choose), + ("Big PackBytes", packLaws @(PackBytes Big) choose), + ("Small PackWords", packLaws @(PackWords Foo) choose), + ("Big PackWords", packLaws @(PackWords Big) choose), + ("Small packed into Word64", packLaws @(PackInto Foo Word64) choose)] + +main :: IO Bool +main = (&&) <$> checkLaws <*> checkMonotonicity + where checkLaws = (&&) <$> lawsCheckMany finitenessTests <*> lawsCheckMany packTests + checkMonotonicity = checkParallel . Group "Monotonicity" $ [("Small PackBits", ordIsMonotonic @Foo Safe.Packed), + ("Small unsafe PackBits", ordIsMonotonic @Foo Unsafe.Packed), + ("Small PackBytes", ordIsMonotonic @Foo PackBytes.Packed), + ("Small PackWords", ordIsMonotonic @Foo PackWords.Packed), + ("Big PackBits", ordIsMonotonic @Big Safe.Packed), + ("Big unsafe PackBits", ordIsMonotonic @Big Unsafe.Packed), + ("Big PackBytes", ordIsMonotonic @Big PackBytes.Packed), + ("Big PackWords", ordIsMonotonic @Big PackWords.Packed)]