Hackage :: [Package]

WeakSets: Simple set types. Useful to create sets of arbitrary types and nested sets.

[ data, lgpl, library ] [ Propose Tags ] [ Report a vulnerability ]

This package answers two problems : how to make sets and maps of types which do not implement the Ord typeclass and how to make arbitrarily nested sets as set theory allows. The problems are resolved thanks to WeakSets and WeakMaps. A WeakSet is like a list where duplicates are considered the same when testing for equality. A WeakMap is a set of couples (key,value).

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 1.0.0.0, 1.1.0.0, 1.1.1.0, 1.1.2.0, 1.1.3.0, 1.1.4.0, 1.2.0.0, 1.2.2.0, 1.2.3.0, 1.2.4.0, 1.3.0.0, 1.3.1.0, 1.3.2.0, 1.3.3.0, 1.4.0.0, 1.4.0.1, 1.5.0.0, 1.6.0.0, 1.6.1.0
Change log CHANGELOG.md
Dependencies base (>=4 && <5) [details]
License LGPL-3.0-or-later
Author Guillaume Sabbagh
Maintainer guillaumesabbagh@protonmail.com
Category Data
Home page https://gitlab.utc.fr/gsabbagh/sets
Uploaded by gsabbagh at 2023-11-05T20:15:54Z
Distributions
Reverse Dependencies 2 direct, 0 indirect [details]
Downloads 1083 total (55 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for WeakSets-1.6.1.0

[back to package description]

WeakSets

This is a Haskell package which defines sets and maps in a more general way than Data.Set and Data.Map of the containers package.

This package answers three problems :

  • how to make sets of types which do not implement the Ord typeclass (which is required by Data.Set), this problem is solved by Data.WeakSet;
  • how to make maps of types which do not implement the Ord typeclass, this problem is solved by Data.WeakMap.

Data.WeakSet and Data.WeakMap are (almost) backward compatible with Data.Set and Data.Map. Therefore you can replace your imports of Data.Set to Data.WeakSet and Data.Map.Strict to Data.WeakMap safely. There a a few functions which require to add an Eq typeclass as a requirement. Some functions are not implemented as they really need the Ord typeclass, if you use them you should use Data.Set or Data.Map.

General info

A WeakSet is a list where duplicates elements and the order of elements are disregarded. Its stronger counterpart is Data.Set. Most of the functions related to WeakSet require the Eq typeclass.

A WeakMap is an association list where duplicates entries and the order of pairs are disregarded. Its stronger counterpart is Data.Map. Most of the functions related to WeakMap require the Eq typeclass.

Installation

cabal install WeakSets

Usage

Example usage of weak sets :

ghci> import Data.WeakSet.Safe
ghci> data Foo = Foo Int Char deriving (Eq, Show) -- an arbitrary type which is not required to implement Ord typeclass
ghci> s1 = set [Foo 3 'a', Foo 2 'c', Foo 3 'a']
ghci> s2 = set [Foo 2 'c', Foo 3 'a']
ghci> s1 == s2
True
ghci> s3 = set [Foo 2 'c', Foo 3 'a']
ghci> s4 = s1 ||| s3
ghci> s4
(set [Foo 3 'a',Foo 2 'c',Foo 3 'a',Foo 2 'c',Foo 3 'a'])
ghci> cardinal s4
2

Example usage of weak maps :

ghci> import Data.WeakMap.Safe
ghci> data Foo = Foo Int Char deriving (Eq) -- an arbitrary type which is not required to implement Ord typeclass
ghci> m1 = weakMap [(Foo 3 'a',1), (Foo 2 'c',5), (Foo 3 'a',3)]
ghci> m1 |!| (Foo 2 'c')
5

Contribution

Any input is appreciated ! Send an email for any remark or question. The git repository : https://gitlab.utc.fr/gsabbagh/sets