text-containers (empty) → 0.1.0.0
raw patch · 10 files changed
+2148/−0 lines, 10 filesdep +QuickCheckdep +basedep +bytestringsetup-changed
Dependencies added: QuickCheck, base, bytestring, containers, deepseq, ghc-prim, hashable, quickcheck-instances, semigroups, tasty, tasty-quickcheck, text, text-containers, text-short, vector
Files
- LICENSE +674/−0
- Setup.hs +2/−0
- cbits/cbits.c +7/−0
- src-tests/tests.hs +162/−0
- src/Data/TextArray/Unboxed.hs +35/−0
- src/Data/TextArray/Unboxed/Internal.hs +244/−0
- src/Data/TextMap/Unboxed/Lazy.hs +327/−0
- src/Data/TextSet/Unboxed.hs +363/−0
- src/Internal.hs +240/−0
- text-containers.cabal +94/−0
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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+<http://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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ cbits/cbits.c view
@@ -0,0 +1,7 @@+#include <string.h>++int+hs_text_containers_memcmp(const void *s1, const size_t s1ofs, const void *s2, const size_t s2ofs, const size_t n)+{+ return memcmp(s1+s1ofs, s2+s2ofs, n);+}
+ src-tests/tests.hs view
@@ -0,0 +1,162 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}++{-# OPTIONS_GHC -fno-warn-orphans #-}++module Main where++import Data.List+import qualified Data.Map.Strict as Map+import qualified Data.Set as Set+import qualified Data.Text.Short as ST++import Test.QuickCheck.Instances ()+import Test.Tasty+import Test.Tasty.QuickCheck as QC++import qualified Data.TextArray.Unboxed as TA+import qualified Data.TextMap.Unboxed.Lazy as TM+import qualified Data.TextSet.Unboxed as TS++main :: IO ()+main = defaultMain tests++-- compat for containers<0.5.9+setLookupMin :: Set.Set a -> Maybe a+setLookupMin s = if Set.null s then Nothing else Just (Set.findMin s)+setLookupMax :: Set.Set a -> Maybe a+setLookupMax s = if Set.null s then Nothing else Just (Set.findMax s)++instance Arbitrary ST.ShortText where+ arbitrary = ST.fromText <$> arbitrary++instance Arbitrary TA.TextArray where+ arbitrary = TA.fromList <$> arbitrary++tests :: TestTree+tests = testGroup "Tests" [testsMapLazy, testsSet, testsArray]+ where+ testsArray = testGroup "TextArray"+ [ QC.testProperty "toList.fromList" $+ \xs -> (TA.toList . TA.fromList) xs == xs++ , QC.testProperty "singleton" $+ \x -> (TA.toList . TA.singleton) x == [x]++ , QC.testProperty "length" $+ \xs -> length xs == TA.length (TA.fromList xs)++ , QC.testProperty "null" $+ \xs -> null xs == TA.null (TA.fromList xs)++ , QC.testProperty "elem" $+ \xs -> all (`TA.elem` (TA.fromList xs)) xs++ , QC.testProperty "elemIndices" $+ \t0 t1 t2 t3 t4 t5 -> let xs = [t1,t0,t2,t0,t3,t0,t4,t5]+ ta = TA.fromList xs+ in all (\z -> elemIndices z xs == TA.elemIndices z ta) xs++ , QC.testProperty "elemIndices#2" $+ \xs -> let ta = TA.fromList xs+ in all (\z -> elemIndices z xs == TA.elemIndices z ta) (ST.fromString "Shakespeare":xs)++ , QC.testProperty "(!?)" $+ \xs -> let ta = TA.fromList xs+ in mapM (ta TA.!?) [0.. (TA.length ta)-1] == Just xs++ , QC.testProperty "append" $+ \xs ys -> TA.fromList (xs++ys) == TA.fromList xs `mappend` TA.fromList ys++ -- , QC.testProperty "findAllOrd EQ" $+ -- \xs -> let ta = TA.fromList xs+ -- in all (\z -> filter (==z) xs == TA.findAllOrd (==EQ) z ta) (ST.fromString "Shakespeare":xs)++ -- , QC.testProperty "findIndicesOrd EQ" $+ -- \xs -> let ta = TA.fromList xs+ -- in all (\z -> findIndices (==z) xs == TA.findIndicesOrd (==EQ) z ta) (ST.fromString "Shakespeare":xs)+ ]++ testsSet = testGroup "TextSet"+ [ QC.testProperty "toList.fromList" $+ \xs -> (TS.toList . TS.fromList) xs == (Set.toList . Set.fromList) xs++ , QC.testProperty "singleton" $+ \x -> (TS.toList . TS.singleton) x == [x]++ , QC.testProperty "toList.fromSet" $+ \xs -> (TS.toList . TS.fromSet) xs == Set.toList xs++ , QC.testProperty "toList.toSet" $+ \xs -> (TS.toSet . TS.fromList) xs == Set.fromList xs++ , QC.testProperty "size" $+ \xs -> Set.size (Set.fromList xs) == TS.size (TS.fromList xs)++ , QC.testProperty "null" $+ \xs -> null xs == TS.null (TS.fromList xs)++ , QC.testProperty "member" $+ \xs -> all (`TS.member` (TS.fromList xs)) xs++ , QC.testProperty "(!?)" $+ \xs -> let s1 = TS.fromList xs+ s2 = Set.fromList xs+ in all (\j -> s1 TS.!? j == Just (Set.elemAt j s2)) [0 .. Set.size s2 - 1]++ , QC.testProperty "lookupMin" $+ \xs -> (TS.lookupMin . TS.fromList) xs == (setLookupMin . Set.fromList) xs++ , QC.testProperty "lookupMax" $+ \xs -> (TS.lookupMax . TS.fromList) xs == (setLookupMax . Set.fromList) xs++ , QC.testProperty "lookupIndex" $+ \xs -> let s1 = TS.fromList xs+ s2 = Set.fromList xs+ in all (\k -> TS.lookupIndex k s1 == Set.lookupIndex k s2) (someStrs ++ xs)++ , QC.testProperty "lookupLE" $+ \xs -> let s1 = TS.fromList xs+ s2 = Set.fromList xs+ in all (\k -> fmap snd (TS.lookupLE k s1) == Set.lookupLE k s2) (someStrs ++ xs)++ , QC.testProperty "lookupGE" $+ \xs -> let s1 = TS.fromList xs+ s2 = Set.fromList xs+ in all (\k -> fmap snd (TS.lookupGE k s1) == Set.lookupGE k s2) (someStrs ++ xs)++ ]++ testsMapLazy = testGroup "TextMap(Lazy)"+ [ QC.testProperty "toList.fromList" $+ \(Ps xs) -> (TM.toList . TM.fromList) xs == (Map.toList . Map.fromList) xs++ , QC.testProperty "singleton" $+ \x y -> TM.toList (TM.singleton x y) == [(x,y::Int)]++ , QC.testProperty "toList.fromMap" $+ \xs -> (TM.toList . TM.fromMap) xs == Map.toList (xs :: Map.Map ST.ShortText Int)++ , QC.testProperty "toList.toMap" $+ \(Ps xs) -> (TM.toMap . TM.fromList) xs == Map.fromList xs++ , QC.testProperty "size" $+ \(Ps xs) -> TM.size (TM.fromList xs) == Map.size (Map.fromList xs)++ , QC.testProperty "null" $+ \(Ps xs) -> TM.null (TM.fromList xs) == null xs++ , QC.testProperty "member" $+ \(Ps xs) -> all (`TM.member` (TM.fromList xs)) (map fst xs)++ , QC.testProperty "(!?)" $+ \(Ps xs) -> let s1 = TM.fromList xs+ s2 = Map.fromList xs+ in all (\k -> (s1 TM.!? k) == (Map.lookup k s2)) (someStrs ++ map fst xs)+ ]+++someStrs :: [ST.ShortText]+someStrs = map ST.fromString ["","\x00","a","Z","\x10ffff"]++newtype Ps = Ps [(ST.ShortText,Int)]+ deriving (Arbitrary,Show)
+ src/Data/TextArray/Unboxed.hs view
@@ -0,0 +1,35 @@+{-# LANGUAGE Trustworthy #-}++-- |+-- Copyright: © 2017 Herbert Valerio Riedel+-- License: GPLv3+--+-- This module provides the 'TextArray' container for storing arrays of text strings.+--+-- This module is intended to be imported @qualified@, e.g.+--+-- > import Data.TextArray.Unboxed (TextArr)+-- > import qualified Data.TextArray.Unboxed as TextArr+--+module Data.TextArray.Unboxed+ ( TextArray+ -- * Querying & lookup+ , null+ , length+ , elem++ , elemIndices+ -- , findIndicesOrd+ -- , findAllOrd+ , (!?)+ -- * Construction+ , empty+ , singleton+ , fromList+ -- * Deconstruction+ , toList+ ) where++import Prelude ()++import Data.TextArray.Unboxed.Internal
+ src/Data/TextArray/Unboxed/Internal.hs view
@@ -0,0 +1,244 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE MagicHash #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE UnliftedFFITypes #-}+{-# LANGUAGE Unsafe #-}++-- |+-- Copyright: © 2017 Herbert Valerio Riedel+-- License: GPLv3+module Data.TextArray.Unboxed.Internal where++import Control.DeepSeq+import Control.Monad+import Control.Monad.ST+import qualified Data.ByteString.Short as SBS+import Data.Hashable (Hashable (..))+import qualified Data.List as List+import Data.Semigroup+import Data.Text.Short (ShortText)+import qualified Data.Text.Short as TS+import qualified GHC.Exts as GHC+import Prelude hiding (elem, length, null)++import Internal++-- | An array of unboxed 'ShortText' strings+--+-- The memory footprint of this data-structure is a single heap object (an unlifted 'ByteArray#') with the size expressed in words+--+-- \[+-- 3 + n + \left\lceil \frac{1}{w} \sum_{i=0}^{n-1} len(s_i) \right\rceil+-- \]+--+-- where the word-size \(w\) is either \(w = 4\) or \(w = 8\) bytes; and where \(len(s_i)\) denotes the UTF-8 size in bytes of the \(i\)-th text string.+--+-- NOTE: Depending on whether you @UNPACK@ the 'TextArray' wrapper, you need at least one additional word for the pointer to the internal 'ByteArray#' heap object.+newtype TextArray = TA# BA++ta2ba :: TextArray -> BA+ta2ba (TA# x) = x++instance Eq TextArray where+ (TA# x) == (TA# y) = ba2sbs x == ba2sbs y++-- TODO: optimise+instance Ord TextArray where+ compare x y = compare (toList x) (toList y)++instance Show TextArray where+ showsPrec p ta = showsPrec p (toList ta)+ show ta = show (toList ta)++instance Read TextArray where+ readsPrec p = map (\(x,s) -> (fromList x,s)) . readsPrec p++instance GHC.IsList TextArray where+ type Item TextArray = ShortText+ fromList = fromList+ toList = toList++instance NFData TextArray where+ rnf (TA# (BA# !_)) = ()++-- | \(\mathcal{O}(n+m)\). Concatenate two 'TextArray's.+instance Semigroup TextArray where+ (<>) = append++instance Monoid TextArray where+ mempty = empty+ mappend = (<>)++instance Hashable TextArray where+ hashWithSalt salt (TA# ba) = hashWithSalt salt ba++-- | \(\mathcal{O}(1)\). An empty 'TextArray'+empty :: TextArray+empty = TA# $ createBA wordSize $ \mba -> writeIntArray mba 0 0++-- | \(\mathcal{O}(1)\). Construct 'TextArray' with single element+singleton :: ShortText -> TextArray+singleton t = TA# $ createBA totalSize $ \mba -> do+ writeIntArray mba 0 1+ writeIntArray mba 1 dataOfs+ copyByteArray (st2ba t) 0 mba dataOfs dataSize+ where+ dataOfs = wordSize * 2+ dataSize = sizeOfByteArray (st2ba t)+ totalSize = dataOfs + dataSize++-- | \(\mathcal{O}(1)\). Test whether 'TestArray' is empty.+null :: TextArray -> Bool+null = (==0) . length++-- | \(\mathcal{O}(1)\). Return number of strings contained in 'TestArray'.+length :: TextArray -> Int+length (TA# ba) = indexIntArray ba 0++-- | \(\mathcal{O}(1)\). Array indexing (0-based).+(!?) :: TextArray -> Int -> Maybe ShortText+ta@(TA# ba) !? i = case indexOfsLen ta i of+ Just (IdxOfsLen _ ofs n) -> Just $! ba2st (sliceBA ba ofs n)+ Nothing -> Nothing++-- | \(\mathcal{O}(n)\). Construct 'TextArray' from list of strings.+fromList :: [ShortText] -> TextArray+fromList [] = empty+fromList xs = TA# $ createBA totalSize $ \mba -> do+ writeIntArray mba 0 n+ writeOfsTab mba 1 dataOfs xs+ pure ()+ where+ writeOfsTab :: MBA s -> Int -> Int -> [ShortText] -> ST s ()+ writeOfsTab _ !_ !_ [] = pure ()+ writeOfsTab mba !j !ofs (t:ts) = do+ let y = SBS.length (TS.toShortByteString t)+ writeIntArray mba j ofs+ copyByteArray (st2ba t) 0 mba ofs (sizeOfByteArray (st2ba t))+ writeOfsTab mba (j+1) (ofs+y) ts++ -- Memory layout of 'ByteArray#' payload:+ --+ -- - `N :: Int#` (number of strings in array)+ -- - byte-offset[j] (for 0 <= j < N) as 'Int#'+ -- - data-area: concatenated UTF8-encoded strings+ --+ -- byte-offset[0] points to start of 'data-area'+ --+ (dataSize,n) = sumLen $ map (SBS.length . TS.toShortByteString) xs+ dataOfs = wordSize * (1+n)+ totalSize = dataOfs + dataSize++-- | \(\mathcal{O}(n+m)\). Concatenate two 'TextArray's+append :: TextArray -> TextArray -> TextArray+append a b+ | null a = b+ | null b = a+append ta1@(TA# ba1) ta2@(TA# ba2) = TA# $ createBA totalSize $ \mba -> do+ writeIntArray mba 0 n+ forM_ [1..n1] $ \j -> writeIntArray mba j (ofs1fixup + indexIntArray ba1 j)+ forM_ [1..n2] $ \j -> writeIntArray mba (n1+j) (ofs2fixup + indexIntArray ba2 j)+ copyByteArray ba1 dataOfs1 mba dataOfs1' dataSz1+ copyByteArray ba2 dataOfs2 mba dataOfs2' dataSz2+ pure ()+ where+ n = n1+n2+ n1 = length ta1+ n2 = length ta2+ ofs1fixup = n2 * wordSize+ ofs2fixup = sz1 - wordSize+ sz1 = sizeOfByteArray ba1+ sz2 = sizeOfByteArray ba2+ dataOfs1 = (1+n1) * wordSize+ dataOfs2 = (1+n2) * wordSize+ dataSz1 = sz1 - dataOfs1+ dataSz2 = sz2 - dataOfs2+ dataOfs1' = (1+n) * wordSize+ dataOfs2' = dataOfs1'+dataSz1+ totalSize = sz1+sz2-wordSize++-- | \(\mathcal{O}(n)\). Deconstruct 'TextArray' into list of strings.+toList :: TextArray -> [ShortText]+toList ta = map (\(IdxOfsLen _ ofs n) -> ba2st (sliceBA (ta2ba ta) ofs n)) (listOfsLen ta)++-- | \(\mathcal{O}(n)\). Test whether 'TestArray' contains a specific string.+elem :: ShortText -> TextArray -> Bool+elem needle ta = not (List.null (elemIndices needle ta))++-- | \(\mathcal{O}(n)\). Find occurences of given string in 'TextArray' and report list of indices (in ascending order).+elemIndices :: ShortText -> TextArray -> [Int]+elemIndices needle ta = [ i | IdxOfsLen i ofs n <- listOfsLen ta, cmp ofs n ]+ where+ !ba2 = st2ba needle+ !ba2sz = sizeOfByteArray ba2++ cmp !ofs1 !n = equalByteArray ba2 0 ba2sz (ta2ba ta) ofs1 n++findAllOrd :: (Ordering -> Bool) -> ShortText -> TextArray -> [ShortText]+findAllOrd ordFilter needle ta = [ mkst ofs n | IdxOfsLen _ ofs n <- listOfsLen ta, ordFilter (cmp ofs n) ]+ where+ !ba2 = st2ba needle+ !ba2sz = sizeOfByteArray ba2++ mkst !ofs1 !n = ba2st (sliceBA (ta2ba ta) ofs1 n)+ cmp !ofs1 !n = compareByteArray ba2 0 ba2sz (ta2ba ta) ofs1 n++findIndicesOrd :: (Ordering -> Bool) -> ShortText -> TextArray -> [Int]+findIndicesOrd ordFilter needle ta = [ i | IdxOfsLen i ofs n <- listOfsLen ta, ordFilter (cmp ofs n) ]+ where+ !ba2 = st2ba needle+ !ba2sz = sizeOfByteArray ba2++ cmp !ofs1 !n = compareByteArray ba2 0 ba2sz (ta2ba ta) ofs1 n++----------------------------------------------------------------------------+-- internal helpers++indexOfsLen :: TextArray -> Int -> Maybe IdxOfsLen+indexOfsLen ta@(TA# ba) i+ | i >= sz = Nothing+ | i < 0 = Nothing+ | otherwise+ = let i' = i+1+ ofs = indexIntArray ba i'+ ofs' | i' == sz = sizeOfByteArray ba+ | otherwise = indexIntArray ba (i'+1)+ !e = IdxOfsLen i ofs (ofs'-ofs)+ in Just e+ where+ sz = length ta++indexOfsLen' :: TextArray -> Int -> IdxOfsLen+indexOfsLen' ta@(TA# ba) i+ | i >= sz = IdxOfsLen 0 0 0+ | i < 0 = IdxOfsLen 0 0 0+ | otherwise+ = let i' = i+1+ ofs = indexIntArray ba i'+ ofs' | i' == sz = sizeOfByteArray ba+ | otherwise = indexIntArray ba (i'+1)+ in IdxOfsLen i ofs (ofs'-ofs)+ where+ sz = length ta++listOfsLen :: TextArray -> [IdxOfsLen]+listOfsLen ta@(TA# ba)+ | sz == 0 = []+ | otherwise = go 1 (indexIntArray ba 1)+ where+ sz = length ta++ go !i !ofs | i > sz = []+ | otherwise = e : go (i+1) ofs'+ where+ !e = IdxOfsLen (i-1) ofs n+ n = ofs'-ofs+ ofs' | i == sz = sizeOfByteArray ba+ | otherwise = indexIntArray ba (i+1)++sumLen :: [Int] -> (Int,Int)+sumLen = go 0 0+ where+ go !s !l [] = (s,l)+ go !s !l (x:xs) = go (s+x) (l+1) xs
+ src/Data/TextMap/Unboxed/Lazy.hs view
@@ -0,0 +1,327 @@+{-# LANGUAGE MagicHash #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE Trustworthy #-}+{-# LANGUAGE TypeFamilies #-}++-- |+-- Copyright: © 2017 Herbert Valerio Riedel+-- License: GPLv3+--+-- This module provides the 'TextMap' container for storing maps of text keys to non-strict values.+--+-- This module is intended to be imported @qualified@, e.g.+--+-- > import Data.TextMap.Unboxed.Lazy (TextMap)+-- > import qualified Data.TextMap.Unboxed.Lazy as TextMap+--+-- The API of this module provides value-lazy operations.+module Data.TextMap.Unboxed.Lazy+ ( TextMap+ , Key+ -- * Querying & lookup+ , size+ , null+ , member+ , lookup+ , (!?)+ , findWithDefault+ , lookupMin+ , lookupMax+ , lookupLE+ , lookupGE++ -- * Construction+ , empty+ , singleton+ , fromList+ , fromDistinctAscList+ , fromMap++ -- * Deconstruction+ , toList+ , toMap++ -- * Traversals+ , map++ ) where++import Control.DeepSeq+import qualified Data.Foldable as F+import Data.Hashable (Hashable (..))+import qualified Data.Map.Lazy as Map+import qualified GHC.Exts as GHC (IsList (..))+import Prelude hiding (lookup, map, null)++import Data.TextSet.Unboxed (Key, TextSet)+import qualified Data.TextSet.Unboxed as TS+import Internal++-- | A map of (unboxed) 'ShortText' string keys to values.+--+-- The memory footprint of this data-structure is expressed in words+--+-- \[+-- 8 + 2n + \left\lceil \frac{1}{w} \sum_{i=0}^{n-1} len(k_i) \right\rceil + \sum_{i=0}^{n-1} size(v_i)+-- \]+--+-- where+--+-- * the word-size \(w\) is either \(w = 4\) or \(w = 8\) bytes,+-- * \(len(k_i)\) denotes the UTF-8 size in bytes of the \(i\)-th key string, and+-- * \(size(v_i)\) denotes the allocated heap size of the \(i\)-th value in words.+--+-- __NOTE__: One word can be saved by unpacking 'TextMap' (i.e. via @{-\# UNPACK \#-}@) into another constructor.+data TextMap v = TM !TextSet !(A v)+ deriving (Eq)++instance Ord v => Ord (TextMap v) where+ compare a b = compare (toList a) (toList b)++instance Show v => Show (TextMap v) where+ showsPrec p m = showsPrec p (toList m)+ show m = show (toList m)++instance Read v => Read (TextMap v) where+ readsPrec p = fmap (\(x,s) -> (fromList x,s)) . readsPrec p++instance GHC.IsList (TextMap v) where+ type Item (TextMap v) = (Key,v)+ fromList = fromList+ toList = toList++instance NFData v => NFData (TextMap v) where+ rnf (TM ks vs) = ks `deepseq` vs `deepseq` ()++instance Hashable v => Hashable (TextMap v) where+ hashWithSalt s (TM ks vs) = s `hashWithSalt` ks `hashWithSalt` vs++instance Functor TextMap where+ fmap = map+ v <$ (TM ks vs) = TM ks (v <$ vs)++instance Foldable TextMap where+ foldMap f = F.foldMap f . elems+ foldr f g = F.foldr f g . elems+ toList = elems+ null = null+ length = size++instance Traversable TextMap where+ traverse f (TM ks vs) = TM ks <$> arrayTraverse f vs++-- | \(\mathcal{O}(\log n)\). Lookup value for given key.+--+-- >>> fromList [("bb",False),("cc",True)] !? "cc"+-- Just True+--+-- This is a 'flip'ped infix alias of 'lookup'.+(!?) :: TextMap v -> Key -> Maybe v+(!?) = flip lookup++-- | \(\mathcal{O}(\log n)\). Lookup value for given key.+--+-- >>> lookup "a" (fromList [("bb",False),("cc",True)])+-- Nothing+--+-- >>> lookup "c" (fromList [("bb",False),("cc",True)])+-- Nothing+--+-- >>> lookup "cc" (fromList [("bb",False),("cc",True)])+-- Just True+--+-- >>> lookup "z" (fromList [("bb",False),("cc",True)])+-- Nothing+--+lookup :: Key -> TextMap v -> Maybe v+lookup k (TM ks vs) = indexArray vs <$> TS.lookupIndex k ks++-- | \(\mathcal{O}(1)\). Extract minimal key and its associated value.+--+-- >>> lookupMin empty+-- Nothing+--+-- >>> lookupMin (fromList [("a",EQ),("b",GT),("c",LT)])+-- Just ("a",EQ)+--+lookupMin :: TextMap v -> Maybe (Key,v)+lookupMin (TM ks vs) = case TS.lookupMin ks of+ Nothing -> Nothing+ Just k -> Just (k,indexArray vs 0)++-- | \(\mathcal{O}(1)\). Extract maximal key and its associated value.+--+-- >>> lookupMax empty+-- Nothing+--+-- >>> lookupMax (fromList [("a",EQ),("b",GT),("c",LT)])+-- Just ("c",LT)+--+lookupMax :: TextMap v -> Maybe (Key,v)+lookupMax (TM ks vs) = case TS.lookupMax ks of+ Nothing -> Nothing+ Just k -> Just (k,indexArray vs (sizeofArray vs - 1))++-- | \(\mathcal{O}(\log n)\). Lookup \"greatest\" key in map less or equal to given key and return key/value pair.+--+-- >>> lookupLE "a" (fromList [("bb",False),("cc",True)])+-- Nothing+--+-- >>> lookupLE "c" (fromList [("bb",False),("cc",True)])+-- Just ("bb",False)+--+-- >>> lookupLE "cc" (fromList [("bb",False),("cc",True)])+-- Just ("cc",True)+--+-- >>> lookupLE "z" (fromList [("bb",False),("cc",True)])+-- Just ("cc",True)+--+lookupLE :: Key -> TextMap v -> Maybe (Key,v)+lookupLE k0 (TM ks vs) = case TS.lookupLE k0 ks of+ Nothing -> Nothing+ Just (i,k) -> Just (k,indexArray vs i)++-- | \(\mathcal{O}(\log n)\). Lookup \"least\" key in map less or equal to given key and return key/value pair.+--+-- >>> lookupGE "a" (fromList [("bb",False),("cc",True)])+-- Just ("bb",False)+--+-- >>> lookupGE "c" (fromList [("bb",False),("cc",True)])+-- Just ("cc",True)+--+-- >>> lookupGE "cc" (fromList [("bb",False),("cc",True)])+-- Just ("cc",True)+--+-- >>> lookupGE "z" (fromList [("bb",False),("cc",True)])+-- Nothing+--+lookupGE :: Key -> TextMap v -> Maybe (Key,v)+lookupGE k0 (TM ks vs) = case TS.lookupGE k0 ks of+ Nothing -> Nothing+ Just (i,k) -> Just (k,indexArray vs i)++-- | \(\mathcal{O}(\log n)\). Lookup value for key in map or return default value if key not contained in map.+--+-- >>> findWithDefault True "z" (fromList [("bb",False),("cc",True)])+-- True+--+-- >>> findWithDefault True "bb" (fromList [("bb",False),("cc",True)])+-- False+--+-- See also 'lookup' or '!?'.+findWithDefault :: v -> Key -> TextMap v -> v+findWithDefault def k (TM ks vs) = maybe def (indexArray vs) (TS.lookupIndex k ks)++-- | \(\mathcal{O}(n)\). Convert 'Map' to 'TextMap'.+fromMap :: Map.Map Key v -> TextMap v+fromMap m0 = TM ks vs+ where+ ks = TS.fromSet (Map.keysSet m0)+ vs = arrayFromListN (TS.size ks) (Map.elems m0)++-- | \(\mathcal{O}(n)\). Convert 'TextMap' to 'Map'.+toMap :: TextMap v -> Map.Map Key v+toMap m = Map.fromDistinctAscList (toList m)++-- | \(\mathcal{O}(1)\). Extract set of all keys.+keysTextSet :: TextMap v -> TextSet+keysTextSet (TM ks _) = ks++-- | \(\mathcal{O}(\log n)\). Test whether key is present in map.+--+-- >>> member "empty" empty+-- False+--+-- >>> member "a" (fromList [("a",EQ),("b",GT),("c",LT)])+-- True+--+-- >>> member "d" (fromList [("a",EQ),("b",GT),("c",LT)])+-- False+--+member :: Key -> TextMap v -> Bool+member k m = TS.member k (keysTextSet m)++-- | \(\mathcal{O}(n)\). list all keys in ascending order.+keys :: TextMap v -> [Key]+keys m = TS.toList (keysTextSet m)++-- | \(\mathcal{O}(n)\). list all values of the map in ascending order of their keys.+elems :: TextMap v -> [v]+elems (TM _ vs) = arrayToList vs++-- | \(\mathcal{O}(n)\). list all key/value pairs of the map in ascending order of their keys.+--+-- >>> toList (fromList [("Hey",GT),("Jude",EQ),("Hey",LT),("Law",EQ),("Hey",EQ),("",EQ)])+-- [("",EQ),("Hey",EQ),("Jude",EQ),("Law",EQ)]+--+toList :: TextMap v -> [(Key,v)]+toList m = zip (keys m) (elems m)++-- | \(\mathcal{O}(n \log n)\). Construct map from list of key/value pairs.+--+-- >>> toList (fromList [("Hey",GT),("Jude",EQ),("Hey",LT),("Law",EQ),("Hey",EQ),("",EQ)])+-- [("",EQ),("Hey",EQ),("Jude",EQ),("Law",EQ)]+--+fromList :: [(Key,v)] -> TextMap v+fromList [] = empty+fromList [(k,v)] = singleton k v+fromList kvs = fromMap (Map.fromList kvs)++-- | \(\mathcal{O}(n)\). Construct map from list with distinct keys in ascending order.+--+-- __NOTE__: If the input list is not strictly ascending, an 'error' is thrown.+fromDistinctAscList :: [(Key,v)] -> TextMap v+fromDistinctAscList as = TM ks vs+ where+ (ks0,vs0) = unzip as+ ks = TS.fromDistinctAscList ks0+ vs = arrayFromListN (TS.size ks) vs0++-- | \(\mathcal{O}(1)\). An empty 'TextMap'.+empty :: TextMap v+empty = TM TS.empty emptyA++-- | \(\mathcal{O}(1)\). Construct map containing a single entry.+--+-- >>> toList (singleton "sa" LT)+-- [("sa",LT)]+--+singleton :: Key -> v -> TextMap v+singleton k v = TM (TS.singleton k) (arraySingleton v)++-- | \(\mathcal{O}(1)\). Report number of entries in map.+--+-- >>> size empty+-- 0+--+-- >>> size (singleton "sa" LT)+-- 1+--+-- >>> size (fromList [("a",True),("b",False),("a",False)])+-- 2+--+size :: TextMap v -> Int+size (TM _ vs) = sizeofArray vs++-- | \(\mathcal{O}(1)\). Test whether map is 'empty'.+--+-- >>> null empty+-- True+--+-- >>> null (singleton "" ())+-- False+--+null :: TextMap v -> Bool+null m = size m == 0++-- | \(\mathcal{O}(n)\). Apply function to values in map.+--+-- >>> toList (map not (fromList [("a",True),("b",False),("a",False)]))+-- [("a",True),("b",True)]+--+-- This is a specialised version of 'fmap'.+map :: (v->w) -> TextMap v -> TextMap w+map f (TM ks vs) = TM ks (arrayMap f vs)++-- $setup+-- >>> :set -XOverloadedStrings
+ src/Data/TextSet/Unboxed.hs view
@@ -0,0 +1,363 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE MagicHash #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE Trustworthy #-}+{-# LANGUAGE TypeFamilies #-}++-- |+-- Copyright: © 2017 Herbert Valerio Riedel+-- License: GPLv3+--+-- This module provides the 'TextSet' container for storing sets of text strings.+--+-- This module is intended to be imported @qualified@, e.g.+--+-- > import Data.TextSet.Unboxed (TextSet)+-- > import qualified Data.TextSet.Unboxed as TextSet+--+module Data.TextSet.Unboxed+ ( TextSet+ , Key+ -- * Querying & lookup+ , size+ , null+ , member+ , lookupMin+ , lookupMax+ , lookupLE+ , lookupGE++ , (!?)+ , lookupIndex++ -- * Construction+ , empty+ , singleton+ , fromList+ , fromDistinctAscList+ , fromSet++ -- * Deconstruction+ , toList+ , toArray+ , toSet++ ) where++import Control.DeepSeq+import Data.Hashable (Hashable)+import qualified Data.Set as Set+import Data.Text.Short (ShortText)+import qualified GHC.Exts as GHC+import Prelude hiding (null)++import Data.TextArray.Unboxed (TextArray)+import qualified Data.TextArray.Unboxed.Internal as TA+import Internal++-- | A set of unboxed 'ShortText' strings+--+-- The memory footprint of this data-structure is a single heap object (an unlifted 'ByteArray#') with the size expressed in words+--+-- \[+-- 3 + n + \left\lceil \frac{1}{w} \sum_{i=0}^{n-1} len(s_i) \right\rceil+-- \]+--+-- where the word-size \(w\) is either \(w = 4\) or \(w = 8\) bytes; and where \(len(s_i)\) denotes the UTF-8 size in bytes of the \(i\)-th text string.+--+-- NOTE: Depending on whether you @UNPACK@ the 'TextSet' wrapper, you need at least one additional word for the pointer to the internal 'ByteArray#' heap object.+newtype TextSet = TS TextArray+ deriving (Eq,Ord,NFData,Hashable)++type Key = ShortText++instance Show TextSet where+ showsPrec p (TS ta) = showsPrec p ta+ show (TS ta) = show ta++instance Read TextSet where+ readsPrec p = map (\(x,s) -> (TS x,s)) . readsPrec p++instance GHC.IsList TextSet where+ type Item TextSet = Key+ fromList = fromList+ toList = toList++-- | \(\mathcal{O}(1)\). An empty 'TextSet'.+empty :: TextSet+empty = TS TA.empty++-- | \(\mathcal{O}(1)\). Report number of elements in 'TextSet'.+--+-- >>> size empty+-- 0+--+-- >>> size (singleton "")+-- 1+--+-- >>> size (fromList ["Hey","Hey","Jude"])+-- 2+--+size :: TextSet -> Int+size (TS ta) = TA.length ta++-- | \(\mathcal{O}(1)\). Check for 'empty' set.+--+-- >>> null empty+-- True+--+-- >>> null (singleton "")+-- False+--+null :: TextSet -> Bool+null (TS ta) = TA.null ta+++-- | \(\mathcal{O}(1)\). Construct set containing one element.+--+-- >>> toList (singleton "alone")+-- ["alone"]+--+singleton :: Key -> TextSet+singleton = TS . TA.singleton++-- | \(\mathcal{O}(n \log n)\). Construct set from list of elements.+--+-- >>> toList (fromList ["Hey","Jude","Hey","Law","Hey",""])+-- ["","Hey","Jude","Law"]+--+fromList :: [Key] -> TextSet+fromList [] = empty+fromList [x] = singleton x+fromList xs = fromSet (Set.fromList xs)++-- | \(\mathcal{O}(n)\). Construct set from list of distinct elements in ascending order.+--+-- __NOTE__: If the input list is not strictly ascending, an 'error' is thrown.+fromDistinctAscList :: [Key] -> TextSet+fromDistinctAscList [] = empty+fromDistinctAscList xs+ | isMonotonic xs = TS (TA.fromList xs)+ | otherwise = error "fromDistinctAscList: invalid argument"++isMonotonic :: [Key] -> Bool+isMonotonic [] = True+isMonotonic [_] = True+isMonotonic (x:xs) = go x xs+ where+ go _ [] = True+ go y (y':ys)+ | y < y' = go y' ys+ | otherwise = False++-- | \(\mathcal{O}(n)\). Convert 'Set' to 'TextSet'.+fromSet :: Set.Set Key -> TextSet+fromSet = TS . TA.fromList . Set.toAscList++-- | \(\mathcal{O}(n)\). Convert 'TextSet' to 'Set'.+toSet :: TextSet -> Set.Set Key+toSet = Set.fromDistinctAscList . toList++-- | \(\mathcal{O}(n)\). Convert 'TextSet' to list of 'ShortText' in ascending order.+toList :: TextSet -> [Key]+toList (TS ta) = TA.toList ta++-- | \(\mathcal{O}(1)\). Convert 'TextSet' to 'TextArray' of 'ShortText' in ascending order.+--+-- >>> toList (fromList ["Hey","Jude","Hey","Law","Hey",""])+-- ["","Hey","Jude","Law"]+--+toArray :: TextSet -> TextArray+toArray (TS ta) = ta++-- | \(\mathcal{O}(1)\). Extract minimal element from set.+--+-- >>> lookupMin empty+-- Nothing+--+-- >>> lookupMin (fromList ["a","b","c"])+-- Just "a"+--+lookupMin :: TextSet -> Maybe Key+lookupMin (TS ta) = ta TA.!? 0++-- | \(\mathcal{O}(1)\). Extract maximal element from set.+--+-- >>> lookupMax empty+-- Nothing+--+-- >>> lookupMax (fromList ["a","b","c"])+-- Just "c"+--+lookupMax :: TextSet -> Maybe Key+lookupMax (TS ta) = ta TA.!? (TA.length ta - 1)+++-- TODO: isProperSubsetOf isSubsetOf union intersection difference++----------------------------------------------------------------------------+-- lookup++-- | \(\mathcal{O}(\log n)\). Test whether set contains a string.+--+-- >>> member "empty" empty+-- False+--+-- >>> member "a" (fromList ["a","b","c"])+-- True+--+-- >>> member "d" (fromList ["a","b","c"])+-- False+--+member :: Key -> TextSet -> Bool+member t ts = case lookupIndexNear LBelow t ts of+ LResExact _ -> True+ _ -> False+++-- | \(\mathcal{O}(1)\). Retrieve \(i\)-th element in the sorted sequence of elements.+--+-- >>> fromList ["Hey","","Jude"] !? 0+-- Just ""+--+-- >>> fromList ["Hey","","Jude"] !? 1+-- Just "Hey"+--+-- >>> fromList ["Hey","","Jude"] !? 3+-- Nothing+--+-- See also 'lookupIndex'.+(!?) :: TextSet -> Int -> Maybe Key+(TS ta) !? i = ta TA.!? i++-- | \(\mathcal{O}(\log n)\). Look up element in set and report its zero-based index in the sorted sequence elements.+--+-- >>> lookupIndex "" (fromList ["Hey","","Jude"])+-- Just 0+--+-- >>> lookupIndex "Hey" (fromList ["Hey","","Jude"])+-- Just 1+--+-- >>> lookupIndex "Law" (fromList ["Hey","","Jude"])+-- Nothing+--+-- See also '!?'.+lookupIndex :: Key -> TextSet -> Maybe Int+lookupIndex t ts = case lookupIndexNear LBelow t ts of+ LResExact (IdxOfsLen i _ _) -> Just i+ _ -> Nothing++mkist :: TextSet -> IdxOfsLen -> (Int, Key)+mkist (TS ta) (IdxOfsLen i ofs n) = (i, ba2st (sliceBA (TA.ta2ba ta) ofs n))++-- TODO: lookupLT lookupGT++-- | \(\mathcal{O}(\log n)\). Look up \"greatest\" string (together with its index) in set less or equal to given string.+--+-- >>> lookupLE "a" (fromList ["bb","cc"])+-- Nothing+--+-- >>> lookupLE "c" (fromList ["bb","cc"])+-- Just (0,"bb")+--+-- >>> lookupLE "cc" (fromList ["bb","cc"])+-- Just (1,"cc")+--+-- >>> lookupLE "z" (fromList ["bb","cc"])+-- Just (1,"cc")+--+lookupLE :: Key -> TextSet -> Maybe (Int,Key)+lookupLE t ts = case lookupIndexNear LAbove t ts of+ LResAbove res -> Just (mkist ts res)+ LResExact res -> Just (mkist ts res)+ _ -> Nothing++-- | \(\mathcal{O}(\log n)\). Look up \"least\" string (together with its index) in set greater or equal to given string.+--+-- >>> lookupGE "a" (fromList ["bb","cc"])+-- Just (0,"bb")+--+-- >>> lookupGE "c" (fromList ["bb","cc"])+-- Just (1,"cc")+--+-- >>> lookupGE "cc" (fromList ["bb","cc"])+-- Just (1,"cc")+--+-- >>> lookupGE "z" (fromList ["bb","cc"])+-- Nothing+--+lookupGE :: Key -> TextSet -> Maybe (Int,Key)+lookupGE t ts = case lookupIndexNear LBelow t ts of+ LResBelow res -> Just (mkist ts res)+ LResExact res -> Just (mkist ts res)+ _ -> Nothing++data LRes = LResEmpty -- empty set+ | LResExact !IdxOfsLen -- exact match+ | LResBelow !IdxOfsLen -- inexact match, needle is /below/ IdxOfsLen entry+ | LResAbove !IdxOfsLen -- inexact match, needle is /above/ IdxOfsLen entry+ deriving Show++-- | associativity of 'lookupIndexNear'+data LMode = LBelow -- if between two entries, return 'LResBelow'+ | LAbove -- if between two entries, return 'LResAbove'++-- Find near entry+--+-- NB: the implementation of 'lookupIndex{L,R}' differs only in two places, marked with (I) and (II) comments+lookupIndexNear :: LMode -> Key -> TextSet -> LRes+lookupIndexNear mode x (TS ta)+ | ui0 < 0 = LResEmpty+ | otherwise = case cmpBA lv0 of+ LT -> LResBelow lv0+ EQ -> LResExact lv0+ GT -> case cmpBA uv0 of+ GT -> LResAbove uv0+ EQ -> LResExact uv0+ LT -> case mode of+ LAbove -> goL li0 ui0 -- invariant: lv0 < v < uv0 && li < ui+ LBelow -> goR li0 ui0 -- invariant: lv0 < v < uv0 && li < ui+ where+ li0 = 0+ ui0 = TA.length ta - 1++ lv0, uv0 :: IdxOfsLen+ lv0 = TA.indexOfsLen' ta li0+ uv0 = TA.indexOfsLen' ta ui0++ cmpBA = cmpBA2OfsLen (st2ba x) (TA.ta2ba ta)++ -----------------------------------------------++ goL :: Int -> Int -> LRes+ goL li ui -- invariant: li < ui+ | mi == li = LResAbove mv -- closest match -- (I)+ | otherwise = case cmpBA mv of+ LT -> goL li mi -- go left+ EQ -> LResExact mv -- exact match+ GT -> goL mi ui -- go right+ where+ mi = mid li ui+ mv = TA.indexOfsLen' ta mi++ mid :: Int -> Int -> Int+ mid li' ui' = li' + quot (ui'-li') 2 -- (II)++ goR :: Int -> Int -> LRes+ goR li ui -- invariant: li < ui+ | mi == ui = LResBelow mv -- closest match -- (I)+ | otherwise = case cmpBA mv of+ LT -> goR li mi -- go left+ EQ -> LResExact mv -- exact match+ GT -> goR mi ui -- go right+ where+ mi = mid li ui+ mv = TA.indexOfsLen' ta mi++ mid :: Int -> Int -> Int+ mid li' ui' = ui' - quot (ui'-li') 2 -- (II)++++-- $setup+-- >>> :set -XOverloadedStrings
+ src/Internal.hs view
@@ -0,0 +1,240 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE MagicHash #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE UnboxedTuples #-}+{-# LANGUAGE UnliftedFFITypes #-}+{-# LANGUAGE Unsafe #-}++-- |+-- Copyright: © 2017 Herbert Valerio Riedel+-- License: GPLv3+module Internal where++import Control.DeepSeq+import Control.Monad.ST+import Data.Bits+import qualified Data.ByteString.Short as SBS+import qualified Data.ByteString.Short.Internal as SBS+import Data.Hashable (Hashable (..),+ hashByteArrayWithSalt)+import Data.Text.Short (ShortText)+import qualified Data.Text.Short as TS+import qualified Data.Text.Short.Unsafe as TS+import Foreign.C.Types+import GHC.Exts (Int (..))+import GHC.Prim+import GHC.ST (ST (ST))+import Prelude hiding (elem, length, null)+import System.IO.Unsafe++----------------------------------------------------------------------------+-- GHC (Mutable)ByteArray# helpers++-- | Wordsize in bytes+wordSize :: Int+wordSize = case finiteBitSize (0 :: Int) of+ 32 -> 4+ 64 -> 8+ _ -> error "unsupported wordSize"++data BA = BA# ByteArray#+data MBA s = MBA# (MutableByteArray# s)++ba2sbs :: BA -> SBS.ShortByteString+ba2sbs (BA# x) = SBS.SBS x++ba2st :: BA -> ShortText+ba2st = TS.fromShortByteStringUnsafe . ba2sbs++st2ba :: ShortText -> BA+st2ba x = case TS.toShortByteString x of+ SBS.SBS y -> BA# y++copyByteArray :: BA -> Int -> MBA s -> Int -> Int -> ST s ()+copyByteArray (BA# src#) (I# srcOfs#) (MBA# dest#) (I# destOfs#) (I# n#)+ = ST $ \s -> case copyByteArray# src# srcOfs# dest# destOfs# n# s of+ s' -> (# s', () #)++indexIntArray :: BA -> Int -> Int+indexIntArray (BA# ba#) (I# i#)+ = I# (indexIntArray# ba# i#)++sizeOfByteArray :: BA -> Int+sizeOfByteArray (BA# ba#) = I# (sizeofByteArray# ba#)++writeIntArray :: MBA s -> Int -> Int -> ST s ()+writeIntArray (MBA# mba#) (I# i#) (I# j#)+ = ST $ \s -> case writeIntArray# mba# i# j# s of+ s' -> (# s', () #)++newByteArray :: Int -> ST s (MBA s)+newByteArray (I# n#)+ = ST $ \s -> case newByteArray# n# s of+ (# s', mba# #) -> (# s', MBA# mba# #)++unsafeFreezeByteArray :: MBA s -> ST s BA+unsafeFreezeByteArray (MBA# mba#)+ = ST $ \s -> case unsafeFreezeByteArray# mba# s of+ (# s', ba# #) -> (# s', BA# ba# #)++createBA :: Int -> (forall s. MBA s -> ST s ()) -> BA+createBA n go = runST $ do+ mba <- newByteArray n+ go mba+ unsafeFreezeByteArray mba++sliceBA :: BA -> Int -> Int -> BA+sliceBA orig ofs0 n = createBA n $ \mba -> copyByteArray orig ofs0 mba 0 n++instance Hashable BA where+ hashWithSalt salt ba@(BA# ba#) = hashByteArrayWithSalt ba# 0 (sizeOfByteArray ba) salt++----------------------------------------------------------------------------++data A e = A# (Array# e)+data MA s e = MA# (MutableArray# s e)++sizeofArray :: A e -> Int+sizeofArray (A# a#) = I# (sizeofArray# a#)++indexArray :: A e -> Int -> e+indexArray (A# a#) (I# i#)+ = case indexArray# a# i# of (# e #) -> e++writeArray :: MA s e -> Int -> e -> ST s ()+writeArray (MA# ma#) (I# i#) e+ = ST $ \s -> case writeArray# ma# i# e s of+ s' -> (# s', () #)++newArray :: Int -> e -> ST s (MA s e)+newArray (I# n#) e+ = ST $ \s -> case newArray# n# e s of+ (# s', ma# #) -> (# s', MA# ma# #)++unsafeFreezeArray :: MA s e -> ST s (A e)+unsafeFreezeArray (MA# ma#)+ = ST $ \s -> case unsafeFreezeArray# ma# s of+ (# s', a# #) -> (# s', A# a# #)++createA :: Int -> e -> (forall s. MA s e -> ST s ()) -> A e+createA n e go = runST $ do+ ma <- newArray n e+ go ma+ unsafeFreezeArray ma++{-# NOINLINE emptyA #-}+emptyA :: A e+emptyA = runST $ do+ ma <- newArray 0 undefined+ unsafeFreezeArray ma++arraySingleton :: e -> A e+arraySingleton x = runST $ do+ ma <- newArray 1 x+ unsafeFreezeArray ma++arrayFromListN :: Int -> [e] -> A e+arrayFromListN n xs0 = createA n undefined $ \ma -> do+ let go !_ [] = pure ()+ go !i (x:xs) = do+ writeArray ma i x+ go (i+1) xs+ go 0 xs0++arrayMap :: (a->b) -> A a -> A b+arrayMap f arr = createA sz undefined $ \ma -> do+ let go i | i < sz = do+ writeArray ma i (f (indexArray arr i))+ go (i+1)+ | otherwise = pure ()+ go 0+ where+ !sz = sizeofArray arr++arrayTraverse :: Applicative f => (a -> f b) -> A a -> f (A b)+arrayTraverse act arr = arrayFromListN (sizeofArray arr) <$> traverse act (arrayToList arr)++arrayToList :: A e -> [e]+arrayToList arr = go 0+ where+ !sz = sizeofArray arr+ go i | i < sz = indexArray arr i : go (i+1)+ | otherwise = []++instance NFData e => NFData (A e) where+ rnf arr = rnf (arrayToList arr)++instance Show e => Show (A e) where+ showsPrec p = showsPrec p . arrayToList++instance Eq e => Eq (A e) where+ xs == ys = arrayToList xs == arrayToList ys++instance Ord e => Ord (A e) where+ compare xs ys = compare (arrayToList xs) (arrayToList ys)++instance Functor A where+ fmap = arrayMap+ v <$ arr0 = runST $ do+ ma <- newArray (sizeofArray arr0) v+ unsafeFreezeArray ma++instance Hashable e => Hashable (A e) where+ hashWithSalt salt = hashWithSalt salt . arrayToList++----------------------------------------------------------------------------++equalByteArray :: BA -> Int -> Int -> BA -> Int -> Int -> Bool+equalByteArray (BA# ba1#) !ofs1 !n1 (BA# ba2#) !ofs2 !n2+ | n1 /= n2 = False+ | n1 == 0 = True+ | otherwise = unsafeDupablePerformIO (c_memcmp ba1# (fromIntegral ofs1) ba2# (fromIntegral ofs2) (fromIntegral n2)) == 0++compareByteArray :: BA -> Int -> Int -> BA -> Int -> Int -> Ordering+compareByteArray (BA# ba1#) !ofs1 !n1 (BA# ba2#) !ofs2 !n2+ | n == 0 = compare n1 n2+ | otherwise = case unsafeDupablePerformIO (c_memcmp ba1# (fromIntegral ofs1) ba2# (fromIntegral ofs2) (fromIntegral n)) of+ r | r < 0 -> LT+ | r > 0 -> GT+ | n1 < n2 -> LT+ | n1 > n2 -> GT+ | otherwise -> EQ+ where+ n = n1 `min` n2++data IdxOfsLen = IdxOfsLen !Int !Int !Int+ deriving Show++cmpBA2OfsLen :: BA -> BA -> IdxOfsLen -> Ordering+cmpBA2OfsLen !ba !ba2 = \(IdxOfsLen _ ofs n) -> compareByteArray ba 0 (sizeOfByteArray ba) ba2 ofs n++foreign import ccall unsafe "hs_text_containers_memcmp"+ c_memcmp :: ByteArray# -> CSize -> ByteArray# -> CSize -> CSize -> IO CInt+++++{-+hexdumpBA :: BA -> String+hexdumpBA ba = go 0+ where+ go j | j < sz = (h (indexWord8Array ba j) (spacer (go (j+1))))+ | otherwise = ""+ where+ spacer = if j `rem` 8 == 7 then (' ':) else id++ sz = sizeOfByteArray ba++ h :: Word8 -> ShowS+ h x | x < 0x10 = showHex x . ('0':)+ | otherwise = showHex x++ indexWord8Array :: BA -> Int -> Word8+ indexWord8Array (BA# ba#) (I# i#)+ = W8# (indexWord8Array# ba# i#)+-}++++
+ text-containers.cabal view
@@ -0,0 +1,94 @@+cabal-version: 2.0++name: text-containers+version: 0.1.0.0+synopsis: Memory-efficient string-indexed container types.++copyright: © 2017 Herbert Valerio Riedel+license: GPL-3+license-file: LICENSE+author: Herbert Valerio Riedel+maintainer: hvr@gnu.org+category: Data, Data Structures+build-type: Simple+bug-reports: https://github.com/hvr/text-containers/issues++description: {+This package provides memory-optimised implementations of string-indexed container types.+.+The API is aligned with the naming convention of the [containers](https://hackage.haskell.org/package/containers) package's API.+.+The following data-structures are provided:+.+["Data.TextArray.Unboxed"] Array of unboxed 'ShortText' strings.+["Data.TextSet.Unboxed"] Set of unboxed 'ShortText' strings.+["Data.TextMap.Unboxed.Lazy"] Associative map from unboxed 'ShortText' keys to non-strict values.+.+Where /unboxed ShortText/ refers to strings being stored in their UTF-8 representation without any alignment/padding back-to-back thereby providing good memory locality for index operations, avoiding pointer chasing, as well as increasing memory efficiency by reducing memory waste due to alignment.+}++source-repository head+ type: git+ location: https://github.com/hvr/text-containers.git++library+ default-language: Haskell2010++ exposed-modules: Data.TextArray.Unboxed+ Data.TextSet.Unboxed+ Data.TextMap.Unboxed.Lazy++ other-modules: Data.TextArray.Unboxed.Internal+ Internal++ build-depends: base ^>= 4.8.0.0 || ^>= 4.9.0.0 || ^>= 4.10.0.0+ , ghc-prim ^>= 0.4.0.0 || ^>= 0.5.0.0++ , bytestring ^>= 0.10.6+ , containers ^>= 0.5.6.2+ , deepseq ^>= 1.4.1.1+ , hashable ^>= 1.2.6.1+ , text-short ^>= 0.1.1++ hs-source-dirs: src++ c-sources: cbits/cbits.c++ if !impl(ghc >= 8.0)+ build-depends: semigroups ^>= 0.18.3++ ghc-options: -Wall++ if impl(ghc >= 8.0)+ ghc-options: -Wcompat -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances+++test-suite text-containers+ default-language: Haskell2010++ hs-source-dirs: src-tests+ main-is: tests.hs++ type: exitcode-stdio-1.0++ -- internal dependency+ build-depends: text-containers++ -- constraints inherited via lib:text-containers component+ build-depends: base+ , bytestring+ , containers+ , text-short++ -- dependencies requiring constraints+ build-depends: QuickCheck ^>= 2.10.1+ , quickcheck-instances ^>= 0.3.16+ , tasty ^>= 0.11.2.5+ , tasty-quickcheck ^>= 0.9.1+ , text ^>= 1.2.2.2+ , vector ^>= 0.12.0.1++ ghc-options: -Wall++ if impl(ghc >= 8.0)+ ghc-options: -Wcompat -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances