kowainik/containers-backpack

🎒 Backpack interface for containers

containers-backpack's Issues

Add instance for `text-containers

This package:

• https://hackage.haskell.org/package/text-containers-0.1.0.0

Think more on tests for modifiable containers

Same as #41 but for insert/delete/etc. functions

Implement simple lookup benchmarks to

Basically, rewrite benchmarks from this module and them to map-contrib package:

• https://github.com/kowainik/vebt/blob/99ad48044248a6ecde03b86f8df06c5466106a9a/benchmark/Main.hs

It's okay to have Map.Group.Bench.Lookup module and depend on gauge library in map-contrib. We're in prototyping stage now, so it's completely okay to have non-optmized dependencies.

Implement signatures for `unpacked-containers` package

unpacked-containers is itself implemented with the help of Backpack! So it's rather exciting to have Map.hsig instance for this package as well.

Add `{-# INLINE #-}` pragmas to all instances

Some functions are reexported directly from the corresponding libraries. But most of them are implemented in our signatures. To improve performance, it's better to add {-# INLINE #-} pragma to every function.

So, for example, if we have:

singleton :: Key k => k -> v -> Map k v
singleton = HM.singleton

This should be written like this:

singleton :: Key k => k -> v -> Map k v
singleton = HM.singleton
{-# INLINE singleton #-}

And we should do this for every function in every instance.

Add signatures for `Set`

Probably this issue is not urgent, let's figure out proper interface for Maps first.

Create extra module in `containers-sig-*` packages with default implementations for some functions

There's this useful operator:

infixl 9 !?
(!?) :: Key k => Map k v -> k -> Maybe v
(!?) m k = lookup k m

And probably there exist other useful functions with default implementations. We need to collect such functions and put them near signatures. Though, good naming for module is most difficult part here...

Refactor `map-example` to produce something meaningfull

Change library to executable and print result to terminal. After something meaningful is implemented in contrib

Implement property-based tests for Map laws

Probably in separate package like containers-sig-laws.

Discuss separation on unit tests and property-based tests

Some tests introduced in #34 are unit tests and some are property-based tests. It would be really nice to somehow separate tests. For example, this one is unit test:

containers-backpack/containers-contrib-readonly/src/Map/Contrib/Laws.hs

Lines 21 to 22 in c84b22f

	nullEmpty :: Bool
	nullEmpty = null empty

But this looks like property-based test:

containers-backpack/containers-contrib-readonly/src/Map/Contrib/Laws.hs

Lines 65 to 72 in c84b22f

	lookupMatchMember :: Key k => k -> [(k, v)] -> Bool
	lookupMatchMember k (fromList -> m) = match (lookup k m) (member k m)
	where
	match :: Maybe v -> Bool -> Bool
	match Nothing False = True
	match Nothing True = False
	match (Just _) False = False
	match (Just _) True = True

I would love to have 3 test-suites:

1. test-suite for unit tests
2. test-suite for property tests
3. One test suite that combines them all.

My proposal is to use hspec for unit tests. QuickCheck can be used now for property-based tests.

Implement `Group` module in `map-contrib`

Basically, reimplement this module:

• https://github.com/kowainik/relude/blob/master/src/Relude/Extra/Group.hs

Get rid of `Gen` in the arguments

The following generator looks strange. Probably Gen is not needed there (or I'm not sure)

containers-backpack/containers-contrib-readonly/src/Map/Contrib/Laws.hs

Line 24 in c84b22f

nullImpliesZeroSize :: Key k => Gen [(k, v)] -> Gen Property

Rewrite to Multiple Public Libraries

And update the blog post accordingly.

Think more about package naming

Currently packages have the following name:

• map-sig: singatures for readonly maps
• map-sig-extended: signatures for modifiable maps
• map-containers-map: implementation of map-sig for Map.Lazy from containers package
• map-containers-intmap: implementation of map-sig for IntMap.Lazy from containers package
• map-unordered: implementation of map-sig for HashMap.Strict from unordered-containers
• (future) map-primitive: implementaiton of map-sig for pritimitive-containers
• map-contrib: different functions implemented using only map-sig package

map- prefix is not good because map-sig package also can have signatures for Set without any problems.

Any better suggestions?

Add package `map-unordered` with implementation for HashMap

See map-containers for example

Get rid of Proxy in laws suites

Currently suites take Proxy as an argument. But it's better to use AllowAmbiguousTypes extension to not pass Proxy and pass types directly.

containers-backpack/containers-contrib-readonly/src/Map/Contrib/Laws.hs

Lines 79 to 84 in c84b22f

	checkLaws
	:: forall k v. (Key k, Arbitrary k, Arbitrary v, Show k, Show v, Eq k, Eq v)
	=> Proxy k
	-> Proxy v
	-> IO ()
	checkLaws _ _ = do

`Map` and `HashMap` and `IntMap` both have `Lazy` and `Strict` variants

This means even more boilerplate code... We need to add the following:

• Map.Lazy
• HashMap.Lazy
• IntMap.Lazy

Remove `Key` constraint from `empty`

Need to open issue to primitive-containers package.

Add signatures and implementations of `union`, `intersect` and `difference` functions

Implement instance for `IntMap` with `coerce` instead of manual wrapping and unwrapping

It's better for performance reasons. But not obvious, how to achieve this...

Use main default branch

Add default implementations of some functions

These functions can be put directly to containers-sig-* packages.

• !? as an operator version of lookup
• // for Map difference

For example, there's this useful operator:

infixl 9 !?
(!?) :: Key k => Map k v -> k -> Maybe v
(!?) m k = lookup k m

And probably there exist other useful functions with default implementations. We need to collect such functions and put them near signatures. Though, good naming for module is most difficult part here...

Trouble pulling in containers via github

Hi,

I believe I found the relevant docs for how to do this. However, I'm still running into trouble. My commit shows the relevant changes to the stack/cabal files, but note that some of the code changes are nonsense. However, it appears to fail before the code changes would cause a compilation failure:

stack build 
Progress 0/5            containers-sig-readonly-0.0.0: configure (lib)
Progress 0/5            containers-sig-0.0.0: configure (lib)
Progress 0/5            containers-sig-readonly-0.0.0: build (lib)
Progress 0/5            containers-sig-readonly-0.0.0: copy/register
Progress 0/5            Progress 1/5: containers-ordered-strict-0.0.0, containers-sig-0.0.0                                                                   containers-ordered-strict-0.0.0: configure (lib)
Progress 1/5: containers-ordered-strict-0.0.0, containers-sig-0.0.0                                                                   containers-sig-0.0.0: build (lib)
Progress 1/5: containers-ordered-strict-0.0.0, containers-sig-0.0.0                                                                   containers-sig-0.0.0: copy/register
Progress 1/5: containers-ordered-strict-0.0.0, containers-sig-0.0.0                                                                   Progress 2/5: containers-contrib-0.0.0, containers-ordered-strict-0.0.0                                                                       containers-contrib-0.0.0: configure (lib)
Progress 2/5: containers-contrib-0.0.0, containers-ordered-strict-0.0.0                                                                       containers-ordered-strict-0.0.0: build (lib)
Progress 2/5: containers-contrib-0.0.0, containers-ordered-strict-0.0.0                                                                       containers-ordered-strict-0.0.0: copy/register
Progress 2/5: containers-contrib-0.0.0, containers-ordered-strict-0.0.0                                                                       containers-contrib-0.0.0: build (lib)
Progress 2/5: containers-contrib-0.0.0, containers-ordered-strict-0.0.0                                                                       Progress 3/5: containers-contrib-0.0.0                                      containers-contrib-0.0.0: copy/register
Progress 3/5: containers-contrib-0.0.0                                      hico-0.1.0.0: configure (lib + exe)
Progress 3/5: containers-contrib-0.0.0                                      Progress 4/5: hico-0.1.0.0                          Configuring hico-0.1.0.0...
Progress 4/5: hico-0.1.0.0                          Error:
Progress 4/5: hico-0.1.0.0                              The following packages are broken because other packages they depend on are missing. These broken packages must be rebuilt before they can be used.
Progress 4/5: hico-0.1.0.0                          planned package hico-0.1.0.0 is broken due to missing package containers-contrib-0.0.0-CVCQxd4JzxzGeMuWdr5u0d+B3uxSMlrl2y2Er6UNvkdGh
Progress 4/5: hico-0.1.0.0                          
Progress 4/5: hico-0.1.0.0                          Completed 5 action(s).

Think more on tests for containers-readonly

The tests are implemented in this module:

https://github.com/kowainik/containers-backpack/blob/master/containers-contrib-readonly/src/Map/Contrib/Laws.hs

Probably some tests are missing there. I propose to think more about all possible tests, document them in some mathy or unicode way and then add more tests if necessary.

Cleanup `containers-ordered-strict` package implementation by reexporting functions directly from `container` package

Like on this slide:

• http://slides.com/shersh/picnic#/10

Implement `nubViaSet`

Like in this module:

• https://github.com/kowainik/relude/blob/master/src/Relude/Nub.hs

Figure out way to add `primitive-containers` to benchmarks

The problem appeared in pull request by @yigitozkavci (#43). The fact that Map from primitive-containers doesn't have NFData instance doesn't allow to benchmark this data type...

Add instance for Map from `primitive-containers`

And write some function that uses only read-only operations.

Cleanup `containers-primitive`

This module:

• https://github.com/kowainik/containers-backpack/blob/master/containers-primitive/src/Map/Prim.hs

Basically, do similar things that were done in this PR:

• #29