on 2aff258 help sign in
.github/CODEOWNERSdeleted−1
since splitsnapshots
unifiedsplit
@@ -1 +0,0 @@
1−* @chshersh @vrom911
.github/workflows/ci.ymldeleted−47
@@ -1,47 +0,0 @@
1−name: CI
2−
3−# Trigger the workflow on push or pull request, but only for the main branch
4−on:
5− push:
6− branches:
7− - main
8− pull_request:
9−
10−jobs:
11− build:
12− name: ghc ${{ matrix.ghc }}
13− runs-on: ubuntu-16.04
14− strategy:
15− matrix:
16− cabal: ["3.0"]
17− ghc:
18− - "8.2.2"
19− - "8.4.4"
20− - "8.6.5"
21− - "8.8.3"
22− - "8.10.1"
23−
24− steps:
25− - uses: actions/checkout@v2
26− if: github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.ref == 'refs/heads/main'
27−
28− - uses: actions/setup-haskell@v1
29− name: Setup Haskell
30− with:
31− ghc-version: ${{ matrix.ghc }}
32− cabal-version: ${{ matrix.cabal }}
33−
34− - uses: actions/cache@v1
35− name: Cache ~/.cabal/store
36− with:
37− path: ~/.cabal/store
38− key: ${{ runner.os }}-${{ matrix.ghc }}-cabal
39−
40− - name: Build
41− run: |
42− cabal update
43− cabal build --enable-tests --enable-benchmarks all
44−
45− - name: Test
46− run: |
47− cabal test --enable-tests --test-show-details=direct all
.travis.yml+26−10
@@ -1,28 +1,44 @@
1sudo: true
1sudo: true
2−language: generic
2+language: haskell
3
3
4git:
4git:
5 depth: 5
5 depth: 5
6
6
7+cabal: "2.4"
8+
7cache:
9cache:
8 directories:
10 directories:
11+ - "$HOME/.cabal/store"
9 - "$HOME/.stack"
12 - "$HOME/.stack"
13+ - "$TRAVIS_BUILD_DIR/.stack-work"
10
14
11matrix:
15matrix:
12 include:
16 include:
13− - env: GHC='8.8.3'
17+ - ghc: 8.2.2
14− os: linux
18+ - ghc: 8.4.4
15− - env: GHC='8.8.3'
19+ - ghc: 8.6.5
16− os: osx
20+
21+ - ghc: 8.6.5
22+ env: STACK_YAML="$TRAVIS_BUILD_DIR/stack.yaml"
17
23
18install:
24install:
19− # install stack and build project
25+ - |
26+ if [ -z "$STACK_YAML" ]; then
27+ cabal new-update
28+ cabal new-build --enable-tests --enable-benchmarks
29+ else
20− - curl -sSL https://get.haskellstack.org/ | sh
30+ curl -sSL https://get.haskellstack.org/ | sh
21− - stack --version
31+ stack --version
22− - stack build --test --no-run-tests --bench --no-run-benchmarks
32+ stack build --system-ghc --test --no-run-tests
33+ fi
23
34
24script:
35script:
36+ - |
37+ if [ -z "$STACK_YAML" ]; then
38+ cabal new-test --enable-tests
39+ else
25− - stack test --no-terminal
40+ stack build --system-ghc --test --bench --no-run-benchmarks --no-terminal --ghc-options=-Werror
41+ fi
26
42
27notifications:
43notifications:
28 email: false
44 email: false
CHANGELOG.md+2−12
@@ -3,17 +3,6 @@
3`typerep-map` uses [PVP Versioning][1].
3`typerep-map` uses [PVP Versioning][1].
4The changelog is available [on GitHub][2].
4The changelog is available [on GitHub][2].
5
5
6−## 0.3.3.0 — Apr 18, 2020
7−
8−* [#83](https://github.com/kowainik/typerep-map/issues/83):
9− Support GHC-8.10.
10−* [#80](https://github.com/kowainik/typerep-map/issues/80):
11− Build on 32-bit platforms.
12−* [#78](https://github.com/kowainik/typerep-map/issues/78):
13− Support GHC-8.8.3.
14−* [#63](https://github.com/kowainik/typerep-map/pull/63):
15− Add invariant check.
16−
17## 0.3.2 — Mar 27, 2019
6## 0.3.2 — Mar 27, 2019
18
7
19* [#47](https://github.com/kowainik/typerep-map/issues/47):
8* [#47](https://github.com/kowainik/typerep-map/issues/47):
@@ -38,6 +27,7 @@ The changelog is available [on GitHub][2].
38 Rewrite `fromSortedList` to use `Array` and `MutableArray`
27 Rewrite `fromSortedList` to use `Array` and `MutableArray`
39 instead of `IntMap`.
28 instead of `IntMap`.
40
29
30+
41## 0.2.0
31## 0.2.0
42
32
43* [#43](https://github.com/kowainik/typerep-map/issues/43):
33* [#43](https://github.com/kowainik/typerep-map/issues/43):
@@ -53,4 +43,4 @@ The changelog is available [on GitHub][2].
53* Initially created.
43* Initially created.
54
44
55[1]: https://pvp.haskell.org
45[1]: https://pvp.haskell.org
56−[2]: https://github.com/kowainik/typerep-map/releases
46+[2]: https://github.com/kowainik/typerep-map/blob/master/CHANGELOG.md
CONTRIBUTING.mdnew file+53
@@ -0,0 +1,53 @@
1+# Contributing to the Kowainik repositories
2+
3+## :wave: Greetings Traveler!
4+
5+We are delighted you're reading this, and we appreciate the effort you're
6+taking to make our projects awesome! :sparkles:
7+
8+## How to contribute
9+
10+### :bug: Report bugs or feature request :bulb:
11+
12+If you discover a bug or have any proposals on how to make this project better
13+don't hesitate to create an issue [here](../../issues/new) in a free format.
14+
15+### Create a PR
16+
17+We love to receive pull requests from everyone! It's usually a good idea
18+to tell about your intention to work on something under the corresponding
19+issue, so everyone is aware that you're on it. If there's no such issue — simply
20+create a new one!
21+
22+To get started with the Pull Request implementation you should first
23+[fork](../../fork), then clone the repo:
24+
25+ git clone git@github.com:your-username/project-name.git
26+
27+Make your changes and consider the following checklist to go through
28+before submitting your pull request.
29+
30+### :white_check_mark: Check list
31+- [ ] New/fixed features work as expected (Bonus points for the new tests).
32+- [ ] There are no warnings during compilation.
33+- [ ] `hlint .` output is: _No Hints_ (see [`hlint`][hlint] tool docs).
34+- [ ] The code is formatted with the [`stylish-haskell`][stylish-tool] tool
35+ using [stylish-haskell.yaml][stylish] file in the repository.
36+- [ ] The code style of the files you changed is preserved (for more specific
37+ details on our style guide check [this document][style-guide]).
38+- [ ] Commit messages are in the proper format.
39+ Start the first line of the commit with the issue number in square parentheses.
40+
41+ **_Example:_** `[#42] Upgrade upper bounds of 'base'`
42+
43+After all above is done commit and push to your fork.
44+Now you are ready to [submit a pull request](../../compare).
45+
46+
47+----------
48+Thanks for spending your time on reading this contributing guide! :sparkling_heart:
49+
50+[stylish]: .stylish-haskell.yaml
51+[stylish-tool]: http://hackage.haskell.org/package/stylish-haskell
52+[hlint]: http://hackage.haskell.org/package/hlint
53+[style-guide]: https://github.com/kowainik/org/blob/master/style-guide.md#haskell-style-guide
LICENSE+21−373
@@ -1,373 +1,21 @@
1−Mozilla Public License Version 2.0
1+MIT License
2−==================================
2+
3−
3+Copyright (c) 2017 Veronika Romashkina
4−1. Definitions
4+
5−--------------
5+Permission is hereby granted, free of charge, to any person obtaining a copy
6−
6+of this software and associated documentation files (the "Software"), to deal
7−1.1. "Contributor"
7+in the Software without restriction, including without limitation the rights
8− means each individual or legal entity that creates, contributes to
8+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9− the creation of, or owns Covered Software.
9+copies of the Software, and to permit persons to whom the Software is
10−
10+furnished to do so, subject to the following conditions:
11−1.2. "Contributor Version"
11+
12− means the combination of the Contributions of others (if any) used
12+The above copyright notice and this permission notice shall be included in all
13− by a Contributor and that particular Contributor's Contribution.
13+copies or substantial portions of the Software.
14−
14+
15−1.3. "Contribution"
15+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16− means Covered Software of a particular Contributor.
16+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17−
17+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18−1.4. "Covered Software"
18+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19− means Source Code Form to which the initial Contributor has attached
19+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20− the notice in Exhibit A, the Executable Form of such Source Code
20+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21− Form, and Modifications of such Source Code Form, in each case
21+SOFTWARE.
22− including portions thereof.
23−
24−1.5. "Incompatible With Secondary Licenses"
25− means
26−
27− (a) that the initial Contributor has attached the notice described
28− in Exhibit B to the Covered Software; or
29−
30− (b) that the Covered Software was made available under the terms of
31− version 1.1 or earlier of the License, but not also under the
32− terms of a Secondary License.
33−
34−1.6. "Executable Form"
35− means any form of the work other than Source Code Form.
36−
37−1.7. "Larger Work"
38− means a work that combines Covered Software with other material, in
39− a separate file or files, that is not Covered Software.
40−
41−1.8. "License"
42− means this document.
43−
44−1.9. "Licensable"
45− means having the right to grant, to the maximum extent possible,
46− whether at the time of the initial grant or subsequently, any and
47− all of the rights conveyed by this License.
48−
49−1.10. "Modifications"
50− means any of the following:
51−
52− (a) any file in Source Code Form that results from an addition to,
53− deletion from, or modification of the contents of Covered
54− Software; or
55−
56− (b) any new file in Source Code Form that contains any Covered
57− Software.
58−
59−1.11. "Patent Claims" of a Contributor
60− means any patent claim(s), including without limitation, method,
61− process, and apparatus claims, in any patent Licensable by such
62− Contributor that would be infringed, but for the grant of the
63− License, by the making, using, selling, offering for sale, having
64− made, import, or transfer of either its Contributions or its
65− Contributor Version.
66−
67−1.12. "Secondary License"
68− means either the GNU General Public License, Version 2.0, the GNU
69− Lesser General Public License, Version 2.1, the GNU Affero General
70− Public License, Version 3.0, or any later versions of those
71− licenses.
72−
73−1.13. "Source Code Form"
74− means the form of the work preferred for making modifications.
75−
76−1.14. "You" (or "Your")
77− means an individual or a legal entity exercising rights under this
78− License. For legal entities, "You" includes any entity that
79− controls, is controlled by, or is under common control with You. For
80− purposes of this definition, "control" means (a) the power, direct
81− or indirect, to cause the direction or management of such entity,
82− whether by contract or otherwise, or (b) ownership of more than
83− fifty percent (50%) of the outstanding shares or beneficial
84− ownership of such entity.
85−
86−2. License Grants and Conditions
87−--------------------------------
88−
89−2.1. Grants
90−
91−Each Contributor hereby grants You a world-wide, royalty-free,
92−non-exclusive license:
93−
94−(a) under intellectual property rights (other than patent or trademark)
95− Licensable by such Contributor to use, reproduce, make available,
96− modify, display, perform, distribute, and otherwise exploit its
97− Contributions, either on an unmodified basis, with Modifications, or
98− as part of a Larger Work; and
99−
100−(b) under Patent Claims of such Contributor to make, use, sell, offer
101− for sale, have made, import, and otherwise transfer either its
102− Contributions or its Contributor Version.
103−
104−2.2. Effective Date
105−
106−The licenses granted in Section 2.1 with respect to any Contribution
107−become effective for each Contribution on the date the Contributor first
108−distributes such Contribution.
109−
110−2.3. Limitations on Grant Scope
111−
112−The licenses granted in this Section 2 are the only rights granted under
113−this License. No additional rights or licenses will be implied from the
114−distribution or licensing of Covered Software under this License.
115−Notwithstanding Section 2.1(b) above, no patent license is granted by a
116−Contributor:
117−
118−(a) for any code that a Contributor has removed from Covered Software;
119− or
120−
121−(b) for infringements caused by: (i) Your and any other third party's
122− modifications of Covered Software, or (ii) the combination of its
123− Contributions with other software (except as part of its Contributor
124− Version); or
125−
126−(c) under Patent Claims infringed by Covered Software in the absence of
127− its Contributions.
128−
129−This License does not grant any rights in the trademarks, service marks,
130−or logos of any Contributor (except as may be necessary to comply with
131−the notice requirements in Section 3.4).
132−
133−2.4. Subsequent Licenses
134−
135−No Contributor makes additional grants as a result of Your choice to
136−distribute the Covered Software under a subsequent version of this
137−License (see Section 10.2) or under the terms of a Secondary License (if
138−permitted under the terms of Section 3.3).
139−
140−2.5. Representation
141−
142−Each Contributor represents that the Contributor believes its
143−Contributions are its original creation(s) or it has sufficient rights
144−to grant the rights to its Contributions conveyed by this License.
145−
146−2.6. Fair Use
147−
148−This License is not intended to limit any rights You have under
149−applicable copyright doctrines of fair use, fair dealing, or other
150−equivalents.
151−
152−2.7. Conditions
153−
154−Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155−in Section 2.1.
156−
157−3. Responsibilities
158−-------------------
159−
160−3.1. Distribution of Source Form
161−
162−All distribution of Covered Software in Source Code Form, including any
163−Modifications that You create or to which You contribute, must be under
164−the terms of this License. You must inform recipients that the Source
165−Code Form of the Covered Software is governed by the terms of this
166−License, and how they can obtain a copy of this License. You may not
167−attempt to alter or restrict the recipients' rights in the Source Code
168−Form.
169−
170−3.2. Distribution of Executable Form
171−
172−If You distribute Covered Software in Executable Form then:
173−
174−(a) such Covered Software must also be made available in Source Code
175− Form, as described in Section 3.1, and You must inform recipients of
176− the Executable Form how they can obtain a copy of such Source Code
177− Form by reasonable means in a timely manner, at a charge no more
178− than the cost of distribution to the recipient; and
179−
180−(b) You may distribute such Executable Form under the terms of this
181− License, or sublicense it under different terms, provided that the
182− license for the Executable Form does not attempt to limit or alter
183− the recipients' rights in the Source Code Form under this License.
184−
185−3.3. Distribution of a Larger Work
186−
187−You may create and distribute a Larger Work under terms of Your choice,
188−provided that You also comply with the requirements of this License for
189−the Covered Software. If the Larger Work is a combination of Covered
190−Software with a work governed by one or more Secondary Licenses, and the
191−Covered Software is not Incompatible With Secondary Licenses, this
192−License permits You to additionally distribute such Covered Software
193−under the terms of such Secondary License(s), so that the recipient of
194−the Larger Work may, at their option, further distribute the Covered
195−Software under the terms of either this License or such Secondary
196−License(s).
197−
198−3.4. Notices
199−
200−You may not remove or alter the substance of any license notices
201−(including copyright notices, patent notices, disclaimers of warranty,
202−or limitations of liability) contained within the Source Code Form of
203−the Covered Software, except that You may alter any license notices to
204−the extent required to remedy known factual inaccuracies.
205−
206−3.5. Application of Additional Terms
207−
208−You may choose to offer, and to charge a fee for, warranty, support,
209−indemnity or liability obligations to one or more recipients of Covered
210−Software. However, You may do so only on Your own behalf, and not on
211−behalf of any Contributor. You must make it absolutely clear that any
212−such warranty, support, indemnity, or liability obligation is offered by
213−You alone, and You hereby agree to indemnify every Contributor for any
214−liability incurred by such Contributor as a result of warranty, support,
215−indemnity or liability terms You offer. You may include additional
216−disclaimers of warranty and limitations of liability specific to any
217−jurisdiction.
218−
219−4. Inability to Comply Due to Statute or Regulation
220−---------------------------------------------------
221−
222−If it is impossible for You to comply with any of the terms of this
223−License with respect to some or all of the Covered Software due to
224−statute, judicial order, or regulation then You must: (a) comply with
225−the terms of this License to the maximum extent possible; and (b)
226−describe the limitations and the code they affect. Such description must
227−be placed in a text file included with all distributions of the Covered
228−Software under this License. Except to the extent prohibited by statute
229−or regulation, such description must be sufficiently detailed for a
230−recipient of ordinary skill to be able to understand it.
231−
232−5. Termination
233−--------------
234−
235−5.1. The rights granted under this License will terminate automatically
236−if You fail to comply with any of its terms. However, if You become
237−compliant, then the rights granted under this License from a particular
238−Contributor are reinstated (a) provisionally, unless and until such
239−Contributor explicitly and finally terminates Your grants, and (b) on an
240−ongoing basis, if such Contributor fails to notify You of the
241−non-compliance by some reasonable means prior to 60 days after You have
242−come back into compliance. Moreover, Your grants from a particular
243−Contributor are reinstated on an ongoing basis if such Contributor
244−notifies You of the non-compliance by some reasonable means, this is the
245−first time You have received notice of non-compliance with this License
246−from such Contributor, and You become compliant prior to 30 days after
247−Your receipt of the notice.
248−
249−5.2. If You initiate litigation against any entity by asserting a patent
250−infringement claim (excluding declaratory judgment actions,
251−counter-claims, and cross-claims) alleging that a Contributor Version
252−directly or indirectly infringes any patent, then the rights granted to
253−You by any and all Contributors for the Covered Software under Section
254−2.1 of this License shall terminate.
255−
256−5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257−end user license agreements (excluding distributors and resellers) which
258−have been validly granted by You or Your distributors under this License
259−prior to termination shall survive termination.
260−
261−************************************************************************
262−* *
263−* 6. Disclaimer of Warranty *
264−* ------------------------- *
265−* *
266−* Covered Software is provided under this License on an "as is" *
267−* basis, without warranty of any kind, either expressed, implied, or *
268−* statutory, including, without limitation, warranties that the *
269−* Covered Software is free of defects, merchantable, fit for a *
270−* particular purpose or non-infringing. The entire risk as to the *
271−* quality and performance of the Covered Software is with You. *
272−* Should any Covered Software prove defective in any respect, You *
273−* (not any Contributor) assume the cost of any necessary servicing, *
274−* repair, or correction. This disclaimer of warranty constitutes an *
275−* essential part of this License. No use of any Covered Software is *
276−* authorized under this License except under this disclaimer. *
277−* *
278−************************************************************************
279−
280−************************************************************************
281−* *
282−* 7. Limitation of Liability *
283−* -------------------------- *
284−* *
285−* Under no circumstances and under no legal theory, whether tort *
286−* (including negligence), contract, or otherwise, shall any *
287−* Contributor, or anyone who distributes Covered Software as *
288−* permitted above, be liable to You for any direct, indirect, *
289−* special, incidental, or consequential damages of any character *
290−* including, without limitation, damages for lost profits, loss of *
291−* goodwill, work stoppage, computer failure or malfunction, or any *
292−* and all other commercial damages or losses, even if such party *
293−* shall have been informed of the possibility of such damages. This *
294−* limitation of liability shall not apply to liability for death or *
295−* personal injury resulting from such party's negligence to the *
296−* extent applicable law prohibits such limitation. Some *
297−* jurisdictions do not allow the exclusion or limitation of *
298−* incidental or consequential damages, so this exclusion and *
299−* limitation may not apply to You. *
300−* *
301−************************************************************************
302−
303−8. Litigation
304−-------------
305−
306−Any litigation relating to this License may be brought only in the
307−courts of a jurisdiction where the defendant maintains its principal
308−place of business and such litigation shall be governed by laws of that
309−jurisdiction, without reference to its conflict-of-law provisions.
310−Nothing in this Section shall prevent a party's ability to bring
311−cross-claims or counter-claims.
312−
313−9. Miscellaneous
314−----------------
315−
316−This License represents the complete agreement concerning the subject
317−matter hereof. If any provision of this License is held to be
318−unenforceable, such provision shall be reformed only to the extent
319−necessary to make it enforceable. Any law or regulation which provides
320−that the language of a contract shall be construed against the drafter
321−shall not be used to construe this License against a Contributor.
322−
323−10. Versions of the License
324−---------------------------
325−
326−10.1. New Versions
327−
328−Mozilla Foundation is the license steward. Except as provided in Section
329−10.3, no one other than the license steward has the right to modify or
330−publish new versions of this License. Each version will be given a
331−distinguishing version number.
332−
333−10.2. Effect of New Versions
334−
335−You may distribute the Covered Software under the terms of the version
336−of the License under which You originally received the Covered Software,
337−or under the terms of any subsequent version published by the license
338−steward.
339−
340−10.3. Modified Versions
341−
342−If you create software not governed by this License, and you want to
343−create a new license for such software, you may create and use a
344−modified version of this License if you rename the license and remove
345−any references to the name of the license steward (except to note that
346−such modified license differs from this License).
347−
348−10.4. Distributing Source Code Form that is Incompatible With Secondary
349−Licenses
350−
351−If You choose to distribute Source Code Form that is Incompatible With
352−Secondary Licenses under the terms of this version of the License, the
353−notice described in Exhibit B of this License must be attached.
354−
355−Exhibit A - Source Code Form License Notice
356−-------------------------------------------
357−
358− This Source Code Form is subject to the terms of the Mozilla Public
359− License, v. 2.0. If a copy of the MPL was not distributed with this
360− file, You can obtain one at http://mozilla.org/MPL/2.0/.
361−
362−If it is not possible or desirable to put the notice in a particular
363−file, then You may include the notice in a location (such as a LICENSE
364−file in a relevant directory) where a recipient would be likely to look
365−for such a notice.
366−
367−You may add additional accurate notices of copyright ownership.
368−
369−Exhibit B - "Incompatible With Secondary Licenses" Notice
370−---------------------------------------------------------
371−
372− This Source Code Form is "Incompatible With Secondary Licenses", as
373− defined by the Mozilla Public License, v. 2.0.
README.md+7−13
@@ -1,21 +1,15 @@
1# typerep-map
1# typerep-map
2
2
3−![logo](https://user-images.githubusercontent.com/8126674/44323413-788dd700-a484-11e8-842e-f224cfaa4206.png)
3+![electricity](https://user-images.githubusercontent.com/8126674/44323413-788dd700-a484-11e8-842e-f224cfaa4206.png)
4−
5−[![GitHub CI](https://github.com/kowainik/typerep-map/workflows/CI/badge.svg)](https://github.com/kowainik/typerep-map/actions)
6[![Build status](https://img.shields.io/travis/kowainik/typerep-map.svg?logo=travis)](https://travis-ci.org/kowainik/typerep-map)
4[![Build status](https://img.shields.io/travis/kowainik/typerep-map.svg?logo=travis)](https://travis-ci.org/kowainik/typerep-map)
7−[![Windows build status](https://ci.appveyor.com/api/projects/status/github/kowainik/typerep-map?branch=main&svg=true)](https://ci.appveyor.com/project/kowainik/typerep-map)
8[![Hackage](https://img.shields.io/hackage/v/typerep-map.svg?logo=haskell)](https://hackage.haskell.org/package/typerep-map)
5[![Hackage](https://img.shields.io/hackage/v/typerep-map.svg?logo=haskell)](https://hackage.haskell.org/package/typerep-map)
9[![Stackage LTS](http://stackage.org/package/typerep-map/badge/lts)](http://stackage.org/lts/package/typerep-map)
6[![Stackage LTS](http://stackage.org/package/typerep-map/badge/lts)](http://stackage.org/lts/package/typerep-map)
10[![Stackage Nightly](http://stackage.org/package/typerep-map/badge/nightly)](http://stackage.org/nightly/package/typerep-map)
7[![Stackage Nightly](http://stackage.org/package/typerep-map/badge/nightly)](http://stackage.org/nightly/package/typerep-map)
11−[![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)
8+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vrom911/typerep-map/blob/master/LICENSE)
12−
13
9
14`typerep-map` introduces `TMap` and `TypeRepMap` — data structures like [`Map`](http://hackage.haskell.org/package/containers-0.6.0.1/docs/Data-Map-Lazy.html#t:Map), but where types serve as keys, and values have the types specified in the corresponding key spots.
10`typerep-map` introduces `TMap` and `TypeRepMap` — data structures like [`Map`](http://hackage.haskell.org/package/containers-0.6.0.1/docs/Data-Map-Lazy.html#t:Map), but where types serve as keys, and values have the types specified in the corresponding key spots.
15
11
16−For the more details on the implementation see the following blog post:
17−
18−* [typerep-map step by step](https://kowainik.github.io/posts/2018-07-11-typerep-map-step-by-step)
12+For the more details on the implementation see [this blog post](https://kowainik.github.io/posts/2018-07-11-typerep-map-step-by-step).
19
13
20## Usage example
14## Usage example
21
15
@@ -55,10 +49,10 @@ False
55Tables below contain comparision with `DMap TypeRep` of ten `lookup` operations
49Tables below contain comparision with `DMap TypeRep` of ten `lookup` operations
56on structure with size `10^4`:
50on structure with size `10^4`:
57
51
58−| | ghc-8.2.2 | ghc-8.4.3 | ghc-8.8.3 | ghc-8.10.1 |
52+| | ghc-8.2.2 | ghc-8.4.3 |
59−|----------------|-----------|-----------|-----------|------------|
53+|----------------|-----------|-----------|
60−| `DMap TypeRep` | 517.5 ns | 779.9 ns | 1.559 μs | 1.786 μs |
54+| `DMap TypeRep` | 517.5 ns | 779.9 ns |
61−| `typerep-map` | 205.3 ns | 187.2 ns | 190.1 ns | 169.1 ns |
55+| `typerep-map` | 205.3 ns | 187.2 ns |
62
56
63 ghc-8.2.2 | ghc-8.4.3
57 ghc-8.2.2 | ghc-8.4.3
64:---------:|:-----------:
58:---------:|:-----------:
appveyor.ymldeleted−35
@@ -1,35 +0,0 @@
1−clone_folder: "c:\\WORK"
2−clone_depth: 5
3−
4−# Do not build feature branch with open Pull Requests
5−skip_branch_with_pr: true
6−
7−platform:
8− - x86
9− - x86_64
10−
11−cache:
12− - "C:\\SR"
13− - dist-newstyle
14−
15−environment:
16− global:
17− CABOPTS: --store-dir=C:\\SR
18−
19− matrix:
20− - GHCVER: 8.8.3
21−
22−install:
23− - choco source add -n mistuke -s https://www.myget.org/F/mistuke/api/v2
24− - choco install -y cabal --version 3.0.0.0
25− - choco install -y ghc --version 8.8.3
26− - refreshenv
27−
28−before_build:
29− - cabal --version
30− - ghc --version
31− - cabal %CABOPTS% update
32−
33−build_script:
34− - cabal %CABOPTS% build --enable-tests --write-ghc-environment-files=always
35− - cabal %CABOPTS% test --enable-tests
benchmark/CMap.hs+39−46
@@ -1,77 +1,70 @@
1−{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
2−
3{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE ExplicitNamespaces #-}
3+{-# LANGUAGE KindSignatures #-}
4{-# LANGUAGE PolyKinds #-}
4{-# LANGUAGE PolyKinds #-}
5{-# LANGUAGE TypeFamilies #-}
5{-# LANGUAGE TypeFamilies #-}
6{-# LANGUAGE TypeOperators #-}
6{-# LANGUAGE TypeOperators #-}
7{-# LANGUAGE UndecidableInstances #-}
7{-# LANGUAGE UndecidableInstances #-}
8
8
9+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
10+
9module CMap
11module CMap
10− ( spec
12+ ( spec
11− ) where
13+ ) where
14+
15+import Criterion.Main (bench, nf, env, whnf)
12
16
13import Prelude hiding (lookup)
17import Prelude hiding (lookup)
14
18
15−import Criterion.Main (bench, env, nf, whnf)
19+import Spec
16−import Data.Kind (Type)
17import Data.Maybe (fromJust)
20import Data.Maybe (fromJust)
18import Data.Proxy (Proxy (..))
21import Data.Proxy (Proxy (..))
19import Data.Typeable (Typeable)
22import Data.Typeable (Typeable)
20−import GHC.TypeLits (type (+), KnownNat, Nat)
23+import GHC.TypeLits
21
24
22import Data.TypeRep.CMap (TypeRepMap (..), empty, insert, lookup)
25import Data.TypeRep.CMap (TypeRepMap (..), empty, insert, lookup)
23
26
24−import Spec (BenchSpec (..))
25−
26−
27spec :: BenchSpec
27spec :: BenchSpec
28spec = BenchSpec
28spec = BenchSpec
29− { benchLookup = Just $ \name ->
29+ { benchLookup = Just $ \name ->
30− env (mkMap 10000) $ \ ~bigMap ->
30+ env (mkMap 10000) $ \ ~bigMap ->
31− bench name $ nf tenLookups bigMap
31+ bench name $ nf tenLookups bigMap
32− , benchInsertSmall = Just $ \name ->
32+ , benchInsertSmall = Just $ \name ->
33− bench name $ whnf (inserts empty 10) (Proxy @ 99999)
33+ bench name $ whnf (inserts empty 10) (Proxy @ 99999)
34− , benchInsertBig = Just $ \name ->
34+ , benchInsertBig = Just $ \name ->
35− env (mkMap 10000) $ \ ~bigMap ->
35+ env (mkMap 10000) $ \ ~(bigMap) ->
36− bench name $ whnf (inserts bigMap 1) (Proxy @ 99999)
36+ bench name $ whnf (inserts bigMap 1) (Proxy @ 99999)
37− , benchUpdateSmall = Just $ \name ->
37+ , benchUpdateSmall = Just $ \name ->
38− env (mkMap 10) $ \ ~smallMap ->
38+ env (mkMap 10) $ \ ~(smallMap) ->
39− bench name $ whnf (inserts smallMap 10) (Proxy @ 0)
39+ bench name $ whnf (inserts smallMap 10) (Proxy @ 0)
40− , benchUpdateBig = Just $ \name ->
40+ , benchUpdateBig = Just $ \name ->
41− env (mkMap 10000) $ \ ~bigMap ->
41+ env (mkMap 10000) $ \ ~(bigMap) ->
42− bench name $ whnf (inserts bigMap 10) (Proxy @ 0)
42+ bench name $ whnf (inserts bigMap 10) (Proxy @ 0)
43− }
43+ }
44
44
45−tenLookups
46− :: TypeRepMap (Proxy :: Nat -> Type)
45+tenLookups :: TypeRepMap (Proxy :: Nat -> *)
47− -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
46+ -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
48− , Proxy 50, Proxy 60, Proxy 70, Proxy 80
47+ , Proxy 50, Proxy 60, Proxy 70, Proxy 80
49− )
48+ )
50tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
49tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
51 where
50 where
52 lp :: forall (a::Nat). Typeable a => Proxy a
51 lp :: forall (a::Nat). Typeable a => Proxy a
53 lp = fromJust $ lookup tmap
52 lp = fromJust $ lookup tmap
54
53
55−inserts
56− :: forall a . (KnownNat a)
54+inserts :: forall a . (KnownNat a)
57− => TypeRepMap (Proxy :: Nat -> Type)
55+ => TypeRepMap (Proxy :: Nat -> *)
58− -> Int
56+ -> Int
59− -> Proxy (a :: Nat)
57+ -> Proxy (a :: Nat)
60− -> TypeRepMap (Proxy :: Nat -> Type)
58+ -> TypeRepMap (Proxy :: Nat -> *)
61inserts !c 0 _ = c
59inserts !c 0 _ = c
62inserts !c n x = inserts
60inserts !c n x = inserts
63− (insert x c)
61+ (insert x c)
64− (n-1)
62+ (n-1)
65− (Proxy :: Proxy (a+1))
63+ (Proxy :: Proxy (a+1))
66
64
67−mkMap :: Int -> IO (TypeRepMap (Proxy :: Nat -> Type))
65+mkMap :: Int -> IO (TypeRepMap (Proxy :: Nat -> *))
68mkMap n = pure $ buildBigMap n (Proxy :: Proxy 0) empty
66mkMap n = pure $ buildBigMap n (Proxy :: Proxy 0) empty
69
67
70−buildBigMap
68+buildBigMap :: forall a . (KnownNat a) => Int -> Proxy (a :: Nat) -> TypeRepMap (Proxy :: Nat -> *) -> TypeRepMap (Proxy :: Nat -> *)
71− :: forall a . (KnownNat a)
72− => Int
73− -> Proxy (a :: Nat)
74− -> TypeRepMap (Proxy :: Nat -> Type)
75− -> TypeRepMap (Proxy :: Nat -> Type)
76buildBigMap 1 x = insert x
69buildBigMap 1 x = insert x
77buildBigMap n x = insert x . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
70buildBigMap n x = insert x . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
benchmark/CacheMap.hs+45−48
@@ -1,79 +1,76 @@
1−{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
2−
3{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE ExplicitNamespaces #-}
3+{-# LANGUAGE KindSignatures #-}
4{-# LANGUAGE PolyKinds #-}
4{-# LANGUAGE PolyKinds #-}
5{-# LANGUAGE TypeFamilies #-}
5{-# LANGUAGE TypeFamilies #-}
6{-# LANGUAGE TypeOperators #-}
6{-# LANGUAGE TypeOperators #-}
7{-# LANGUAGE UndecidableInstances #-}
7{-# LANGUAGE UndecidableInstances #-}
8
8
9+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
10+
9module CacheMap
11module CacheMap
10− ( spec
12+ ( spec
11− ) where
13+ ) where
14+
15+import Criterion.Main (bench, nf, whnf, env)
16+import Spec
12
17
13import Prelude hiding (lookup)
18import Prelude hiding (lookup)
14
19
15−import Criterion.Main (bench, env, nf, whnf)
16−import Data.Kind (Type)
17import Data.Maybe (fromJust)
20import Data.Maybe (fromJust)
18import Data.Proxy (Proxy (..))
21import Data.Proxy (Proxy (..))
19import Data.Typeable (Typeable)
22import Data.Typeable (Typeable)
20import GHC.Exts (fromList)
23import GHC.Exts (fromList)
21−import GHC.TypeLits (type (+), KnownNat, Nat)
24+import GHC.TypeLits
22−
23−import Data.TypeRepMap.Internal (TypeRepMap (..), WrapTypeable (..), empty, insert, lookup)
24−
25−import Spec (BenchSpec (..))
26
25
26+import Data.TypeRepMap.Internal (TypeRepMap (..), WrapTypeable (..), lookup, insert, empty)
27
27
28spec :: BenchSpec
28spec :: BenchSpec
29spec = BenchSpec
29spec = BenchSpec
30− { benchLookup = Just $ \name ->
30+ { benchLookup = Just $ \name ->
31− env (mkMap 10000) $ \ ~bigMap ->
31+ env (mkMap 10000) $ \ ~bigMap ->
32− bench name $ nf tenLookups bigMap
32+ bench name $ nf tenLookups bigMap
33− , benchInsertSmall = Just $ \name ->
33+ , benchInsertSmall = Just $ \name ->
34− bench name $ whnf (inserts empty 10) (Proxy @ 99999)
34+ bench name $ whnf (inserts empty 10) (Proxy @ 99999)
35− , benchInsertBig = Just $ \name ->
35+ , benchInsertBig = Just $ \name ->
36− env (mkMap 10000) $ \ ~bigMap ->
36+ env (mkMap 10000) $ \ ~(bigMap) ->
37− bench name $ whnf (inserts bigMap 1) (Proxy @ 99999)
37+ bench name $ whnf (inserts bigMap 1) (Proxy @ 99999)
38− , benchUpdateSmall = Just $ \name ->
38+ , benchUpdateSmall = Just $ \name ->
39− env (mkMap 10) $ \ ~smallMap ->
39+ env (mkMap 10) $ \ ~(smallMap) ->
40− bench name $ whnf (inserts smallMap 10) (Proxy @ 0)
40+ bench name $ whnf (inserts smallMap 10) (Proxy @ 0)
41− , benchUpdateBig = Just $ \name ->
41+ , benchUpdateBig = Just $ \name ->
42− env (mkMap 10000) $ \ ~bigMap ->
42+ env (mkMap 10000) $ \ ~(bigMap) ->
43− bench name $ whnf (inserts bigMap 10) (Proxy @ 0)
43+ bench name $ whnf (inserts bigMap 10) (Proxy @ 0)
44− }
44+ }
45
45
46−tenLookups
47− :: TypeRepMap (Proxy :: Nat -> Type)
46+tenLookups :: TypeRepMap (Proxy :: Nat -> *)
48− -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
47+ -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
49− , Proxy 50, Proxy 60, Proxy 70, Proxy 80
48+ , Proxy 50, Proxy 60, Proxy 70, Proxy 80
50− )
49+ )
51tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
50tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
52 where
51 where
53− lp :: forall (a :: Nat) . Typeable a => Proxy a
52+ lp :: forall (a::Nat). Typeable a => Proxy a
54 lp = fromJust $ lookup tmap
53 lp = fromJust $ lookup tmap
55
54
56−inserts
57− :: forall a . (KnownNat a)
55+inserts :: forall a . (KnownNat a)
58− => TypeRepMap (Proxy :: Nat -> Type)
56+ => TypeRepMap (Proxy :: Nat -> *)
59− -> Int
57+ -> Int
60− -> Proxy (a :: Nat)
58+ -> Proxy (a :: Nat)
61− -> TypeRepMap (Proxy :: Nat -> Type)
59+ -> TypeRepMap (Proxy :: Nat -> *)
62inserts !c 0 _ = c
60inserts !c 0 _ = c
63inserts !c n x = inserts
61inserts !c n x = inserts
64− (insert x c)
62+ (insert x c)
65− (n-1)
63+ (n-1)
66− (Proxy :: Proxy (a + 1))
64+ (Proxy :: Proxy (a+1))
67
65
68−mkMap :: Int -> IO (TypeRepMap (Proxy :: Nat -> Type))
66+mkMap :: Int -> IO (TypeRepMap (Proxy :: Nat -> *))
69mkMap n = pure $ fromList $ buildBigMap n (Proxy :: Proxy 0) []
67mkMap n = pure $ fromList $ buildBigMap n (Proxy :: Proxy 0) []
70
68
71
69
72−buildBigMap
73− :: forall a . (KnownNat a)
70+buildBigMap :: forall a . (KnownNat a)
74− => Int
71+ => Int
75− -> Proxy (a :: Nat)
72+ -> Proxy (a :: Nat)
76− -> [WrapTypeable (Proxy :: Nat -> Type)]
73+ -> [WrapTypeable (Proxy :: Nat -> *)]
77− -> [WrapTypeable (Proxy :: Nat -> Type)]
74+ -> [WrapTypeable (Proxy :: Nat -> *)]
78buildBigMap 1 x = (WrapTypeable x :)
75buildBigMap 1 x = (WrapTypeable x :)
79buildBigMap n x = (WrapTypeable x :) . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
76buildBigMap n x = (WrapTypeable x :) . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
benchmark/DMap.hs+42−45
@@ -1,81 +1,79 @@
1−{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
2−
3{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE ExplicitNamespaces #-}
4{-# LANGUAGE InstanceSigs #-}
3{-# LANGUAGE InstanceSigs #-}
4+{-# LANGUAGE KindSignatures #-}
5{-# LANGUAGE PolyKinds #-}
5{-# LANGUAGE PolyKinds #-}
6{-# LANGUAGE TypeFamilies #-}
6{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeOperators #-}
7{-# LANGUAGE TypeOperators #-}
8{-# LANGUAGE UndecidableInstances #-}
8{-# LANGUAGE UndecidableInstances #-}
9
9
10+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
11+
10module DMap
12module DMap
11− ( spec
13+ ( spec
12− ) where
14+ ) where
15+
16+import Criterion.Main (bench, env, nf, whnf)
13
17
14import Prelude hiding (lookup)
18import Prelude hiding (lookup)
15
19
16import Control.DeepSeq (NFData (..))
20import Control.DeepSeq (NFData (..))
17−import Criterion.Main (bench, env, nf, whnf)
18−import Data.Kind (Type)
19import Data.Maybe (fromJust)
21import Data.Maybe (fromJust)
20import Data.Proxy (Proxy (..))
22import Data.Proxy (Proxy (..))
21−import GHC.TypeLits (type (+), KnownNat, Nat)
23+import GHC.TypeLits
24+import Spec
22import Type.Reflection (TypeRep, Typeable, typeRep)
25import Type.Reflection (TypeRep, Typeable, typeRep)
23import Type.Reflection.Unsafe (typeRepFingerprint)
26import Type.Reflection.Unsafe (typeRepFingerprint)
24
27
25import Data.Dependent.Map (DMap, empty, insert, keys, lookup)
28import Data.Dependent.Map (DMap, empty, insert, keys, lookup)
26import Data.Some (Some (Some))
29import Data.Some (Some (Some))
27
30
28−import Spec (BenchSpec (..))
29−
30−
31type TypeRepMap = DMap TypeRep
31type TypeRepMap = DMap TypeRep
32
32
33+
33spec :: BenchSpec
34spec :: BenchSpec
34spec = BenchSpec
35spec = BenchSpec
35− { benchLookup = Just $ \name ->
36+ { benchLookup = Just $ \name ->
36− env mkBigMap $ \ ~(DMapNF bigMap) ->
37+ env mkBigMap $ \ ~(DMapNF bigMap) ->
37− bench name $ nf tenLookups bigMap
38+ bench name $ nf tenLookups bigMap
38− , benchInsertSmall = Just $ \name ->
39+ , benchInsertSmall = Just $ \name ->
39− bench name $ whnf (inserts empty 10) (Proxy @ 99999)
40+ bench name $ whnf (inserts empty 10) (Proxy @ 99999)
40− , benchInsertBig = Just $ \name ->
41+ , benchInsertBig = Just $ \name ->
41− env mkBigMap $ \ ~(DMapNF bigMap) ->
42+ env mkBigMap $ \ ~(DMapNF bigMap) ->
42− bench name $ whnf (inserts bigMap 1) (Proxy @ 99999)
43+ bench name $ whnf (inserts bigMap 1) (Proxy @ 99999)
43− , benchUpdateSmall = Nothing -- Not implemented
44+ , benchUpdateSmall = Nothing -- Not implemented
44− , benchUpdateBig = Nothing -- Not implemented
45+ , benchUpdateBig = Nothing -- Not implemented
45− }
46+ }
46
47
47−tenLookups
48− :: TypeRepMap (Proxy :: Nat -> Type)
48+tenLookups :: TypeRepMap (Proxy :: Nat -> *)
49− -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
49+ -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
50− , Proxy 50, Proxy 60, Proxy 70, Proxy 80
50+ , Proxy 50, Proxy 60, Proxy 70, Proxy 80
51− )
51+ )
52tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
52tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
53 where
53 where
54 lp :: forall (a :: Nat) . Typeable a => Proxy a
54 lp :: forall (a :: Nat) . Typeable a => Proxy a
55 lp = fromJust $ lookup (typeRep @a) tmap
55 lp = fromJust $ lookup (typeRep @a) tmap
56
56
57−inserts
58− :: forall a . (KnownNat a)
57+inserts :: forall a . (KnownNat a)
59− => TypeRepMap (Proxy :: Nat -> Type)
58+ => TypeRepMap (Proxy :: Nat -> *)
60− -> Int
59+ -> Int
61− -> Proxy (a :: Nat)
60+ -> Proxy (a :: Nat)
62− -> TypeRepMap (Proxy :: Nat -> Type)
61+ -> TypeRepMap (Proxy :: Nat -> *)
63inserts !c 0 _ = c
62inserts !c 0 _ = c
64inserts !c n x = inserts
63inserts !c n x = inserts
65− (insert (typeRep @ a) x c)
64+ (insert (typeRep @ a) x c)
66− (n-1)
65+ (n-1)
67− (Proxy :: Proxy (a+1))
66+ (Proxy :: Proxy (a+1))
68
67
69-- TypeRepMap of 10000 elements
68-- TypeRepMap of 10000 elements
70−mkBigMap :: IO (DMapNF (Proxy :: Nat -> Type))
69+mkBigMap :: IO (DMapNF (Proxy :: Nat -> *))
71mkBigMap = pure . DMapNF $ buildBigMap 10000 (Proxy :: Proxy 0) empty
70mkBigMap = pure . DMapNF $ buildBigMap 10000 (Proxy :: Proxy 0) empty
72
71
73−buildBigMap
74− :: forall a . (KnownNat a)
72+buildBigMap :: forall a . (KnownNat a)
75− => Int
73+ => Int
76− -> Proxy (a :: Nat)
74+ -> Proxy (a :: Nat)
77− -> TypeRepMap (Proxy :: Nat -> Type)
75+ -> TypeRepMap (Proxy :: Nat -> *)
78− -> TypeRepMap (Proxy :: Nat -> Type)
76+ -> TypeRepMap (Proxy :: Nat -> *)
79buildBigMap 1 x = insert (typeRep @a) x
77buildBigMap 1 x = insert (typeRep @a) x
80buildBigMap n x = insert (typeRep @a) x
78buildBigMap n x = insert (typeRep @a) x
81 . buildBigMap (n - 1) (Proxy @(a + 1))
79 . buildBigMap (n - 1) (Proxy @(a + 1))
@@ -84,6 +82,5 @@ buildBigMap n x = insert (typeRep @a) x
84newtype DMapNF f = DMapNF (TypeRepMap f)
82newtype DMapNF f = DMapNF (TypeRepMap f)
85
83
86instance NFData (DMapNF f) where
84instance NFData (DMapNF f) where
87− rnf :: DMapNF f -> ()
88− rnf (DMapNF x) =
85+ rnf (DMapNF x) =
89− rnf . map (\(Some t) -> typeRepFingerprint t) $ keys x
86+ rnf . map (\(Some t) -> typeRepFingerprint t) $ keys x
benchmark/Main.hs+32−37
@@ -1,52 +1,47 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2
2
3−module Main
3+module Main where
4− ( main
5− ) where
6
4
7−import Criterion.Main (bgroup, defaultMain)
5+import Criterion.Main (defaultMain, bgroup)
8
6
9−import Spec (BenchSpec (..))
7+import Spec
10−
11−import qualified CacheMap
12import qualified CMap
8import qualified CMap
9+import qualified CacheMap
13#if ( __GLASGOW_HASKELL__ >= 802 )
10#if ( __GLASGOW_HASKELL__ >= 802 )
14import qualified DMap
11import qualified DMap
15#endif
12#endif
16import qualified OptimalVector as OptVec
13import qualified OptimalVector as OptVec
17
14
18−
19main :: IO ()
15main :: IO ()
20main = do
16main = do
21− let specs = [("CMap", CMap.spec)
17+ let specs = [("CMap", CMap.spec)
22− ,("CacheMap", CacheMap.spec)
18+ ,("CacheMap", CacheMap.spec)
23#if ( __GLASGOW_HASKELL__ >= 802 )
19#if ( __GLASGOW_HASKELL__ >= 802 )
24− , ("DMap", DMap.spec)
20+ , ("DMap", DMap.spec)
25#endif
21#endif
26− , ("OptVec", OptVec.spec)
22+ , ("OptVec", OptVec.spec)
27− ]
23+ ]
28− {- This code creates a benchmark group. Given a getter
24+ -- This code creates a benchmark group. Given a getter
29− (that is test description) it gets a benchmark generation
25+ -- (that is test description) it gets a benchmark generation
30− function from each module spec. Benchmark generation
26+ -- function from each module spec. Benchmark generation
31− function takes a label and generate benchmarks. It's
27+ -- function takes a label and generate benchmarks. It's
32− possible to introduce parameters passing in the same way.
28+ -- possible to introduce parameters passing in the same way.
33− --}
34− let mkGroup getBenchmark =
29+ mkGroup getBenchmark =
35− [ mkBenchmark label
30+ [ mkBenchmark label
36− | (label, spec) <- specs
31+ | (label, spec) <- specs
37− -- Here we use pure to force pattern matching in List
32+ -- Here we use pure to force pattern matching in List
38− -- then in case of pattern match failure `mzero` will
33+ -- then in case of pattern match failure `mzero` will
39− -- be called, so benchmark will be ignored.
34+ -- be called, so benchmark will be ignored.
40− , Just mkBenchmark <- pure $ getBenchmark spec
35+ , Just mkBenchmark <- pure $ getBenchmark spec
41− ]
42− defaultMain
43− [ bgroup "lookup" $ mkGroup benchLookup
44− , bgroup "insert"
45− [ bgroup "10 elements to empty" $ mkGroup benchInsertSmall
46− , bgroup "1 element to big map" $ mkGroup benchInsertBig
47− ]
48− , bgroup "update"
49− [ bgroup "10 elements to empty" $ mkGroup benchUpdateSmall
50− , bgroup "1 element to big map" $ mkGroup benchUpdateBig
51− ]
52 ]
36 ]
37+ defaultMain
38+ [ bgroup "lookup" $ mkGroup benchLookup
39+ , bgroup "insert"
40+ [ bgroup "10 elements to empty" $ mkGroup benchInsertSmall
41+ , bgroup "1 element to big map" $ mkGroup benchInsertBig
42+ ]
43+ , bgroup "update"
44+ [ bgroup "10 elements to empty" $ mkGroup benchUpdateSmall
45+ , bgroup "1 element to big map" $ mkGroup benchUpdateBig
46+ ]
47+ ]
benchmark/OptimalVector.hs+28−29
@@ -1,60 +1,59 @@
1−{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
2−
3{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE ExplicitNamespaces #-}
3+{-# LANGUAGE KindSignatures #-}
4{-# LANGUAGE PolyKinds #-}
4{-# LANGUAGE PolyKinds #-}
5{-# LANGUAGE ScopedTypeVariables #-}
5{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE TypeFamilies #-}
6{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeOperators #-}
7{-# LANGUAGE TypeOperators #-}
8{-# LANGUAGE UndecidableInstances #-}
8{-# LANGUAGE UndecidableInstances #-}
9
9
10+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
11+
10module OptimalVector
12module OptimalVector
11 ( spec
13 ( spec
12 ) where
14 ) where
13
15
16+import Spec
17+import Criterion.Main (bench, nf, env)
18+
14import Prelude hiding (lookup)
19import Prelude hiding (lookup)
15
20
16−import Criterion.Main (bench, env, nf)
17−import Data.Kind (Type)
18import Data.Maybe (fromJust)
21import Data.Maybe (fromJust)
19import Data.Proxy (Proxy (..))
22import Data.Proxy (Proxy (..))
20import Data.Typeable (Typeable)
23import Data.Typeable (Typeable)
21−import GHC.TypeLits (type (+), KnownNat, Nat)
24+import GHC.TypeLits
22
25
23import Data.TypeRep.OptimalVector (TF (..), TypeRepMap (..), fromList, lookup)
26import Data.TypeRep.OptimalVector (TF (..), TypeRepMap (..), fromList, lookup)
24
27
25−import Spec (BenchSpec (..))
26−
27−
28spec :: BenchSpec
28spec :: BenchSpec
29spec = BenchSpec
29spec = BenchSpec
30− { benchLookup = Just $ \name ->
30+ { benchLookup = Just $ \name ->
31− env mkBigMap $ \ ~bigMap ->
31+ env mkBigMap $ \ ~bigMap ->
32− bench name $ nf tenLookups bigMap
32+ bench name $ nf tenLookups bigMap
33− , benchInsertSmall = Nothing -- Not implemented
33+ , benchInsertSmall = Nothing -- Not implemented
34− , benchInsertBig = Nothing -- Not implemented
34+ , benchInsertBig = Nothing -- Not implemented
35− , benchUpdateSmall = Nothing -- Not implemented
35+ , benchUpdateSmall = Nothing -- Not implemented
36− , benchUpdateBig = Nothing -- Not implemented
36+ , benchUpdateBig = Nothing -- Not implemented
37− }
37+ }
38−
38+
39−tenLookups
40− :: TypeRepMap (Proxy :: Nat -> Type)
39+tenLookups :: TypeRepMap (Proxy :: Nat -> *)
41− -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
40+ -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
42− , Proxy 50, Proxy 60, Proxy 70, Proxy 80
41+ , Proxy 50, Proxy 60, Proxy 70, Proxy 80
43− )
42+ )
44tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
43tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
45 where
44 where
46 lp :: forall (a::Nat). Typeable a => Proxy a
45 lp :: forall (a::Nat). Typeable a => Proxy a
47 lp = fromJust $ lookup tmap
46 lp = fromJust $ lookup tmap
48
47
49-- TypeRepMap of 10000 elements
48-- TypeRepMap of 10000 elements
50−mkBigMap :: IO (TypeRepMap (Proxy :: Nat -> Type))
49+mkBigMap :: IO (TypeRepMap (Proxy :: Nat -> *))
51mkBigMap = pure $ fromList $ buildBigMap 10000 (Proxy :: Proxy 0) []
50mkBigMap = pure $ fromList $ buildBigMap 10000 (Proxy :: Proxy 0) []
52
51
53−buildBigMap
54− :: forall a . (KnownNat a)
52+buildBigMap :: forall a . (KnownNat a)
55− => Int
53+ => Int
56− -> Proxy (a :: Nat)
54+ -> Proxy (a :: Nat)
57− -> [TF (Proxy :: Nat -> Type)]
55+ -> [TF (Proxy :: Nat -> *)]
58− -> [TF (Proxy :: Nat -> Type)]
56+ -> [TF (Proxy :: Nat -> *)]
59buildBigMap 1 x = (TF x :)
57buildBigMap 1 x = (TF x :)
60buildBigMap n x = (TF x :) . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
58buildBigMap n x = (TF x :) . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
59+
benchmark/Spec.hs+50−61
@@ -1,64 +1,53 @@
1−{- | Specification of the benchmarks.
1+-- | Specification of the benchmarks.
2−
3−This module keeps a list of all bencharks, this way
2+-- This module keeps a list of all bencharks, this way
4−we can group benchmark by the interesting function, not
3+-- we can group benchmark by the interesting function, not
5−by the implementation.
4+-- by the implementation.
6−-}
7module Spec
5module Spec
8− ( BenchSpec(..)
6+ ( BenchSpec(..)
9− ) where
7+ ) where
10−
8+
11−import Criterion (Benchmark)
9+import Criterion
12−
10+
13−
14−{- | List of benchmarks that each module should provide.
11+-- | List of benchmarks that each module should provide.
15−If implementation can express the benchmark then it
12+-- If implementation can express the benchmark then it
16−can return @Nothing@ in that benchmark.
13+-- can return @Nothing@ in that benchmark.
17−
14+--
18−Map should contain elements from @1@ to @size of map@
15+-- Map should contain elements from @1@ to @size of map@
19−inserted in ascending order (later that requirement may
16+-- inserted in ascending order (later that requirement may
20−change).
17+-- change).
21−-}
22data BenchSpec = BenchSpec
18data BenchSpec = BenchSpec
19+ { benchLookup :: Maybe (String -> Benchmark)
23− { {- | Basic lookup we look 10 values inside 10k map.
20+ -- ^ Basic lookup we look 10 values inside 10k map.
24−
21+ --
25− Implementation may look like:
22+ -- Implementation may look like:
26−
27− @
23+ -- @
28− tenLookups :: TypeRepMap (Proxy :: Nat -> *)
24+ -- tenLookups :: TypeRepMap (Proxy :: Nat -> *)
29− -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
25+ -- -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
30− , Proxy 50, Proxy 60, Proxy 70, Proxy 80
26+ -- , Proxy 50, Proxy 60, Proxy 70, Proxy 80
31− )
27+ -- )
32− tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
28+ -- tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
33− @
29+ -- @
34− -}
35− benchLookup :: Maybe (String -> Benchmark)
30+ , benchInsertSmall :: Maybe (String -> Benchmark)
36− {- ^ Insert 10 elements into an empty map.
31+ -- ^ Insert 10 elements into an empty map.
37−
32+ --
38− Implementation may look like:
33+ -- Implementation may look like:
34+ -- @
35+ -- inserts :: forall a . (KnownNat a)
36+ -- => TypeRepMap (Proxy :: Nat -> *)
37+ -- -> Int
38+ -- -> Proxy (a :: Nat)
39+ -- -> TypeRepMap (Proxy :: Nat -> *)
40+ -- inserts !c 0 _ = c
41+ -- inserts !c n x = inserts (insert x c) (n-1) (Proxy :: Proxy (a+1))
42+ -- @
43+ , benchInsertBig :: Maybe (String -> Benchmark)
44+ -- ^ Insert 10 elements into a big map. Implementation is like
45+ -- a small map, but should insert values into 10k elements map.
46+ , benchUpdateSmall :: Maybe (String -> Benchmark)
47+ -- ^ Insert 10 elements into map of 10 elements, where each key
48+ -- was already inserted in the map
49+ , benchUpdateBig :: Maybe (String -> Benchmark)
50+ -- ^ Insert 10 elements into map of 10k elements, where each key
51+ -- was already inserted in the map
52+ }
39
53
40− @
41− inserts
42− :: forall a . (KnownNat a)
43− => TypeRepMap (Proxy :: Nat -> *)
44− -> Int
45− -> Proxy (a :: Nat)
46− -> TypeRepMap (Proxy :: Nat -> *)
47− inserts !c 0 _ = c
48− inserts !c n x = inserts (insert x c) (n-1) (Proxy :: Proxy (a+1))
49− @
50− -}
51− , benchInsertSmall :: Maybe (String -> Benchmark)
52− {- ^ Insert 10 elements into a big map. Implementation is like
53− a small map, but should insert values into 10k elements map.
54− -}
55− , benchInsertBig :: Maybe (String -> Benchmark)
56− {- ^ Insert 10 elements into map of 10 elements, where each key
57− was already inserted in the map
58− -}
59− , benchUpdateSmall :: Maybe (String -> Benchmark)
60− {- ^ Insert 10 elements into map of 10k elements, where each key
61− was already inserted in the map
62− -}
63− , benchUpdateBig :: Maybe (String -> Benchmark)
64− }
benchmark/Vector.hs+22−23
@@ -1,30 +1,31 @@
1−{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
2−
3{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE ExplicitNamespaces #-}
3+{-# LANGUAGE KindSignatures #-}
4{-# LANGUAGE PolyKinds #-}
4{-# LANGUAGE PolyKinds #-}
5{-# LANGUAGE ScopedTypeVariables #-}
5{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE TypeFamilies #-}
6{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeOperators #-}
7{-# LANGUAGE TypeOperators #-}
8{-# LANGUAGE UndecidableInstances #-}
8{-# LANGUAGE UndecidableInstances #-}
9
9
10+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
11+
10module Vector
12module Vector
11− ( benchVector
13+ ( benchVector
12− , prepareBenchVector
14+ , prepareBenchVector
13− ) where
15+ ) where
16+
17+import Criterion.Main (Benchmark, bench, bgroup, nf)
14
18
15import Prelude hiding (lookup)
19import Prelude hiding (lookup)
16
20
17import Control.DeepSeq (rnf)
21import Control.DeepSeq (rnf)
18−import Control.Exception (evaluate)
22+import Control.Exception
19−import Criterion.Main (Benchmark, bench, bgroup, nf)
20−import Data.Kind (Type)
21import Data.Maybe (fromJust)
23import Data.Maybe (fromJust)
22import Data.Proxy (Proxy (..))
24import Data.Proxy (Proxy (..))
23import Data.Typeable (Typeable)
25import Data.Typeable (Typeable)
24−import GHC.TypeLits (type (+), KnownNat, Nat)
26+import GHC.TypeLits
25−
26−import Data.TypeRep.Vector (TF (..), TypeRepVector, fingerprints, fromList, lookup)
27
27
28+import Data.TypeRep.Vector
28
29
29benchVector :: Benchmark
30benchVector :: Benchmark
30benchVector = bgroup "vector"
31benchVector = bgroup "vector"
@@ -33,26 +34,24 @@ benchVector = bgroup "vector"
33 -- , bench "update old" $ whnf (\x -> rknf $ insert x bigMap) (Proxy :: Proxy 1)
34 -- , bench "update old" $ whnf (\x -> rknf $ insert x bigMap) (Proxy :: Proxy 1)
34 ]
35 ]
35
36
36−tenLookups
37− :: TypeRepVector (Proxy :: Nat -> Type)
37+tenLookups :: TypeRepVector (Proxy :: Nat -> *)
38− -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
38+ -> ( Proxy 10, Proxy 20, Proxy 30, Proxy 40
39− , Proxy 50, Proxy 60, Proxy 70, Proxy 80
39+ , Proxy 50, Proxy 60, Proxy 70, Proxy 80
40− )
40+ )
41tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
41tenLookups tmap = (lp, lp, lp, lp, lp, lp, lp, lp)
42 where
42 where
43 lp :: forall (a::Nat). Typeable a => Proxy a
43 lp :: forall (a::Nat). Typeable a => Proxy a
44 lp = fromJust $ lookup tmap
44 lp = fromJust $ lookup tmap
45
45
46-- TypeRepMap of 10000 elements
46-- TypeRepMap of 10000 elements
47−bigMap :: TypeRepVector (Proxy :: Nat -> Type)
47+bigMap :: TypeRepVector (Proxy :: Nat -> *)
48bigMap = fromList $ buildBigMap 10000 (Proxy :: Proxy 0) []
48bigMap = fromList $ buildBigMap 10000 (Proxy :: Proxy 0) []
49
49
50−buildBigMap
51− :: forall a . (KnownNat a)
50+buildBigMap :: forall a . (KnownNat a)
52− => Int
51+ => Int
53− -> Proxy (a :: Nat)
52+ -> Proxy (a :: Nat)
54− -> [TF (Proxy :: Nat -> Type)]
53+ -> [TF (Proxy :: Nat -> *)]
55− -> [TF (Proxy :: Nat -> Type)]
54+ -> [TF (Proxy :: Nat -> *)]
56buildBigMap 1 x = (TF x :)
55buildBigMap 1 x = (TF x :)
57buildBigMap n x = (TF x :) . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
56buildBigMap n x = (TF x :) . buildBigMap (n - 1) (Proxy :: Proxy (a + 1))
58
57
shell.nixnew file+10
@@ -0,0 +1,10 @@
1+# { stdenv, pkgs, haskell }:
2+with import <nixpkgs> { };
3+
4+stdenv.mkDerivation rec {
5+ name = "typerep-map";
6+ buildInputs = [
7+ haskell.compiler.ghc844
8+ pkgs.cabal-install
9+ ];
10+}
src/Data/TMap.hs+2−52
@@ -2,10 +2,6 @@
2{-# LANGUAGE Rank2Types #-}
2{-# LANGUAGE Rank2Types #-}
3
3
4{- |
4{- |
5−Copyright: (c) 2017-2020 Kowainik
6−SPDX-License-Identifier: MPL-2.0
7−Maintainer: Kowainik <xrom.xkov@gmail.com>
8−
9'TMap' is a heterogeneous data structure similar in its essence to
5'TMap' is a heterogeneous data structure similar in its essence to
10'Data.Map.Map' with types as keys, where each value has the type of its key.
6'Data.Map.Map' with types as keys, where each value has the type of its key.
11
7
@@ -37,19 +33,14 @@ module Data.TMap
37 , delete
33 , delete
38 , unionWith
34 , unionWith
39 , union
35 , union
40− , intersectionWith
41− , intersection
42 , map
36 , map
43 , adjust
37 , adjust
44− , alter
45
38
46 -- * Query
39 -- * Query
47 , lookup
40 , lookup
48 , member
41 , member
49 , size
42 , size
50 , keys
43 , keys
51− , keysWith
52− , toListWith
53 ) where
44 ) where
54
45
55import Prelude hiding (lookup, map)
46import Prelude hiding (lookup, map)
@@ -57,7 +48,7 @@ import Prelude hiding (lookup, map)
57import Data.Functor.Identity (Identity (..))
48import Data.Functor.Identity (Identity (..))
58import Data.Typeable (Typeable)
49import Data.Typeable (Typeable)
59import GHC.Exts (coerce)
50import GHC.Exts (coerce)
60−import Type.Reflection (SomeTypeRep, TypeRep)
51+import Type.Reflection (SomeTypeRep)
61
52
62import qualified Data.TypeRepMap as F
53import qualified Data.TypeRepMap as F
63
54
@@ -92,7 +83,6 @@ one x = coerce (F.one @a @Identity $ coerce x)
92{- |
83{- |
93
84
94Insert a value into a 'TMap'.
85Insert a value into a 'TMap'.
95−TMap optimizes for fast reads rather than inserts, as a trade-off inserts are @O(n)@.
96
86
97prop> size (insert v tm) >= size tm
87prop> size (insert v tm) >= size tm
98prop> member @a (insert (x :: a) tm) == True
88prop> member @a (insert (x :: a) tm) == True
@@ -104,9 +94,6 @@ insert x = coerce (F.insert @a @Identity $ coerce x)
104
94
105{- | Delete a value from a 'TMap'.
95{- | Delete a value from a 'TMap'.
106
96
107−TMap optimizes for fast reads rather than modifications, as a trade-off deletes are @O(n)@,
108−with an @O(log(n))@ optimization for when the element is already missing.
109−
110prop> size (delete @a tm) <= size tm
97prop> size (delete @a tm) <= size tm
111prop> member @a (delete @a tm) == False
98prop> member @a (delete @a tm) == False
112
99
@@ -136,24 +123,6 @@ union :: TMap -> TMap -> TMap
136union = F.union
123union = F.union
137{-# INLINE union #-}
124{-# INLINE union #-}
138
125
139−-- | The intersection of two 'TMap's using a combining function.
140−--
141−-- @O(n + m)@
142−intersectionWith :: (forall x. Typeable x => x -> x -> x) -> TMap -> TMap -> TMap
143−intersectionWith f = F.intersectionWith fId
144− where
145− fId :: forall y . Typeable y => Identity y -> Identity y -> Identity y
146− fId y1 y2 = f (coerce y1) (coerce y2)
147−{-# INLINE intersectionWith #-}
148−
149−-- | The intersection of two 'TMap's.
150−-- It keeps all values from the first map whose keys are present in the second.
151−--
152−-- @O(n + m)@
153−intersection :: TMap -> TMap -> TMap
154−intersection = F.intersection
155−{-# INLINE intersection #-}
156−
157{- | Lookup a value of the given type in a 'TMap'.
126{- | Lookup a value of the given type in a 'TMap'.
158
127
159>>> x = lookup $ insert (11 :: Int) empty
128>>> x = lookup $ insert (11 :: Int) empty
@@ -187,16 +156,6 @@ keys :: TMap -> [SomeTypeRep]
187keys = F.keys
156keys = F.keys
188{-# INLINE keys #-}
157{-# INLINE keys #-}
189
158
190−-- | Return the list of keys by wrapping them with a user-provided function.
191−keysWith :: (forall a. TypeRep a -> r) -> TMap -> [r]
192−keysWith = F.keysWith
193−{-# INLINE keysWith #-}
194−
195−-- | Return the list of key-value pairs by wrapping them with a user-provided function.
196−toListWith :: (forall a. Typeable a => a -> r) -> TMap -> [r]
197−toListWith = F.toListWith
198−{-# INLINE toListWith #-}
199−
200-- | Map a function over the values.
159-- | Map a function over the values.
201map :: (forall a. Typeable a => a -> a) -> TMap -> TMap
160map :: (forall a. Typeable a => a -> a) -> TMap -> TMap
202map f = F.hoistWithKey (liftToIdentity f)
161map f = F.hoistWithKey (liftToIdentity f)
@@ -207,14 +166,5 @@ adjust :: Typeable a => (a -> a) -> TMap -> TMap
207adjust f = F.adjust (liftToIdentity f)
166adjust f = F.adjust (liftToIdentity f)
208{-# INLINE adjust #-}
167{-# INLINE adjust #-}
209
168
210−-- | Updates a value at a specific key, whether or not it exists.
211−-- This can be used to insert, delete, or update a value of a given type in the map.
212−alter :: Typeable a => (Maybe a -> Maybe a) -> TMap -> TMap
213−alter f = F.alter (liftF f)
214− where
215− liftF :: forall a. (Maybe a -> Maybe a) -> Maybe (Identity a) -> Maybe (Identity a)
216− liftF = coerce
217−{-# INLINE alter #-}
218−
219−liftToIdentity :: forall a. (a -> a) -> Identity a -> Identity a
169+liftToIdentity :: forall a. Typeable a => (a -> a) -> Identity a -> Identity a
220liftToIdentity = coerce
170liftToIdentity = coerce
src/Data/TypeRepMap.hs+40−50
@@ -1,50 +1,45 @@
1{-# LANGUAGE NoImplicitPrelude #-}
1{-# LANGUAGE NoImplicitPrelude #-}
2
2
3−{- |
4−Copyright: (c) 2017-2020 Kowainik
5−SPDX-License-Identifier: MPL-2.0
6−Maintainer: Kowainik <xrom.xkov@gmail.com>
7−
8−A version of 'Data.TMap.TMap' parametrized by an interpretation @f@. This
3+-- | A version of 'Data.TMap.TMap' parametrized by an interpretation @f@. This
9−sort of parametrization may be familiar to users of @vinyl@ records.
4+-- sort of parametrization may be familiar to users of @vinyl@ records.
10−
5+--
11−@'TypeRepMap' f@ is a more efficient replacement for @DMap
6+-- @'TypeRepMap' f@ is a more efficient replacement for @DMap
12−'Type.Reflection.TypeRep' f@ (where @DMap@ is from the @dependent-map@
7+-- 'Type.Reflection.TypeRep' f@ (where @DMap@ is from the @dependent-map@
13−package).
8+-- package).
14−
9+--
15−Here is an example of using 'Prelude.Maybe' as an interpretation, with a
10+-- Here is an example of using 'Prelude.Maybe' as an interpretation, with a
16−comparison to 'Data.TMap.TMap':
11+-- comparison to 'Data.TMap.TMap':
17−
12+--
18−@
13+-- @
19− 'Data.TMap.TMap' 'TypeRepMap' 'Prelude.Maybe'
14+-- 'Data.TMap.TMap' 'TypeRepMap' 'Prelude.Maybe'
20−-------------- -------------------
15+-- -------------- -------------------
21− Int -> 5 Int -> Just 5
16+-- Int -> 5 Int -> Just 5
22− Bool -> True Bool -> Nothing
17+-- Bool -> True Bool -> Nothing
23− Char -> \'x\' Char -> Just \'x\'
18+-- Char -> \'x\' Char -> Just \'x\'
24−@
19+-- @
25−
20+--
26−In fact, a 'Data.TMap.TMap' is defined as 'TypeRepMap'
21+-- In fact, a 'Data.TMap.TMap' is defined as 'TypeRepMap'
27−'Data.Functor.Identity'.
22+-- 'Data.Functor.Identity'.
28−
23+--
29−Since 'Type.Reflection.TypeRep' is poly-kinded, the interpretation can use
24+-- Since 'Type.Reflection.TypeRep' is poly-kinded, the interpretation can use
30−any kind for the keys. For instance, we can use the 'GHC.TypeLits.Symbol'
25+-- any kind for the keys. For instance, we can use the 'GHC.TypeLits.Symbol'
31−kind to use 'TypeRepMap' as an extensible record:
26+-- kind to use 'TypeRepMap' as an extensible record:
32−
27+--
33−@
28+-- @
34−newtype Field name = F (FType name)
29+-- newtype Field name = F (FType name)
35−
30+--
36−type family FType (name :: Symbol) :: Type
31+-- type family FType (name :: Symbol) :: Type
37−type instance FType "radius" = Double
32+-- type instance FType "radius" = Double
38−type instance FType "border-color" = RGB
33+-- type instance FType "border-color" = RGB
39−type instance FType "border-width" = Double
34+-- type instance FType "border-width" = Double
40−
35+--
41− 'TypeRepMap' Field
36+-- 'TypeRepMap' Field
42−--------------------------------------
37+-- --------------------------------------
43− "radius" -> F 5.7
38+-- "radius" -> F 5.7
44− "border-color" -> F (rgb 148 0 211)
39+-- "border-color" -> F (rgb 148 0 211)
45− "border-width" -> F 0.5
40+-- "border-width" -> F 0.5
46−@
41+-- @
47−--}
42+--
48module Data.TypeRepMap
43module Data.TypeRepMap
49 ( -- * Map type
44 ( -- * Map type
50 TypeRepMap()
45 TypeRepMap()
@@ -57,22 +52,17 @@ module Data.TypeRepMap
57 , insert
52 , insert
58 , delete
53 , delete
59 , adjust
54 , adjust
60− , alter
61 , hoist
55 , hoist
62 , hoistA
56 , hoistA
63 , hoistWithKey
57 , hoistWithKey
64 , unionWith
58 , unionWith
65 , union
59 , union
66− , intersectionWith
67− , intersection
68
60
69 -- * Query
61 -- * Query
70 , lookup
62 , lookup
71 , member
63 , member
72 , size
64 , size
73 , keys
65 , keys
74− , keysWith
75− , toListWith
76
66
77 -- * 'IsList'
67 -- * 'IsList'
78 , WrapTypeable (..)
68 , WrapTypeable (..)
src/Data/TypeRepMap/Internal.hs+54−214
@@ -1,11 +1,10 @@
1−{-# OPTIONS_GHC -Wno-missing-export-lists #-}
2−
3{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
4{-# LANGUAGE BangPatterns #-}
2{-# LANGUAGE BangPatterns #-}
5{-# LANGUAGE CPP #-}
3{-# LANGUAGE CPP #-}
6{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DataKinds #-}
7{-# LANGUAGE GADTs #-}
5{-# LANGUAGE GADTs #-}
8{-# LANGUAGE InstanceSigs #-}
6{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE KindSignatures #-}
9{-# LANGUAGE MagicHash #-}
8{-# LANGUAGE MagicHash #-}
10{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE PolyKinds #-}
11{-# LANGUAGE Rank2Types #-}
10{-# LANGUAGE Rank2Types #-}
@@ -19,20 +18,13 @@
19
18
20-- {-# OPTIONS_GHC -ddump-simpl -dsuppress-idinfo -dsuppress-coercions -dsuppress-type-applications -dsuppress-uniques -dsuppress-module-prefixes #-}
19-- {-# OPTIONS_GHC -ddump-simpl -dsuppress-idinfo -dsuppress-coercions -dsuppress-type-applications -dsuppress-uniques -dsuppress-module-prefixes #-}
21
20
22−{- |
23−Copyright: (c) 2017-2020 Kowainik
24−SPDX-License-Identifier: MPL-2.0
25−Maintainer: Kowainik <xrom.xkov@gmail.com>
26−
27−Internal API for 'TypeRepMap' and operations on it. The functions here do
21+{- | Internal API for 'TypeRepMap' and operations on it. The functions here do
28not have any stability guarantees and can change between minor versions.
22not have any stability guarantees and can change between minor versions.
29
23
30If you need to use this module for purposes other than tests,
24If you need to use this module for purposes other than tests,
31create an issue.
25create an issue.
32-}
26-}
33
27
34−#include "MachDeps.h"
35−
36module Data.TypeRepMap.Internal where
28module Data.TypeRepMap.Internal where
37
29
38import Prelude hiding (lookup)
30import Prelude hiding (lookup)
@@ -45,25 +37,20 @@ import Data.Kind (Type)
45import Data.Type.Equality ((:~:) (..), TestEquality (..))
37import Data.Type.Equality ((:~:) (..), TestEquality (..))
46import Data.List (intercalate, nubBy)
38import Data.List (intercalate, nubBy)
47import Data.Maybe (fromMaybe)
39import Data.Maybe (fromMaybe)
48−import Data.Primitive.Array (Array, MutableArray, indexArray, mapArray', sizeofArray,
40+import Data.Primitive.Array (Array, MutableArray, indexArray, mapArray', readArray, sizeofArray,
49 thawArray, unsafeFreezeArray, writeArray)
41 thawArray, unsafeFreezeArray, writeArray)
50−import Data.Primitive.PrimArray (writePrimArray, newPrimArray, unsafeFreezePrimArray, primArrayToList, MutablePrimArray, primArrayFromListN, PrimArray, indexPrimArray, sizeofPrimArray)
42+import Data.Primitive.PrimArray (PrimArray, indexPrimArray, sizeofPrimArray)
51import Data.Semigroup (Semigroup (..), All(..))
43import Data.Semigroup (Semigroup (..), All(..))
52import GHC.Base (Any, Int (..), Int#, (*#), (+#), (<#))
44import GHC.Base (Any, Int (..), Int#, (*#), (+#), (<#))
53import GHC.Exts (IsList (..), inline, sortWith)
45import GHC.Exts (IsList (..), inline, sortWith)
54import GHC.Fingerprint (Fingerprint (..))
46import GHC.Fingerprint (Fingerprint (..))
55−#if WORD_SIZE_IN_BITS >= 64
56import GHC.Prim (eqWord#, ltWord#)
47import GHC.Prim (eqWord#, ltWord#)
57−#else
58−import GHC.IntWord64 (eqWord64#, ltWord64#)
59−#define eqWord eqWord64
60−#define ltWord ltWord64
61−#endif
62import GHC.Word (Word64 (..))
48import GHC.Word (Word64 (..))
63import Type.Reflection (SomeTypeRep (..), TypeRep, Typeable, typeRep, withTypeable)
49import Type.Reflection (SomeTypeRep (..), TypeRep, Typeable, typeRep, withTypeable)
64import Type.Reflection.Unsafe (typeRepFingerprint)
50import Type.Reflection.Unsafe (typeRepFingerprint)
65import Unsafe.Coerce (unsafeCoerce)
51import Unsafe.Coerce (unsafeCoerce)
66
52
53+import qualified Data.Map.Strict as Map
67import qualified GHC.Exts as GHC (fromList, toList)
54import qualified GHC.Exts as GHC (fromList, toList)
68
55
69{- |
56{- |
@@ -169,49 +156,33 @@ prop> member @a (one (x :: f a)) == True
169
156
170-}
157-}
171one :: forall a f . Typeable a => f a -> TypeRepMap f
158one :: forall a f . Typeable a => f a -> TypeRepMap f
172−one x = TypeRepMap (primArrayFromListN 1 [fa])
159+one x = insert x empty
173− (primArrayFromListN 1 [fb])
174− (pure @Array v)
175− (pure @Array k)
176− where
177− (Fingerprint fa fb, v, k) = (calcFp @a, toAny x, unsafeCoerce $ typeRep @a)
178{-# INLINE one #-}
160{-# INLINE one #-}
179
161
180{- |
162{- |
181
163
182Insert a value into a 'TypeRepMap'.
164Insert a value into a 'TypeRepMap'.
183−TypeRepMap optimizes for fast reads rather than inserts, as a trade-off inserts are @O(n)@.
184
165
185prop> size (insert v tm) >= size tm
166prop> size (insert v tm) >= size tm
186prop> member @a (insert (x :: f a) tm) == True
167prop> member @a (insert (x :: f a) tm) == True
187
168
188-}
169-}
189insert :: forall a f . Typeable a => f a -> TypeRepMap f -> TypeRepMap f
170insert :: forall a f . Typeable a => f a -> TypeRepMap f -> TypeRepMap f
190−insert x m
171+insert x = fromTriples . addX . toTriples
191− | size m == 0 = one x
192− | otherwise = case cachedBinarySearch (typeFp @a) (fingerprintAs m) (fingerprintBs m) of
193− Nothing -> union m $ one x
194− Just i -> m {trAnys = changeAnyArr i (trAnys m)}
195 where
172 where
196− changeAnyArr :: Int -> Array Any -> Array Any
173+ tripleX :: (Fingerprint, Any, Any)
197− changeAnyArr i trAs = runST $ do
174+ tripleX@(fpX, _, _) = (calcFp @a, toAny x, unsafeCoerce $ typeRep @a)
198− let n = sizeofArray trAs
175+
199− mutArr <- thawArray trAs 0 n
176+ addX :: [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)]
200− writeArray mutArr i $ toAny x
177+ addX l = tripleX : deleteByFst fpX l
201− unsafeFreezeArray mutArr
202{-# INLINE insert #-}
178{-# INLINE insert #-}
203
179
204-- Extract the kind of a type. We use it to work around lack of syntax for
180-- Extract the kind of a type. We use it to work around lack of syntax for
205-- inferred type variables (which are not subject to type applications).
181-- inferred type variables (which are not subject to type applications).
206type KindOf (a :: k) = k
182type KindOf (a :: k) = k
207
183
208−type ArgKindOf (f :: k -> l) = k
209−
210{- | Delete a value from a 'TypeRepMap'.
184{- | Delete a value from a 'TypeRepMap'.
211
185
212−TypeRepMap optimizes for fast reads rather than modifications, as a trade-off deletes are
213−@O(n)@, with an @O(log(n))@ optimization for when the element is already missing.
214−
215prop> size (delete @a tm) <= size tm
186prop> size (delete @a tm) <= size tm
216prop> member @a (delete @a tm) == False
187prop> member @a (delete @a tm) == False
217
188
@@ -224,60 +195,30 @@ False
224True
195True
225-}
196-}
226delete :: forall a (f :: KindOf a -> Type) . Typeable a => TypeRepMap f -> TypeRepMap f
197delete :: forall a (f :: KindOf a -> Type) . Typeable a => TypeRepMap f -> TypeRepMap f
227−delete m
198+delete = fromTriples . deleteByFst (typeFp @a) . toTriples
228− -- Lookups are fast, so check if we even have the element first.
229− | not (member @a m) = m
230− -- We know we have the element, If the map has exactly one element, we can return the empty map
231− | size m == 1 = empty
232− -- Otherwise, filter out the element in linear time.
233− | otherwise = fromSortedTriples . deleteFirst ((== typeFp @a) . fst3) . toSortedTriples $ m
234{-# INLINE delete #-}
199{-# INLINE delete #-}
235
200
236−deleteFirst :: (a -> Bool) -> [a] -> [a]
237−deleteFirst _ [] = []
238−deleteFirst p (x : xs) = if p x then xs else x : deleteFirst p xs
239−
240{- |
201{- |
241−Update a value at a specific key with the result of the provided function.
202+Update a value at a specific key with the result of the provided function. When
242−When the key is not a member of the map, the original map is returned.
203+the key is not a member of the map, the original map is returned.
243
204
244>>> trmap = fromList @(TypeRepMap Identity) [WrapTypeable $ Identity "a"]
205>>> trmap = fromList @(TypeRepMap Identity) [WrapTypeable $ Identity "a"]
245>>> lookup @String $ adjust (fmap (++ "ww")) trmap
206>>> lookup @String $ adjust (fmap (++ "ww")) trmap
246Just (Identity "aww")
207Just (Identity "aww")
247-}
208-}
248adjust :: forall a f . Typeable a => (f a -> f a) -> TypeRepMap f -> TypeRepMap f
209adjust :: forall a f . Typeable a => (f a -> f a) -> TypeRepMap f -> TypeRepMap f
249−adjust fun = alter (fmap fun)
250−{-# INLINE adjust #-}
251−
252−{- |
253−Updates a value at a specific key, whether or not it exists.
254−This can be used to insert, delete, or update a value of a given type in the map.
255−
256−>>> func = (\case Nothing -> Just (Identity "new"); Just (Identity s) -> Just (Identity (reverse s)))
257−>>> lookup @String $ alter func empty
258−Just (Identity "new")
259−>>> trmap = fromList @(TypeRepMap Identity) [WrapTypeable $ Identity "helllo"]
260−>>> lookup @String $ alter func trmap
261−>>> Just (Identity "olleh")
262−-}
263−alter :: forall a f . Typeable a => (Maybe (f a) -> Maybe (f a)) -> TypeRepMap f -> TypeRepMap f
264−alter fun tr = case cachedBinarySearch (typeFp @a) (fingerprintAs tr) (fingerprintBs tr) of
210+adjust fun tr = case cachedBinarySearch (typeFp @a) (fingerprintAs tr) (fingerprintBs tr) of
265− Nothing ->
211+ Nothing -> tr
266− case (fun Nothing) of
267− Nothing -> tr
268− Just v -> insert v tr
269− Just i ->
270− case fun (Just . fromAny $ indexArray (trAnys tr) i) of
271− Nothing -> delete @a tr
272− Just v -> tr{trAnys = replaceAnyAt i (toAny v) (trAnys tr)}
212+ Just i -> tr {trAnys = changeAnyArr i (trAnys tr)}
273 where
213 where
274− replaceAnyAt :: Int -> Any -> Array Any -> Array Any
214+ changeAnyArr :: Int -> Array Any -> Array Any
275− replaceAnyAt i v trAs = runST $ do
215+ changeAnyArr i trAs = runST $ do
276 let n = sizeofArray trAs
216 let n = sizeofArray trAs
277 mutArr <- thawArray trAs 0 n
217 mutArr <- thawArray trAs 0 n
218+ a <- toAny . fun . fromAny <$> readArray mutArr i
278− writeArray mutArr i v
219+ writeArray mutArr i a
279 unsafeFreezeArray mutArr
220 unsafeFreezeArray mutArr
280−{-# INLINE alter #-}
221+{-# INLINE adjust #-}
281
222
282{- | Map over the elements of a 'TypeRepMap'.
223{- | Map over the elements of a 'TypeRepMap'.
283
224
@@ -311,89 +252,33 @@ hoistWithKey f (TypeRepMap as bs ans ks) = TypeRepMap as bs newAns ks
311 withTr t = withTypeable t f
252 withTr t = withTypeable t f
312{-# INLINE hoistWithKey #-}
253{-# INLINE hoistWithKey #-}
313
254
314−-- | The union of two 'TypeRepMap's using a combining function for conflicting entries. @O(n + m)@
255+-- | The union of two 'TypeRepMap's using a combining function.
315unionWith :: forall f. (forall x. Typeable x => f x -> f x -> f x) -> TypeRepMap f -> TypeRepMap f -> TypeRepMap f
256unionWith :: forall f. (forall x. Typeable x => f x -> f x -> f x) -> TypeRepMap f -> TypeRepMap f -> TypeRepMap f
316−unionWith f ma mb = do
257+unionWith f m1 m2 = fromTriples
317− fromSortedTriples $ mergeMaps (toSortedTriples ma) (toSortedTriples mb)
258+ $ toTripleList
259+ $ Map.unionWith combine
260+ (fromTripleList $ toTriples m1)
261+ (fromTripleList $ toTriples m2)
318 where
262 where
319 f' :: forall x. TypeRep x -> f x -> f x -> f x
263 f' :: forall x. TypeRep x -> f x -> f x -> f x
320 f' tr = withTypeable tr f
264 f' tr = withTypeable tr f
321
265
322− combine :: (Fingerprint, Any, Any) -> (Fingerprint, Any, Any) -> (Fingerprint, Any, Any)
266+ combine :: (Any, Any) -> (Any, Any) -> (Any, Any)
323− combine (fp, av, ak) (_, bv, _) = (fp, toAny $ f' (fromAny ak) (fromAny av) (fromAny bv), ak)
267+ combine (av, ak) (bv, _) = (toAny $ f' (fromAny ak) (fromAny av) (fromAny bv), ak)
324−
268+
325− -- Merges two typrepmaps into a sorted, dedup'd list of triples.
269+ fromTripleList :: Ord a => [(a, b, c)] -> Map.Map a (b, c)
326− -- Using 'toSortedTriples' allows us to assume the triples are sorted by fingerprint,
270+ fromTripleList = Map.fromList . map (\(a, b, c) -> (a, (b, c)))
327− -- Given O(n) performance from 'toSortedTriples', and given that we can merge-sort in
271+
328− -- O(n + m) time, then can '.fromSortedTriples' back into cachedBinarySearch order in O(n + m)
272+ toTripleList :: Map.Map a (b, c) -> [(a, b, c)]
329− -- that gives a total of O(n + m).
273+ toTripleList = map (\(a, (b, c)) -> (a, b, c)) . Map.toList
330− mergeMaps :: [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)]
331− -- We've addressed all elements from both maps
332− mergeMaps as [] = as
333− mergeMaps [] bs = bs
334− -- Merge
335− mergeMaps (a@(af, _, _) : as) (b@(bf, _, _) : bs) =
336− case compare af bf of
337− -- Fingerprints are equal, union the elements using our function
338− -- If the incoming maps were de-duped, there shouldn't be any other equivalent
339− -- fingerprints
340− EQ -> combine a b : mergeMaps as bs
341− -- First fingerprint must not be in the second map or we would have seen it by now
342− -- Add it to the result as-is
343− LT -> a : mergeMaps as (b : bs)
344− -- Second fingerprint must not be in the first map or we would have seen it by now
345− -- Add it to the result as-is
346− GT -> b : mergeMaps (a:as) bs
347{-# INLINE unionWith #-}
274{-# INLINE unionWith #-}
348
275
349−-- | The (left-biased) union of two 'TypeRepMap's in @O(n + m)@. It prefers the first map when
276+-- | The (left-biased) union of two 'TypeRepMap's. It prefers the first map when
350-- duplicate keys are encountered, i.e. @'union' == 'unionWith' const@.
277-- duplicate keys are encountered, i.e. @'union' == 'unionWith' const@.
351union :: TypeRepMap f -> TypeRepMap f -> TypeRepMap f
278union :: TypeRepMap f -> TypeRepMap f -> TypeRepMap f
352union = unionWith const
279union = unionWith const
353{-# INLINE union #-}
280{-# INLINE union #-}
354
281
355−-- | The 'intersection' of two 'TypeRepMap's using a combining function
356−--
357−-- @O(n + m)@
358−intersectionWith :: forall f. (forall x. Typeable x => f x -> f x -> f x) -> TypeRepMap f -> TypeRepMap f -> TypeRepMap f
359−intersectionWith f ma mb =
360− fromSortedTriples $ mergeMaps (toSortedTriples ma) (toSortedTriples mb)
361− where
362− f' :: forall x. TypeRep x -> f x -> f x -> f x
363− f' tr = withTypeable tr f
364−
365− combine :: (Fingerprint, Any, Any) -> (Fingerprint, Any, Any) -> (Fingerprint, Any, Any)
366− combine (fp, av, ak) (_, bv, _) = (fp, toAny $ f' (fromAny ak) (fromAny av) (fromAny bv), ak)
367−
368− -- Merges two typrepmaps into a sorted, dedup'd list of triples.
369− mergeMaps :: [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)]
370− -- If either list is empty, the intersection must be finished.
371− mergeMaps _ [] = []
372− mergeMaps [] _ = []
373− -- Merge the two maps considering one element at a time.
374− mergeMaps (a@(af, _, _) : as) (b@(bf, _, _) : bs) =
375− case compare af bf of
376− -- Fingerprints are equal, union the elements using our function
377− -- If the incoming maps were de-duped, there shouldn't be any other equivalent
378− -- fingerprints
379− EQ -> combine a b : mergeMaps as bs
380− -- First fingerprint must not be in the second map or we would have seen it by now
381− -- Skip it an move on
382− LT -> mergeMaps as (b : bs)
383− -- Second fingerprint must not be in the first map or we would have seen it by now
384− -- Skip it an move on
385− GT -> mergeMaps (a:as) bs
386−{-# INLINE intersectionWith #-}
387−
388−-- | The intersection of two 'TypeRepMap's.
389−-- It keeps all values from the first map whose keys are present in the second.
390−--
391−-- @O(n + m)@
392−intersection :: TypeRepMap f -> TypeRepMap f -> TypeRepMap f
393−intersection = intersectionWith const
394−{-# INLINE intersection #-}
395−
396−
397{- | Check if a value of the given type is present in a 'TypeRepMap'.
282{- | Check if a value of the given type is present in a 'TypeRepMap'.
398
283
399>>> member @Char $ one (Identity 'a')
284>>> member @Char $ one (Identity 'a')
@@ -429,22 +314,9 @@ size = sizeofPrimArray . fingerprintAs
429
314
430-- | Return the list of 'SomeTypeRep' from the keys.
315-- | Return the list of 'SomeTypeRep' from the keys.
431keys :: TypeRepMap f -> [SomeTypeRep]
316keys :: TypeRepMap f -> [SomeTypeRep]
432−keys = keysWith SomeTypeRep
317+keys TypeRepMap{..} = SomeTypeRep . anyToTypeRep <$> toList trKeys
433{-# INLINE keys #-}
318{-# INLINE keys #-}
434
319
435−-- | Return the list of keys by wrapping them with a user-provided function.
436−keysWith :: (forall (a :: ArgKindOf f). TypeRep a -> r) -> TypeRepMap f -> [r]
437−keysWith f TypeRepMap{..} = f . anyToTypeRep <$> toList trKeys
438−{-# INLINE keysWith #-}
439−
440−-- | Return the list of key-value pairs by wrapping them with a user-provided function.
441−toListWith :: forall f r. (forall (a :: ArgKindOf f). Typeable a => f a -> r) -> TypeRepMap f -> [r]
442−toListWith f = map toF . toTriples
443− where
444− withTypeRep :: TypeRep a -> f a -> r
445− withTypeRep tr an = withTypeable tr $ f an
446− toF (_, an, k) = withTypeRep (unsafeCoerce k) (fromAny an)
447−
448-- | Binary searched based on this article
320-- | Binary searched based on this article
449-- http://bannalia.blogspot.com/2015/06/cache-friendly-binary-search.html
321-- http://bannalia.blogspot.com/2015/06/cache-friendly-binary-search.html
450-- with modification for our two-vector search case.
322-- with modification for our two-vector search case.
@@ -488,20 +360,8 @@ typeFp = typeRepFingerprint $ typeRep @a
488toTriples :: TypeRepMap f -> [(Fingerprint, Any, Any)]
360toTriples :: TypeRepMap f -> [(Fingerprint, Any, Any)]
489toTriples tm = zip3 (toFingerprints tm) (GHC.toList $ trAnys tm) (GHC.toList $ trKeys tm)
361toTriples tm = zip3 (toFingerprints tm) (GHC.toList $ trAnys tm) (GHC.toList $ trKeys tm)
490
362
491−-- | Efficiently get sorted triples from a map in O(n) time
363+deleteByFst :: Eq a => a -> [(a, b, c)] -> [(a, b, c)]
492−--
364+deleteByFst x = filter ((/= x) . fst3)
493−-- We assume the incoming TypeRepMap is already sorted into 'cachedBinarySearch' order using fromSortedList.
494−-- Then we can construct the index mapping from the "cached" ordering into monotonically
495−-- increasing order using 'generateOrderMapping' with the length of the TRM. This takes @O(n).
496−-- We then pull those indexes from the source TRM to get the sorted triples in a total of @O(n).
497−toSortedTriples :: TypeRepMap f -> [(Fingerprint, Any, Any)]
498−toSortedTriples tm = trip <$> ordering
499− where
500− trip i = ( Fingerprint (indexPrimArray (fingerprintAs tm) i) (indexPrimArray (fingerprintBs tm) i)
501− , indexArray (trAnys tm) i
502− , indexArray (trKeys tm) i)
503− ordering :: [ Int ]
504− ordering = generateOrderMapping (size tm)
505
365
506nubByFst :: (Eq a) => [(a, b, c)] -> [(a, b, c)]
366nubByFst :: (Eq a) => [(a, b, c)] -> [(a, b, c)]
507nubByFst = nubBy ((==) `on` fst3)
367nubByFst = nubBy ((==) `on` fst3)
@@ -521,6 +381,9 @@ data WrapTypeable f where
521instance Show (WrapTypeable f) where
381instance Show (WrapTypeable f) where
522 show (WrapTypeable (_ :: f a)) = show $ calcFp @a
382 show (WrapTypeable (_ :: f a)) = show $ calcFp @a
523
383
384+wrapTypeable :: TypeRep a -> f a -> WrapTypeable f
385+wrapTypeable tr = withTypeable tr WrapTypeable
386+
524{- |
387{- |
525
388
526prop> fromList . toList == 'id'
389prop> fromList . toList == 'id'
@@ -548,19 +411,19 @@ instance IsList (TypeRepMap f) where
548 k (WrapTypeable (_ :: f a)) = unsafeCoerce $ typeRep @a
411 k (WrapTypeable (_ :: f a)) = unsafeCoerce $ typeRep @a
549
412
550 toList :: TypeRepMap f -> [WrapTypeable f]
413 toList :: TypeRepMap f -> [WrapTypeable f]
551− toList = toListWith WrapTypeable
414+ toList = map toWrapTypeable . toTriples
415+ where
416+ toWrapTypeable :: (Fingerprint, Any, Any) -> WrapTypeable f
417+ toWrapTypeable (_, an, k) = wrapTypeable (unsafeCoerce k) (fromAny an)
552
418
553calcFp :: forall a . Typeable a => Fingerprint
419calcFp :: forall a . Typeable a => Fingerprint
554calcFp = typeRepFingerprint $ typeRep @a
420calcFp = typeRepFingerprint $ typeRep @a
555
421
556fromTriples :: [(Fingerprint, Any, Any)] -> TypeRepMap f
422fromTriples :: [(Fingerprint, Any, Any)] -> TypeRepMap f
557−fromTriples = fromSortedTriples . sortWith fst3 . nubByFst
558−
559−fromSortedTriples :: [(Fingerprint, Any, Any)] -> TypeRepMap f
560−fromSortedTriples kvs = TypeRepMap (GHC.fromList fpAs) (GHC.fromList fpBs) (GHC.fromList ans) (GHC.fromList ks)
423+fromTriples kvs = TypeRepMap (GHC.fromList fpAs) (GHC.fromList fpBs) (GHC.fromList ans) (GHC.fromList ks)
561 where
424 where
562 (fpAs, fpBs) = unzip $ map (\(Fingerprint a b) -> (a, b)) fps
425 (fpAs, fpBs) = unzip $ map (\(Fingerprint a b) -> (a, b)) fps
563− (fps, ans, ks) = unzip3 $ fromSortedList kvs
426+ (fps, ans, ks) = unzip3 $ fromSortedList $ sortWith fst3 $ nubByFst kvs
564
427
565----------------------------------------------------------------------------
428----------------------------------------------------------------------------
566-- Tree-like conversion
429-- Tree-like conversion
@@ -587,42 +450,18 @@ fromSortedList l = runST $ do
587 writeArray result i (indexArray origin newFirst)
450 writeArray result i (indexArray origin newFirst)
588 loop (2 * i + 2) (newFirst + 1)
451 loop (2 * i + 2) (newFirst + 1)
589
452
590−-- Returns a list of indexes which represents the "sorted" order of an array generated by
591−-- fromSortedList of the provided length.
592−-- I.e. fmap (fromSortedList [1, 2, 3, 4, 5, 6] !!) (generateOrderMapping 6) == [1, 2, 3, 4, 5, 6]
593−--
594−-- >>> generateOrderMapping 6
595−-- [3,1,4,0,5,2]
596−--
597−-- >>> generateOrderMapping 8
598−-- [7,3,1,4,0,5,2,6]
599−generateOrderMapping :: Int -> [Int]
600−generateOrderMapping len = runST $ do
601− orderMappingArr <- newPrimArray len
602− _ <- loop orderMappingArr 0 0
603− primArrayToList <$> unsafeFreezePrimArray orderMappingArr
604− where
605− loop :: MutablePrimArray s Int -> Int -> Int -> ST s Int
606− loop result i first =
607− if i >= len
608− then pure first
609− else do
610− newFirst <- loop result (2 * i + 1) first
611− writePrimArray result newFirst i
612− loop result (2 * i + 2) (newFirst + 1)
613−
614----------------------------------------------------------------------------
453----------------------------------------------------------------------------
615-- Helper functions.
454-- Helper functions.
616----------------------------------------------------------------------------
455----------------------------------------------------------------------------
617
456
618−-- | Check that invariant of the structure holds.
457+-- | Check that invariant of the structure is hold.
619-- The structure maintains the following invariant.
458-- The structure maintains the following invariant.
620-- For each element @A@ at index @i@:
459-- For each element @A@ at index @i@:
621--
460--
622−-- 1. if there is an element @B@ at index @2*i+1@,
461+-- 1. if there is an element @B@ at index @2*i+1@,
623-- then @B < A@.
462-- then @B < A@.
624--
463--
625−-- 2. if there is an element @C@ at index @2*i+2@,
464+-- 2. if there is an element @C@ at index @2*i+2@,
626-- then @A < C@.
465-- then @A < C@.
627--
466--
628invariantCheck :: TypeRepMap f -> Bool
467invariantCheck :: TypeRepMap f -> Bool
@@ -668,3 +507,4 @@ invariantCheck TypeRepMap{..} = getAll (check 0)
668 , All $ fromMaybe True $ (<=) <$> leftMax <*> rightMin
507 , All $ fromMaybe True $ (<=) <$> leftMax <*> rightMin
669 , check (i+1)
508 , check (i+1)
670 ]
509 ]
510+
stack.yaml+6−3
@@ -1,6 +1,9 @@
1−resolver: lts-15.8
1+resolver: lts-13.26
2
2
3extra-deps:
3extra-deps:
4− - dependent-map-0.2.4.0
4+ - aeson-1.4.4.0
5 - dependent-sum-0.5
5 - dependent-sum-0.5
6+ - hedgehog-1.0
7+ - primitive-0.7.0.0
6− - hspec-hedgehog-0.0.1.2
8+ - tasty-hedgehog-1.0.0.1
9+ - time-compat-1.9.2.2
test/Test.hs+1−21
@@ -1,21 +1 @@
1−module Main
1+{-# OPTIONS_GHC -F -pgmF tasty-discover -optF --tree-display #-}
2− ( main
3− ) where
4−
5−import Test.Hspec (hspec)
6−
7−import Test.TypeRep.CMap (cMapSpec)
8−import Test.TypeRep.TypeRepMap (typeRepMapSpec)
9−import Test.TypeRep.TypeRepMapProperty (typeRepMapPropertySpec)
10−import Test.TypeRep.Vector (vectorSpec)
11−import Test.TypeRep.VectorOpt (optimalVectorSpec)
12−
13−
14−main :: IO ()
15−main = hspec $ do
16− typeRepMapSpec
17− cMapSpec
18− vectorSpec
19− optimalVectorSpec
20− -- property
21− typeRepMapPropertySpec
test/Test/TypeRep/CMap.hs+6−8
@@ -1,18 +1,16 @@
1−module Test.TypeRep.CMap
1+module Test.TypeRep.CMap where
2− ( cMapSpec
3− ) where
4
2
5import Prelude hiding (lookup)
3import Prelude hiding (lookup)
6
4
7import Data.Functor.Identity (Identity (..))
5import Data.Functor.Identity (Identity (..))
8−import Test.Hspec (Spec, describe, it, shouldBe)
9
6
10−import Data.TypeRep.CMap (TypeRepMap, empty, insert, lookup, size)
7+import Test.Tasty.Hspec
11
8
9+import Data.TypeRep.CMap
12
10
13−-- | Simple test for 'lookup', 'insert' and 'size' functions.
11+-- Simple test for 'lookup', 'insert' and 'size' functions.
14−cMapSpec :: Spec
12+spec_insertLookup :: Spec
15−cMapSpec = describe "Containers Map TypeRep" $ do
13+spec_insertLookup = do
16 describe "Lookup Test" $ do
14 describe "Lookup Test" $ do
17 it "returns the inserted element" $
15 it "returns the inserted element" $
18 lookup (insert (Identity 'a') empty) `shouldBe` Just (Identity 'a')
16 lookup (insert (Identity 'a') empty) `shouldBe` Just (Identity 'a')
test/Test/TypeRep/CacheMap.hsnew file+50
@@ -0,0 +1,50 @@
1+module Test.TypeRep.CacheMap where
2+
3+import Prelude hiding (lookup)
4+
5+import Data.Functor.Identity (Identity (..))
6+import GHC.Exts (fromList)
7+import Test.Tasty.Hspec (Spec, describe, it, shouldBe)
8+
9+import Data.TMap (TMap, empty, insert, lookup, one, size, union)
10+import Data.TypeRepMap.Internal (WrapTypeable (..))
11+
12+-- Simple test for 'lookup', 'insert' and 'size' functions.
13+spec_insertLookup :: Spec
14+spec_insertLookup = do
15+ describe "Lookup Test" $ do
16+ it "returns the inserted element" $
17+ lookup (fromList [WrapTypeable $ Identity 'a']) `shouldBe` Just 'a'
18+ it "returns the second inserted value of the same type" $
19+ lookup (fromList [WrapTypeable (Identity 'b'), WrapTypeable (Identity 'a')]) `shouldBe` Just 'b'
20+
21+ describe "Size Test" $ do
22+ it "is empty" $
23+ size empty `shouldBe` 0
24+ it "is of size 1 when 1 element inserted" $
25+ size (one 'a') `shouldBe` 1
26+ it "doesn't increase size when element of the same type is added" $
27+ size (insert 'b' $ insert 'a' empty) `shouldBe` 1
28+ it "returns 10 when 10 different types are inserted" $
29+ size mapOf10 `shouldBe` 10
30+
31+ describe "Union test" $ do
32+ let m = fromList [WrapTypeable $ Identity 'a', WrapTypeable $ Identity True] `union`
33+ fromList [WrapTypeable $ Identity 'b']
34+ it "lookup works on union as expected" $ do
35+ lookup m `shouldBe` Just 'a'
36+ lookup m `shouldBe` Just True
37+ lookup @Int m `shouldBe` Nothing
38+
39+
40+mapOf10 :: TMap
41+mapOf10 = insert True
42+ $ insert [True, False]
43+ $ insert (Just True)
44+ $ insert (Just ())
45+ $ insert [()]
46+ $ insert ()
47+ $ insert @String "aaa"
48+ $ insert (Just 'a')
49+ $ insert 'a'
50+ $ insert (11 :: Int) empty
test/Test/TypeRep/MapProperty.hsnew file+134
@@ -0,0 +1,134 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE KindSignatures #-}
5+{-# LANGUAGE PolyKinds #-}
6+
7+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
8+
9+module Test.TypeRep.MapProperty where
10+
11+import Prelude hiding (lookup)
12+
13+import Data.Proxy (Proxy (..))
14+import Data.Semigroup (Semigroup (..))
15+import GHC.Exts (fromList)
16+import GHC.Stack (HasCallStack)
17+import GHC.TypeLits (Nat, SomeNat (..), someNatVal)
18+import Hedgehog (MonadGen, PropertyT, forAll, property, (===), assert)
19+import Test.Tasty (TestName, TestTree)
20+import Test.Tasty.Hedgehog (testProperty)
21+
22+import Data.TypeRepMap.Internal (TypeRepMap (..), WrapTypeable (..), delete, insert, lookup, member, invariantCheck)
23+
24+import qualified Hedgehog.Gen as Gen
25+import qualified Hedgehog.Range as Range
26+
27+----------------------------------------------------------------------------
28+-- Common utils
29+----------------------------------------------------------------------------
30+
31+type PropertyTest = [TestTree]
32+
33+prop :: HasCallStack => TestName -> PropertyT IO () -> PropertyTest
34+prop testName = pure . testProperty testName . property
35+
36+----------------------------------------------------------------------------
37+-- Map modification properties
38+----------------------------------------------------------------------------
39+
40+test_InsertLookup :: PropertyTest
41+test_InsertLookup = prop "lookup k (insert k v m) == Just v" $ do
42+ m <- forAll genMap
43+ WrapTypeable (proxy :: IntProxy n) <- forAll genTF
44+ lookup @n @IntProxy (insert proxy m) === Just proxy
45+
46+test_InsertInsert :: PropertyTest
47+test_InsertInsert = prop "insert k b . insert k a == insert k b" $ do
48+ m <- forAll genMap
49+ WrapTypeable a@(IntProxy (proxy :: Proxy n) i) <- forAll genTF
50+ let b = IntProxy proxy (i + 1)
51+ lookup @n @IntProxy (insert b $ insert a m) === Just b
52+
53+test_DeleteMember :: PropertyTest
54+test_DeleteMember = prop "member k . delete k == False" $ do
55+ m <- forAll genMap
56+ WrapTypeable (proxy :: IntProxy n) <- forAll genTF
57+ shouldInsert <- forAll Gen.bool
58+
59+ if shouldInsert then
60+ member @n (delete @n $ insert proxy m) === False
61+ else
62+ member @n (delete @n m) === False
63+
64+test_InsertInvariant :: PropertyTest
65+test_InsertInvariant = prop "invariantCheck (insert k b) == True" $ do
66+ m <- forAll genMap
67+ WrapTypeable a <- forAll genTF
68+ assert $ invariantCheck (insert a m)
69+
70+test_DeleteInvariant :: PropertyTest
71+test_DeleteInvariant = prop "invariantCheck (delete k b) == True" $ do
72+ m <- forAll genMap
73+ WrapTypeable (_ :: IntProxy n) <- forAll genTF
74+ assert $ invariantCheck (delete @n m)
75+
76+----------------------------------------------------------------------------
77+-- Semigroup and Monoid laws
78+----------------------------------------------------------------------------
79+
80+#if __GLASGOW_HASKELL__ < 806
81+-- This newtype is used to compare 'TypeRepMap's using only 'Fingerprint's. It's
82+-- not a good idea to write such `Eq` instance for `TypeRepMap` itself because
83+-- it doesn't compare values so it's not true equality. But this should be
84+-- enough for tests.
85+newtype FpMap f = FpMap (TypeRepMap f)
86+ deriving (Show, Semigroup, Monoid)
87+
88+instance Eq (FpMap f) where
89+ FpMap (TypeRepMap as1 bs1 _ _) == FpMap (TypeRepMap as2 bs2 _ _) =
90+ as1 == as2 && bs1 == bs2
91+#endif
92+
93+test_SemigroupAssoc :: PropertyTest
94+test_SemigroupAssoc = prop "x <> (y <> z) == (x <> y) <> z" $ do
95+#if __GLASGOW_HASKELL__ >= 806
96+ x <- forAll genMap
97+ y <- forAll genMap
98+ z <- forAll genMap
99+#else
100+ x <- FpMap <$> forAll genMap
101+ y <- FpMap <$> forAll genMap
102+ z <- FpMap <$> forAll genMap
103+#endif
104+
105+ (x <> (y <> z)) === ((x <> y) <> z)
106+
107+test_MonoidIdentity :: PropertyTest
108+test_MonoidIdentity = prop "x <> mempty == mempty <> x == x" $ do
109+#if __GLASGOW_HASKELL__ >= 806
110+ x <- forAll genMap
111+#else
112+ x <- FpMap <$> forAll genMap
113+#endif
114+
115+ x <> mempty === x
116+ mempty <> x === x
117+
118+----------------------------------------------------------------------------
119+-- Generators
120+----------------------------------------------------------------------------
121+
122+data IntProxy (n :: Nat) = IntProxy (Proxy n) Int
123+ deriving (Show, Eq)
124+
125+genMap :: MonadGen m => m (TypeRepMap IntProxy)
126+genMap = fromList <$> Gen.list (Range.linear 0 1000) genTF
127+
128+genTF :: MonadGen m => m (WrapTypeable IntProxy)
129+genTF = do
130+ randNat :: Integer <- Gen.integral (Range.linear 0 10000)
131+ randInt <- Gen.int Range.constantBounded
132+ case someNatVal randNat of
133+ Just (SomeNat proxyNat) -> pure $ WrapTypeable $ IntProxy proxyNat randInt
134+ Nothing -> error "Invalid test generator"
test/Test/TypeRep/TypeRepMap.hsdeleted−111
@@ -1,111 +0,0 @@
1−module Test.TypeRep.TypeRepMap
2− ( typeRepMapSpec
3− ) where
4−
5−import Prelude hiding (lookup)
6−
7−import Data.Functor.Identity (Identity (..))
8−import Data.List (sortBy)
9−import Data.Ord (comparing)
10−import Data.Typeable (cast)
11−import GHC.Exts (fromList, toList)
12−import Type.Reflection (SomeTypeRep(..), typeRep)
13−import Test.Hspec (Spec, describe, it, shouldBe, shouldMatchList, shouldSatisfy, expectationFailure)
14−
15−import Data.TMap (TMap, empty, insert, lookup, one, size, union, keys)
16−import Data.TypeRepMap.Internal (WrapTypeable (..))
17−
18−
19−-- Simple test for 'lookup', 'insert', 'size', 'keys', 'toList' functions.
20−typeRepMapSpec :: Spec
21−typeRepMapSpec = describe "TypeRepMap" $ do
22− describe "Lookup Test" $ do
23− it "returns the inserted element" $
24− lookup (fromList [WrapTypeable $ Identity 'a']) `shouldBe` Just 'a'
25− it "returns the second inserted value of the same type" $
26− lookup (fromList [WrapTypeable (Identity 'b'), WrapTypeable (Identity 'a')]) `shouldBe` Just 'b'
27−
28− describe "Size Test" $ do
29− it "is empty" $
30− size empty `shouldBe` 0
31− it "is of size 1 when 1 element inserted" $
32− size (one 'a') `shouldBe` 1
33− it "doesn't increase size when element of the same type is added" $
34− size (insert 'b' $ insert 'a' empty) `shouldBe` 1
35− it "returns 10 when 10 different types are inserted" $
36− size mapOf10 `shouldBe` 10
37−
38− describe "Union test" $ do
39− let m = fromList [WrapTypeable $ Identity 'a', WrapTypeable $ Identity True] `union`
40− fromList [WrapTypeable $ Identity 'b']
41− it "lookup works on union as expected" $ do
42− lookup m `shouldBe` Just 'a'
43− lookup m `shouldBe` Just True
44− lookup @Int m `shouldBe` Nothing
45−
46− describe "Keys Test" $ do
47− it "returns nothing on empty map" $
48− keys empty `shouldBe` []
49− it "returns the correct TypeRep" $
50− keys (one 'a') `shouldBe` [SomeTypeRep $ typeRep @Char]
51− it "returns the correct TypeReps for 10 different types" $
52− keys mapOf10 `shouldMatchList`
53− [ SomeTypeRep $ typeRep @Bool
54− , SomeTypeRep $ typeRep @[Bool]
55− , SomeTypeRep $ typeRep @(Maybe Bool)
56− , SomeTypeRep $ typeRep @(Maybe ())
57− , SomeTypeRep $ typeRep @[()]
58− , SomeTypeRep $ typeRep @()
59− , SomeTypeRep $ typeRep @String
60− , SomeTypeRep $ typeRep @(Maybe Char)
61− , SomeTypeRep $ typeRep @Char
62− , SomeTypeRep $ typeRep @Int
63− ]
64−
65− describe "ToList Test" $ do
66− it "returns nothing on empty map" $
67− toList empty `shouldSatisfy` null
68− it "returns correct result when 1 element is inserted" $
69− case toList (one 'a') of
70− [WrapTypeable (Identity x)] -> cast x `shouldBe` Just 'a'
71− _ -> expectationFailure "did not return exactly 1 result"
72− it "returns correct result when 10 elements are inserted" $ do
73− let
74− getTypeRep (WrapTypeable (Identity (_ :: a))) = SomeTypeRep $ typeRep @a
75− got = sortBy (comparing getTypeRep) (toList mapOf10)
76− expected = sortBy (comparing fst)
77− [ (SomeTypeRep $ typeRep @Bool,
78− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just True)
79− , (SomeTypeRep $ typeRep @[Bool],
80− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just [True, False])
81− , (SomeTypeRep $ typeRep @(Maybe Bool),
82− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just (Just True))
83− , (SomeTypeRep $ typeRep @(Maybe ()),
84− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just (Just ()))
85− , (SomeTypeRep $ typeRep @[()],
86− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just [()])
87− , (SomeTypeRep $ typeRep @(),
88− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just ())
89− , (SomeTypeRep $ typeRep @String,
90− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just ("aaa" :: String))
91− , (SomeTypeRep $ typeRep @(Maybe Char),
92− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just (Just 'a'))
93− , (SomeTypeRep $ typeRep @Char,
94− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just 'a')
95− , (SomeTypeRep $ typeRep @Int,
96− \(WrapTypeable (Identity x)) -> cast x `shouldBe` Just (11 :: Int))
97− ]
98− length got `shouldBe` 10
99− sequence_ $ zipWith snd expected got
100−
101−mapOf10 :: TMap
102−mapOf10 = insert True
103− $ insert [True, False]
104− $ insert (Just True)
105− $ insert (Just ())
106− $ insert [()]
107− $ insert ()
108− $ insert @String "aaa"
109− $ insert (Just 'a')
110− $ insert 'a'
111− $ insert (11 :: Int) empty
test/Test/TypeRep/TypeRepMapProperty.hsdeleted−184
@@ -1,184 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4−{-# LANGUAGE PolyKinds #-}
5−
6−{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
7−
8−module Test.TypeRep.TypeRepMapProperty
9− ( typeRepMapPropertySpec
10− ) where
11−
12−import Prelude hiding (lookup)
13−
14−import Data.Proxy (Proxy (..))
15−import Data.Semigroup (Semigroup (..))
16−import GHC.Exts (fromList)
17−import GHC.TypeLits (Nat, SomeNat (..), someNatVal)
18−import Hedgehog (MonadGen, assert, forAll, (===))
19−import Test.Hspec (Arg, Expectation, Spec, SpecWith, describe, it)
20−import Test.Hspec.Hedgehog (hedgehog)
21−
22−import Data.TypeRepMap.Internal (TypeRepMap (..), WrapTypeable (..), delete, insert, invariantCheck,
23− lookup, member, union, generateOrderMapping, fromSortedList,
24− adjust, alter, intersection)
25−
26−import qualified Hedgehog.Gen as Gen
27−import qualified Hedgehog.Range as Range
28−
29−
30−typeRepMapPropertySpec :: Spec
31−typeRepMapPropertySpec = describe "TypeRepMap Property tests" $ do
32− describe "Map modification properties" $ do
33− insertLookupSpec
34− insertInsertSpec
35− deleteMemberSpec
36− insertInvariantSpec
37− deleteInvariantSpec
38− alterInsertSpec
39− alterDeleteSpec
40− alterAdjustSpec
41− alterModifySpec
42− intersectionSpec
43− describe "Internal helpers" $ do
44− generateOrderMappingInvariantSpec
45− describe "Instance Laws" $ do
46− semigroupAssocSpec
47− monoidIdentitySpec
48−
49−----------------------------------------------------------------------------
50−-- Map modification properties
51−----------------------------------------------------------------------------
52−
53−type Property = SpecWith (Arg Expectation)
54−
55−insertLookupSpec :: Property
56−insertLookupSpec = it "lookup k (insert k v m) == Just v" $ hedgehog $ do
57− m <- forAll genMap
58− WrapTypeable (proxy :: IntProxy n) <- forAll genTF
59− lookup @n @IntProxy (insert proxy m) === Just proxy
60−
61−insertInsertSpec :: Property
62−insertInsertSpec = it "insert k b . insert k a == insert k b" $ hedgehog $ do
63− m <- forAll genMap
64− WrapTypeable a@(IntProxy (proxy :: Proxy n) i) <- forAll genTF
65− let b = IntProxy proxy (i + 1)
66− lookup @n @IntProxy (insert b $ insert a m) === Just b
67−
68−deleteMemberSpec :: Property
69−deleteMemberSpec = it "member k . delete k == False" $ hedgehog $ do
70− m <- forAll genMap
71− WrapTypeable (proxy :: IntProxy n) <- forAll genTF
72− shouldInsert <- forAll Gen.bool
73−
74− if shouldInsert then
75− member @n (delete @n $ insert proxy m) === False
76− else
77− member @n (delete @n m) === False
78−
79−insertInvariantSpec :: Property
80−insertInvariantSpec = it "invariantCheck (insert k b) == True" $ hedgehog $ do
81− m <- forAll genMap
82− WrapTypeable a <- forAll genTF
83− assert $ invariantCheck (insert a m)
84−
85−deleteInvariantSpec :: Property
86−deleteInvariantSpec = it "invariantCheck (delete k b) == True" $ hedgehog $ do
87− m <- forAll genMap
88− WrapTypeable (_ :: IntProxy n) <- forAll genTF
89− assert $ invariantCheck (delete @n m)
90−
91−alterInsertSpec :: Property
92−alterInsertSpec = it "insert proxy m === alter (const (Just proxy)) m" $ hedgehog $ do
93− m <- forAll genMap
94− WrapTypeable (proxy :: IntProxy n) <- forAll genTF
95− insert proxy m === alter (const (Just proxy)) m
96−
97−alterDeleteSpec :: Property
98−alterDeleteSpec = it "delete proxy m === alter (const Nothing) m" $ hedgehog $ do
99− WrapTypeable (proxy :: IntProxy n) <- forAll genTF
100− m <- insert proxy <$> forAll genMap
101− delete @n @IntProxy m === alter @n @IntProxy (const Nothing) m
102−
103−alterAdjustSpec :: Property
104−alterAdjustSpec = it "adjust f m == alter (fmap f) m" $ hedgehog $ do
105− m <- forAll genMap
106− WrapTypeable (_ :: IntProxy n) <- forAll genTF
107− let f (IntProxy p n) = IntProxy p (n * 10)
108− adjust @n @IntProxy f m === alter @n @IntProxy (fmap f) m
109−
110−alterModifySpec :: Property
111−alterModifySpec = it "lookup k (alter f) == f (lookup k m)" $ hedgehog $ do
112− m <- forAll genMap
113− WrapTypeable (_ :: IntProxy n) <- forAll genTF
114− randInt <- forAll (Gen.int Range.constantBounded)
115− -- Function with some interesting behaviour, which inserts, seletes and modifies
116− let f Nothing = Just (IntProxy Proxy randInt)
117− f (Just (IntProxy p n))
118− | even n = Nothing
119− | otherwise = Just $ IntProxy p (n * 10)
120− lookup @n @IntProxy (alter @n f m) === f (lookup @n @IntProxy m)
121−
122−intersectionSpec :: Property
123−intersectionSpec = it "m `intersection` (m `union` n) == m" $ hedgehog $ do
124− m <- forAll genMap
125− n <- forAll genMap
126− m `intersection` (m `union` n) === m
127−
128−----------------------------------------------------------------------------
129−-- Internal helpers
130−----------------------------------------------------------------------------
131−generateOrderMappingInvariantSpec :: Property
132−generateOrderMappingInvariantSpec =
133− it "fmap (fromSortedList [1 .. n] !!) (generateOrderMapping n) == [1 .. n]" $ hedgehog $ do
134− n <- forAll $ Gen.int (Range.linear 0 100)
135− fmap (fromSortedList [1 .. n] !!) (generateOrderMapping n) === [1 .. n]
136−
137−----------------------------------------------------------------------------
138−-- Semigroup and Monoid laws
139−----------------------------------------------------------------------------
140−
141−semigroupAssocSpec :: Property
142−semigroupAssocSpec = it "x <> (y <> z) == (x <> y) <> z" $ hedgehog $ do
143− x <- forAll genMap
144− y <- forAll genMap
145− z <- forAll genMap
146− (x <> (y <> z)) === ((x <> y) <> z)
147−
148−monoidIdentitySpec :: Property
149−monoidIdentitySpec = it "x <> mempty == mempty <> x == x" $ hedgehog $ do
150− x <- forAll genMap
151− x <> mempty === x
152− mempty <> x === x
153−
154−----------------------------------------------------------------------------
155−-- Generators
156−----------------------------------------------------------------------------
157−
158−data IntProxy (n :: Nat) = IntProxy (Proxy n) Int
159− deriving stock (Show, Eq)
160−
161−genMap :: MonadGen m => m (TypeRepMap IntProxy)
162−genMap = fromList <$> Gen.list (Range.linear 0 1000) genTF
163−
164−genTF :: MonadGen m => m (WrapTypeable IntProxy)
165−genTF = do
166− randNat :: Integer <- Gen.integral (Range.linear 0 10000)
167− randInt <- Gen.int Range.constantBounded
168− case someNatVal randNat of
169− Just (SomeNat proxyNat) -> pure $ WrapTypeable $ IntProxy proxyNat randInt
170− Nothing -> error "Invalid test generator"
171−
172−----------------------------------------------------------------------------
173−-- Helpers
174−----------------------------------------------------------------------------
175−#if __GLASGOW_HASKELL__ < 806
176−{- | We add an orphan Eq instance for old GHC versions just to make testing easier.
177−It's not a good idea to write such 'Eq' instance for 'TypeRepMap' itself because
178−it doesn't compare values so it's not true equality. But this should be enough
179−for tests.
180−-}
181−instance Eq (TypeRepMap f) where
182− TypeRepMap as1 bs1 _ _ == TypeRepMap as2 bs2 _ _ =
183− as1 == as2 && bs1 == bs2
184−#endif
test/Test/TypeRep/Vector.hs+6−8
@@ -1,18 +1,16 @@
1−module Test.TypeRep.Vector
1+module Test.TypeRep.Vector where
2− ( vectorSpec
3− ) where
4
2
5import Prelude hiding (lookup)
3import Prelude hiding (lookup)
6
4
7import Data.Functor.Identity (Identity (..))
5import Data.Functor.Identity (Identity (..))
8−import Test.Hspec (Spec, describe, it, shouldBe)
9
6
10−import Data.TypeRep.Vector (TF (..), fromList, lookup)
7+import Test.Tasty.Hspec
11
8
9+import Data.TypeRep.Vector
12
10
13−-- | Simple test for 'lookup', 'insert' and 'size' functions.
11+-- Simple test for 'lookup', 'insert' and 'size' functions.
14−vectorSpec :: Spec
12+spec_insertLookup :: Spec
15−vectorSpec = describe "Vector TypeRep" $
13+spec_insertLookup =
16 describe "Lookup Test" $ do
14 describe "Lookup Test" $ do
17 it "returns the inserted element" $
15 it "returns the inserted element" $
18 lookup (fromList [TF (Identity 'a')]) `shouldBe` Just (Identity 'a')
16 lookup (fromList [TF (Identity 'a')]) `shouldBe` Just (Identity 'a')
test/Test/TypeRep/VectorOpt.hs+6−8
@@ -1,18 +1,16 @@
1−module Test.TypeRep.VectorOpt
1+module Test.TypeRep.VectorOpt where
2− ( optimalVectorSpec
3− ) where
4
2
5import Prelude hiding (lookup)
3import Prelude hiding (lookup)
6
4
7import Data.Functor.Identity (Identity (..))
5import Data.Functor.Identity (Identity (..))
8−import Test.Hspec (Spec, describe, it, shouldBe)
9
6
10−import Data.TypeRep.OptimalVector (TF (..), fromList, lookup)
7+import Test.Tasty.Hspec
11
8
9+import Data.TypeRep.OptimalVector (TF (..), fromList, lookup)
12
10
13−-- | Simple test for 'lookup', 'insert' and 'size' functions.
11+-- Simple test for 'lookup', 'insert' and 'size' functions.
14−optimalVectorSpec :: Spec
12+spec_insertLookup :: Spec
15−optimalVectorSpec = describe "Optimal Vector TypeRep" $
13+spec_insertLookup =
16 describe "Lookup Test" $ do
14 describe "Lookup Test" $ do
17 it "returns the inserted element" $
15 it "returns the inserted element" $
18 lookup (fromList [TF $ Identity 'a']) `shouldBe` Just (Identity 'a')
16 lookup (fromList [TF $ Identity 'a']) `shouldBe` Just (Identity 'a')
typerep-extra-impls/Data/TypeRep/CMap.hs+3−12
@@ -1,12 +1,5 @@
1+{-# LANGUAGE KindSignatures #-}
1−{-# LANGUAGE PolyKinds #-}
2+{-# LANGUAGE PolyKinds #-}
2−
3−{- |
4−Copyright: (c) 2017-2020 Kowainik
5−SPDX-License-Identifier: MPL-2.0
6−Maintainer: Kowainik <xrom.xkov@gmail.com>
7−
8−TypeRepMap implementation based on @containers@ 'Map'.
9−-}
10
3
11module Data.TypeRep.CMap
4module Data.TypeRep.CMap
12 ( TypeRepMap (..)
5 ( TypeRepMap (..)
@@ -20,7 +13,6 @@ module Data.TypeRep.CMap
20import Prelude hiding (lookup)
13import Prelude hiding (lookup)
21
14
22import Control.DeepSeq
15import Control.DeepSeq
23−import Data.Kind (Type)
24import Data.Proxy (Proxy (..))
16import Data.Proxy (Proxy (..))
25import Data.Typeable (TypeRep, Typeable, typeRep)
17import Data.Typeable (TypeRep, Typeable, typeRep)
26import GHC.Base (Any)
18import GHC.Base (Any)
@@ -28,9 +20,8 @@ import Unsafe.Coerce (unsafeCoerce)
28
20
29import qualified Data.Map.Lazy as LMap
21import qualified Data.Map.Lazy as LMap
30
22
31−
32-- | Map-like data structure with types served as the keys.
23-- | Map-like data structure with types served as the keys.
33−newtype TypeRepMap (f :: k -> Type) = TypeRepMap
24+newtype TypeRepMap (f :: k -> *) = TypeRepMap
34 { unMap :: LMap.Map TypeRep Any
25 { unMap :: LMap.Map TypeRep Any
35 }
26 }
36
27
typerep-extra-impls/Data/TypeRep/OptimalVector.hs+8−16
@@ -1,16 +1,9 @@
1−{-# LANGUAGE BangPatterns #-}
1+{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE GADTs #-}
2+{-# LANGUAGE GADTs #-}
3+{-# LANGUAGE KindSignatures #-}
3−{-# LANGUAGE MagicHash #-}
4+{-# LANGUAGE MagicHash #-}
4−{-# LANGUAGE PolyKinds #-}
5+{-# LANGUAGE PolyKinds #-}
5−{-# LANGUAGE TypeFamilies #-}
6+{-# LANGUAGE TypeFamilies #-}
6−
7−{- |
8−Copyright: (c) 2017-2020 Kowainik
9−SPDX-License-Identifier: MPL-2.0
10−Maintainer: Kowainik <xrom.xkov@gmail.com>
11−
12−TypeRepMap implementation based on the optimal Vector.
13−-}
14
7
15module Data.TypeRep.OptimalVector
8module Data.TypeRep.OptimalVector
16 ( -- * Map type
9 ( -- * Map type
@@ -43,7 +36,6 @@ import Unsafe.Coerce (unsafeCoerce)
43import qualified Data.Vector as V
36import qualified Data.Vector as V
44import qualified Data.Vector.Unboxed as Unboxed
37import qualified Data.Vector.Unboxed as Unboxed
45
38
46−
47data TypeRepMap (f :: k -> Type) = TypeRepMap
39data TypeRepMap (f :: k -> Type) = TypeRepMap
48 { fingerprintAs :: Unboxed.Vector Word64
40 { fingerprintAs :: Unboxed.Vector Word64
49 , fingerprintBs :: Unboxed.Vector Word64
41 , fingerprintBs :: Unboxed.Vector Word64
@@ -61,7 +53,7 @@ empty :: TypeRepMap f
61empty = TypeRepMap mempty mempty mempty
53empty = TypeRepMap mempty mempty mempty
62
54
63-- | Inserts the value with its type as a key.
55-- | Inserts the value with its type as a key.
64−insert :: forall a f . a -> TypeRepMap f -> TypeRepMap f
56+insert :: forall a f . Typeable a => a -> TypeRepMap f -> TypeRepMap f
65insert = undefined
57insert = undefined
66
58
67-- | Looks up the value at the type.
59-- | Looks up the value at the type.
@@ -111,7 +103,7 @@ binarySearch (Fingerprint a b) fpAs fpBs =
111data TF f where
103data TF f where
112 TF :: Typeable a => f a -> TF f
104 TF :: Typeable a => f a -> TF f
113
105
114−fromF :: f a -> Proxy a
106+fromF :: Typeable a => f a -> Proxy a
115fromF _ = Proxy
107fromF _ = Proxy
116
108
117fromList :: forall f . [TF f] -> TypeRepMap f
109fromList :: forall f . [TF f] -> TypeRepMap f
typerep-extra-impls/Data/TypeRep/Vector.hs+2−11
@@ -7,14 +7,6 @@
7{-# LANGUAGE PolyKinds #-}
7{-# LANGUAGE PolyKinds #-}
8{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
9
9
10−{- |
11−Copyright: (c) 2017-2020 Kowainik
12−SPDX-License-Identifier: MPL-2.0
13−Maintainer: Kowainik <xrom.xkov@gmail.com>
14−
15−TypeRepMap implementation based on Vector.
16−-}
17−
18module Data.TypeRep.Vector
10module Data.TypeRep.Vector
19 ( TypeRepVector (..)
11 ( TypeRepVector (..)
20 , TF (..)
12 , TF (..)
@@ -41,7 +33,6 @@ import qualified Data.Vector.Generic as G
41import qualified Data.Vector.Generic.Mutable as M
33import qualified Data.Vector.Generic.Mutable as M
42import qualified Data.Vector.Unboxed as Unboxed
34import qualified Data.Vector.Unboxed as Unboxed
43
35
44−
45data instance Unboxed.MVector s Fingerprint = MFingerprintVector (Unboxed.MVector s Word64) (Unboxed.MVector s Word64)
36data instance Unboxed.MVector s Fingerprint = MFingerprintVector (Unboxed.MVector s Word64) (Unboxed.MVector s Word64)
46data instance Unboxed.Vector Fingerprint = FingerprintVector (Unboxed.Vector Word64) (Unboxed.Vector Word64)
37data instance Unboxed.Vector Fingerprint = FingerprintVector (Unboxed.Vector Word64) (Unboxed.Vector Word64)
47
38
@@ -144,7 +135,7 @@ empty :: TypeRepVector f
144empty = TypeRepVect mempty mempty
135empty = TypeRepVect mempty mempty
145
136
146-- | Inserts the value with its type as a key.
137-- | Inserts the value with its type as a key.
147−insert :: forall a f . a -> TypeRepVector f -> TypeRepVector f
138+insert :: forall a f . Typeable a => a -> TypeRepVector f -> TypeRepVector f
148insert = undefined
139insert = undefined
149
140
150-- | Looks up the value at the type.
141-- | Looks up the value at the type.
@@ -164,7 +155,7 @@ size = Unboxed.length . fingerprints
164data TF f where
155data TF f where
165 TF :: Typeable a => f a -> TF f
156 TF :: Typeable a => f a -> TF f
166
157
167−fromF :: f a -> Proxy a
158+fromF :: Typeable a => f a -> Proxy a
168fromF _ = Proxy
159fromF _ = Proxy
169
160
170fromList :: forall f . [TF f] -> TypeRepVector f
161fromList :: forall f . [TF f] -> TypeRepVector f
typerep-map.cabal+16−32
@@ -1,6 +1,6 @@
1cabal-version: 2.4
1cabal-version: 2.4
2name: typerep-map
2name: typerep-map
3−version: 0.3.3.0
3+version: 0.3.2
4synopsis: Efficient implementation of a dependent map with types as keys
4synopsis: Efficient implementation of a dependent map with types as keys
5description:
5description:
6 A dependent map from type representations to values of these types.
6 A dependent map from type representations to values of these types.
@@ -19,11 +19,11 @@ description:
19
19
20homepage: https://github.com/kowainik/typerep-map
20homepage: https://github.com/kowainik/typerep-map
21bug-reports: https://github.com/kowainik/typerep-map/issues
21bug-reports: https://github.com/kowainik/typerep-map/issues
22−license: MPL-2.0
22+license: MIT
23license-file: LICENSE
23license-file: LICENSE
24author: Veronika Romashkina, Vladislav Zavialov, Dmitrii Kovanikov
24author: Veronika Romashkina, Vladislav Zavialov, Dmitrii Kovanikov
25maintainer: Kowainik <xrom.xkov@gmail.com>
25maintainer: Kowainik <xrom.xkov@gmail.com>
26−copyright: 2017-2020 Kowainik
26+copyright: 2017-2019 Kowainik
27category: Data, Data Structures, Types
27category: Data, Data Structures, Types
28build-type: Simple
28build-type: Simple
29extra-doc-files: README.md
29extra-doc-files: README.md
@@ -31,40 +31,20 @@ extra-doc-files: README.md
31tested-with: GHC == 8.2.2
31tested-with: GHC == 8.2.2
32 , GHC == 8.4.4
32 , GHC == 8.4.4
33 , GHC == 8.6.5
33 , GHC == 8.6.5
34− , GHC == 8.8.3
35− , GHC == 8.10.1
36
34
37source-repository head
35source-repository head
38 type: git
36 type: git
39 location: https://github.com/kowainik/typerep-map.git
37 location: https://github.com/kowainik/typerep-map.git
40
38
41common common-options
39common common-options
42− build-depends: base >= 4.10 && < 4.15
40+ build-depends: base >= 4.10 && < 4.13
43
41
44 default-language: Haskell2010
42 default-language: Haskell2010
45 default-extensions: BangPatterns
43 default-extensions: BangPatterns
46− DerivingStrategies
47 OverloadedStrings
44 OverloadedStrings
48 RecordWildCards
45 RecordWildCards
49 ScopedTypeVariables
46 ScopedTypeVariables
50 TypeApplications
47 TypeApplications
51− ghc-options: -Wall
52− -Wcompat
53− -Widentities
54− -Wincomplete-uni-patterns
55− -Wincomplete-record-updates
56− if impl(ghc >= 8.0)
57− ghc-options: -Wredundant-constraints
58− if impl(ghc >= 8.2)
59− ghc-options: -fhide-source-paths
60− if impl(ghc >= 8.4)
61− ghc-options: -Wmissing-export-lists
62− -Wpartial-fields
63− if impl(ghc >= 8.8)
64− ghc-options: -Wmissing-deriving-strategies
65− -Werror=missing-deriving-strategies
66− if impl(ghc >= 8.10)
67− ghc-options: -Wunused-packages
68
48
69library
49library
70 import: common-options
50 import: common-options
@@ -73,7 +53,8 @@ library
73 Data.TypeRepMap
53 Data.TypeRepMap
74 Data.TypeRepMap.Internal
54 Data.TypeRepMap.Internal
75
55
76− build-depends: ghc-prim >= 0.5.1.1 && < 0.7
56+ build-depends: containers >= 0.5.10.2 && < 0.7
57+ , ghc-prim ^>= 0.5.1.1
77 , primitive ^>= 0.7.0
58 , primitive ^>= 0.7.0
78 , deepseq ^>= 1.4
59 , deepseq ^>= 1.4
79
60
@@ -95,17 +76,20 @@ test-suite typerep-map-test
95
76
96 main-is: Test.hs
77 main-is: Test.hs
97 other-modules: Test.TypeRep.CMap
78 other-modules: Test.TypeRep.CMap
98− , Test.TypeRep.TypeRepMap
79+ , Test.TypeRep.CacheMap
99− , Test.TypeRep.TypeRepMapProperty
80+ , Test.TypeRep.MapProperty
100 , Test.TypeRep.Vector
81 , Test.TypeRep.Vector
101 , Test.TypeRep.VectorOpt
82 , Test.TypeRep.VectorOpt
102
83
84+ build-tool-depends: tasty-discover:tasty-discover
103− build-depends: ghc-typelits-knownnat >= 0.4.2 && < 0.8
85+ build-depends: ghc-typelits-knownnat >= 0.4.2 && < 0.7
104 , hedgehog ^>= 1.0
86 , hedgehog ^>= 1.0
105− , hspec ^>= 2.7.1
106− , hspec-hedgehog ^>= 0.0.1
107 , typerep-map
87 , typerep-map
108 , typerep-extra-impls
88 , typerep-extra-impls
89+ , tasty >= 1.0.1.1 && < 1.3
90+ , tasty-discover >= 4.1.1 && < 4.3
91+ , tasty-hedgehog ^>= 1.0.0.0
92+ , tasty-hspec ^>= 1.1.5
109
93
110 ghc-options: -threaded -rtsopts -with-rtsopts=-N
94 ghc-options: -threaded -rtsopts -with-rtsopts=-N
111
95
@@ -125,8 +109,8 @@ benchmark typerep-map-benchmark
125 build-depends: criterion >= 1.4.1.0 && < 1.6
109 build-depends: criterion >= 1.4.1.0 && < 1.6
126 , deepseq ^>= 1.4.3.0
110 , deepseq ^>= 1.4.3.0
127 , dependent-map >= 0.2.4.0 && < 0.5
111 , dependent-map >= 0.2.4.0 && < 0.5
128− , dependent-sum >= 0.5 && < 0.8
112+ , dependent-sum ^>= 0.5
129− , ghc-typelits-knownnat >= 0.4.2 && < 0.8
113+ , ghc-typelits-knownnat >= 0.4.2 && < 0.7
130 , typerep-map
114 , typerep-map
131 , typerep-extra-impls
115 , typerep-extra-impls
132
116