sets: Ducktyped set interface for Haskell containers.

[ bsd3, data, library ] [ Propose Tags ]

Please see the README on Github at https://github.com/athanclark/sets#readme


[Skip to Readme]
Versions [faq] 0.0.1, 0.0.1.1, 0.0.2, 0.0.2.1, 0.0.2.2, 0.0.2.3, 0.0.3, 0.0.4, 0.0.4.1, 0.0.5, 0.0.5.1, 0.0.5.2, 0.0.6, 0.0.6.1 (info)
Dependencies base (>=4.11 && <5.0), bytestring, commutative (>=0.0.2), composition, containers, contravariant, hashable, keys, mtl, QuickCheck (>=2.9.2), semigroupoids, semigroups, transformers, transformers-base, unordered-containers, vector, witherable [details]
License BSD-3-Clause
Copyright 2018 Athan Clark
Author Athan Clark
Maintainer athan.clark@localcooking.com
Category Data
Home page https://github.com/athanclark/sets#readme
Bug tracker https://github.com/athanclark/sets/issues
Source repo head: git clone https://github.com/athanclark/sets
Uploaded by athanclark at Sun Jan 20 06:22:32 UTC 2019
Distributions NixOS:0.0.6.1
Downloads 5516 total (104 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2019-01-20 [all 3 reports]

Modules

  • Data
    • Set
      • Data.Set.Class
      • Ordered
        • Data.Set.Ordered.Many
          • Data.Set.Ordered.Many.With
        • Data.Set.Ordered.Unique
          • Data.Set.Ordered.Unique.Finite
          • Data.Set.Ordered.Unique.With
      • Unordered
        • Data.Set.Unordered.Many
        • Data.Set.Unordered.Unique

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for sets-0.0.6.1

[back to package description]

sets

This package provides overloaded terms, commonly used with set-like types, like Map and Set from containers. There are also unorthodox, mostly useless data types defined here - playing with ordering, uniqueness and finiteness.

Usage

The following actions are overloaded:

Binary Operators:

  • union
  • intersection
  • difference
  • complement

Top and Bottom Elements:

  • empty
  • total

Element-Wise Operations:

  • singleton
  • insert
  • delete

Metrics and Comparison:

  • size
  • isSubsetOf isProperSubsetOf

Each of the operations has their own typeclass. We have also made newtype wrappers for lists, for different restrictions:

  • Ordered Sets
    • Multiple
  • Unordered Sets
    • Unique
    • Multiple

This way, we can expect the following to work:

uniqueAppend :: Eq a => [a] -> [a] -> [a]
uniqueAppend xs ys = unUUSet $ fromFoldable xs `union` fromFoldable ys

orderedAppend :: Ord a => [a] -> [a] -> [a]
orderedAppend xs ys = unOMSet $ fromFoldable xs `union` fromFoldable ys

We've also made a few newtypes to encode our binary operations, for Monoid and Semigroup instances:

instance (HasUnion s, HasEmpty s) => Monoid (Union s) where
  mempty = empty
  mappend = union

Multiple Set Types

To use the overloaded terms, they need to be the only ones in scope. To make this correct, we need to import our container with caution:

import qualified Data.Set as Set
import Data.Map (Map) -- only the type name to designate behavior

foo :: Map
foo = x `union` y

bar :: Set.Set
bar = a `union` b

This way, we can keep our code more readable while still having set-like intuition.

Testing and Benchmarking

You can view the results here (warning: it's a 7MB text file - your browser will hate you)

The tests are built with QuickCheck - it's pretty easy to get them working for you:

cabal install --enable-tests
cabal test --show-details=always

(...or for the stack folk...)

stack build
stack test

To benchmark (it usually takes about 10 minutes on my laptop), run the command!

cabal install --enable-benchmarks
cabal bench

(...stiggitty-stack is co-wiggity-whack...)

stack build
stack bench --benchmark-arguments="--output profile.html"