diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# 0.0.5.2 + +- Updated links to source repository in package metadata. + # 0.0.5.1 - Added support for GHC version `9.14`. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ )](https://hackage.haskell.org/package/monoidmap) [![Development Branch]( https://img.shields.io/badge/Development%20Branch-API%20Documentation-225577 -)](https://jonathanknowles.github.io/monoidmap/) +)](https://jonathanknowles.github.io/monoidmap/monoidmap/) # Overview @@ -15,11 +15,11 @@ - encodes key-value mappings with a [minimal encoding](#encoding) that only includes values _not_ equal to [`mempty`][`Monoid.mempty`]. - provides a comprehensive set of [monoidal operations](#monoidal-operations) for transforming, combining, and comparing maps. -- provides a [general basis](#General-basis-for-more-specialised-map-types) for building more specialised monoidal data structures. +- provides a [general basis](#general-basis-for-more-specialised-map-types) for building more specialised monoidal data structures. # Relationship between keys and values -A map of type MonoidMap k v associates **every** possible key of type `k` with a value of type `v`: +A map of type MonoidMap k v associates **every** possible key of type `k` with a value of type `v`: ```hs MonoidMap.get :: (Ord k, Monoid v) => k -> MonoidMap k v -> v @@ -255,22 +255,22 @@ - null + null $O(1)$ $O(n)$ - nonNull + nonNull $O(1)$ $O(n)$ - nonNullCount + nonNullCount $O(1)$ $O(n)$ - toMap + toMap $O(1)$ $O(n)$ @@ -297,7 +297,7 @@ Since all [`MonoidMap`] operations perform automatic minimisation when appropriate, it's not necessary for users to reason about when or whether it's necessary to "trim" the map. -Furthermore, for nested maps such as MonoidMap k1 (MonoidMap k2 v), automatic minimisation of inner maps enables seamless automatic minimisation of outer maps. See the [`NestedMonoidMap`] type for an example of this. +Furthermore, for nested maps such as MonoidMap k1 (MonoidMap k2 v), automatic minimisation of inner maps enables seamless automatic minimisation of outer maps. See the [`NestedMonoidMap`] type for an example of this. ## Limitations of automatic minimisation @@ -400,34 +400,34 @@ - append + append Semigroup (<>) - ∀ k. get k (m1 <> m2) ≡ get k m1 <> get k m2 + ∀ k. get k (m1 <> m2) ≡ get k m1 <> get k m2 - minus + minus Group (~~) - ∀ k. get k (m1 ~~ m2) ≡ get k m1 ~~ get k m2 + ∀ k. get k (m1 ~~ m2) ≡ get k m1 ~~ get k m2 - monus + monus Monus (<\>) - ∀ k. get k (m1 <\> m2) ≡ get k m1 <\> get k m2 + ∀ k. get k (m1 <\> m2) ≡ get k m1 <\> get k m2 - intersection + intersection GCDMonoid gcd - ∀ k. get k (m1 `gcd` m2) ≡ get k m1 `gcd` get k m2 + ∀ k. get k (m1 `gcd` m2) ≡ get k m1 `gcd` get k m2 - union + union LCMMonoid lcm - ∀ k. get k (m1 `lcm` m2) ≡ get k m1 `lcm` get k m2 + ∀ k. get k (m1 `lcm` m2) ≡ get k m1 `lcm` get k m2 @@ -950,7 +950,7 @@ monoidmap
- + MonoidMap
@@ -1112,25 +1112,25 @@ [`Map`]: https://hackage.haskell.org/package/containers/docs/Data-Map-Strict.html#t:Map [`Maybe`]: https://hackage.haskell.org/package/base/docs/Data-Maybe.html#t:Maybe [`Monoid.mempty`]: https://hackage.haskell.org/package/base/docs/Data-Monoid.html#v:mempty -[`MonoidMap.adjust`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:adjust -[`MonoidMap.empty`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:empty -[`MonoidMap.intersection`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:intersection -[`MonoidMap.invert`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:invert -[`MonoidMap.map`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:map -[`MonoidMap.minus`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:minus -[`MonoidMap.set`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:set -[`MonoidMap.union`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#v:union -[`MonoidMap`]: https://jonathanknowles.github.io/monoidmap/Data-MonoidMap.html#t:MonoidMap +[`MonoidMap.adjust`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:adjust +[`MonoidMap.empty`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:empty +[`MonoidMap.intersection`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:intersection +[`MonoidMap.invert`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:invert +[`MonoidMap.map`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:map +[`MonoidMap.minus`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:minus +[`MonoidMap.set`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:set +[`MonoidMap.union`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#v:union +[`MonoidMap`]: https://jonathanknowles.github.io/monoidmap/monoidmap/Data-MonoidMap.html#t:MonoidMap [`MonoidNull.null`]: https://hackage.haskell.org/package/monoid-subclasses/docs/Data-Monoid-Null.html#v:null [`MonoidNull`]: https://hackage.haskell.org/package/monoid-subclasses/docs/Data-Monoid-Null.html#t:MonoidNull [`Monoid`]: https://hackage.haskell.org/package/base/docs/Data-Monoid.html#t:Monoid [`MultiAsset.AssetName`]: https://github.com/input-output-hk/cardano-ledger/blob/b00e28698d9c7fbbeda1c9cfdd1238d3bc4569cf/eras/mary/impl/src/Cardano/Ledger/Mary/Value.hs#L110 [`MultiAsset.PolicyID`]: https://github.com/input-output-hk/cardano-ledger/blob/b00e28698d9c7fbbeda1c9cfdd1238d3bc4569cf/eras/mary/impl/src/Cardano/Ledger/Mary/Value.hs#L140 -[`MultiAsset.insertMultiAsset`]: https://github.com/input-output-hk/cardano-ledger/blob/b00e28698d9c7fbbeda1c9cfdd1238d3bc4569cf/eras/mary/impl/src/Cardano/Ledger/Mary/Value.hs#LL831C1-L868C10 +[`MultiAsset.insertMultiAsset`]: https://github.com/input-output-hk/cardano-ledger/blob/b00e28698d9c7fbbeda1c9cfdd1238d3bc4569cf/eras/mary/impl/src/Cardano/Ledger/Mary/Value.hs#L831-L868 [`MultiAsset`]: https://github.com/input-output-hk/cardano-ledger/blob/b00e28698d9c7fbbeda1c9cfdd1238d3bc4569cf/eras/mary/impl/src/Cardano/Ledger/Mary/Value.hs#L157 [`MultiMap.alterWithKey`]: https://hackage.haskell.org/package/multi-containers/docs/Data-Multimap.html#v:alterWithKey [`MultiMap`]: https://hackage.haskell.org/package/multi-containers/docs/Data-Multimap.html#t:Multimap -[`NestedMonoidMap`]: https://github.com/jonathanknowles/monoidmap/blob/main/components/monoidmap-examples/Examples/NestedMonoidMap.hs +[`NestedMonoidMap`]: https://github.com/jonathanknowles/monoidmap/blob/main/packages/monoidmap-examples/components/monoidmap-examples/Data/MonoidMap/Examples/NestedMonoidMap.hs [`NonEmpty`]: https://hackage.haskell.org/package/base/docs/Data-List-NonEmpty.html#t:NonEmpty [`Nothing`]: https://hackage.haskell.org/package/base/docs/Data-Maybe.html#v:Nothing [`Semigroup`]: https://hackage.haskell.org/package/base/docs/Data-Semigroup.html#t:Semigroup diff --git a/monoidmap.cabal b/monoidmap.cabal --- a/monoidmap.cabal +++ b/monoidmap.cabal @@ -1,6 +1,7 @@ cabal-version: 3.0 name: monoidmap -version: 0.0.5.1 +version: 0.0.5.2 +homepage: https://github.com/jonathanknowles/monoidmap bug-reports: https://github.com/jonathanknowles/monoidmap/issues license: Apache-2.0 license-file: LICENSE @@ -54,6 +55,7 @@ source-repository head type: git location: https://github.com/jonathanknowles/monoidmap + subdir: packages/monoidmap library import: