From 57f79f2065c133c2967689c24deb41317f95426c Mon Sep 17 00:00:00 2001 From: Heinrich Apfelmus Date: Wed, 26 Feb 2025 16:31:17 +0100 Subject: [PATCH 1/3] Update `delta-types.cabal` --- lib/delta-types/CHANGELOG.md | 5 + lib/delta-types/LICENSE | 202 ++++++++++++++++++++++++++++++ lib/delta-types/delta-types.cabal | 25 ++-- 3 files changed, 222 insertions(+), 10 deletions(-) create mode 100644 lib/delta-types/CHANGELOG.md create mode 100644 lib/delta-types/LICENSE diff --git a/lib/delta-types/CHANGELOG.md b/lib/delta-types/CHANGELOG.md new file mode 100644 index 00000000000..068d6fdc645 --- /dev/null +++ b/lib/delta-types/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for delta-types + +## 1.0.0.0 — 2025-02-26 + +* Initial version diff --git a/lib/delta-types/LICENSE b/lib/delta-types/LICENSE new file mode 100644 index 00000000000..d6456956733 --- /dev/null +++ b/lib/delta-types/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/lib/delta-types/delta-types.cabal b/lib/delta-types/delta-types.cabal index 91b94d5a02e..d1dffcef581 100644 --- a/lib/delta-types/delta-types.cabal +++ b/lib/delta-types/delta-types.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: delta-types -version: 0.2025.1.9 +version: 1.0.0.0 synopsis: Delta types, also known as change actions. description: A __delta type__ @da@ for a __base type__ @a@ is a collection @@ -13,14 +13,19 @@ description: * [Fixing Incremental Computation: Derivatives of Fixpoints, and the Recursive Semantics of Datalog](http://arxiv.org/abs/1811.06069) (Here, the concept of a delta type is called a __change action__.) homepage: https://github.com/cardano-foundation/cardano-wallet +license: Apache-2.0 +license-file: LICENSE author: Cardano Foundation (High Assurance Lab) maintainer: hal@cardanofoundation.org -copyright: 2021-2023 IOHK, 2024 Cardano Foundation -license: Apache-2.0 +copyright: 2021-2023 IOHK, 2024-2025 Cardano Foundation category: Data Structures build-type: Simple -extra-source-files: - README.md +tested-with: + GHC == 9.6.6 + +extra-doc-files: + README.md + CHANGELOG.md common language default-language: @@ -61,10 +66,10 @@ library import: language, opts-lib hs-source-dirs: src build-depends: - , base - , containers - , fmt - , semigroupoids + , base >= 4.14 && < 5 + , containers >= 0.5 && < 0.8 + , fmt >= 0.6.3.0 && < 0.7 + , semigroupoids >= 6.0.1 && < 6.1 exposed-modules: Data.Delta Data.Delta.Core @@ -80,7 +85,7 @@ test-suite unit main-is: Main.hs build-depends: , base - , hspec + , hspec >= 2.11.0 && < 2.12 build-tool-depends: hspec-discover:hspec-discover other-modules: Data.DeltaSpec From 2a3b9a15336afe8f8728d4c2e1bb41a9df9c69d2 Mon Sep 17 00:00:00 2001 From: Heinrich Apfelmus Date: Thu, 27 Feb 2025 13:44:20 +0100 Subject: [PATCH 2/3] Split off `Data.Delta.Embedding.Internal` --- lib/delta-store/src/Data/Store.hs | 8 ++- lib/delta-types/delta-types.cabal | 1 + lib/delta-types/src/Data/Delta/Embedding.hs | 60 +++------------- .../src/Data/Delta/Embedding/Internal.hs | 71 +++++++++++++++++++ 4 files changed, 86 insertions(+), 54 deletions(-) create mode 100644 lib/delta-types/src/Data/Delta/Embedding/Internal.hs diff --git a/lib/delta-store/src/Data/Store.hs b/lib/delta-store/src/Data/Store.hs index bc0364fbe52..d73444bd251 100644 --- a/lib/delta-store/src/Data/Store.hs +++ b/lib/delta-store/src/Data/Store.hs @@ -106,11 +106,15 @@ import Data.Delta ( Delta (..) , Embedding , Embedding' (..) - , Machine (..) , Replace (..) - , inject + ) +import Data.Delta.Embedding + ( inject , project ) +import Data.Delta.Embedding.Internal + ( Machine (..) + ) import Data.Kind ( Type ) diff --git a/lib/delta-types/delta-types.cabal b/lib/delta-types/delta-types.cabal index d1dffcef581..341fed30be4 100644 --- a/lib/delta-types/delta-types.cabal +++ b/lib/delta-types/delta-types.cabal @@ -74,6 +74,7 @@ library Data.Delta Data.Delta.Core Data.Delta.Embedding + Data.Delta.Embedding.Internal Data.Delta.List Data.Delta.Map Data.Delta.Set diff --git a/lib/delta-types/src/Data/Delta/Embedding.hs b/lib/delta-types/src/Data/Delta/Embedding.hs index 236b24204cd..df8837e75ff 100644 --- a/lib/delta-types/src/Data/Delta/Embedding.hs +++ b/lib/delta-types/src/Data/Delta/Embedding.hs @@ -13,7 +13,6 @@ Embeddings of delta types. -} module Data.Delta.Embedding ( -- $Embedding - -- * Embedding Embedding , module Data.Semigroupoid , Embedding' (..) @@ -26,10 +25,6 @@ module Data.Delta.Embedding ( -- * Internal , inject , project - , Machine (..) - , idle - , pairMachine - , fromState ) where import Prelude @@ -41,6 +36,11 @@ import Data.Delta.Core ( Delta (..) , Replace (..) ) +import Data.Delta.Embedding.Internal + ( Machine (..) + , fromState + , pairMachine + ) import Data.Either ( fromRight ) @@ -52,6 +52,7 @@ import Data.Semigroupoid Embedding -------------------------------------------------------------------------------} {- $Embedding +#doc:Embedding# An 'Embedding'@ da db@ embeds one type and its delta type @da@ into another type and its delta type @db@. @@ -103,7 +104,8 @@ properties: -- | Specification of an embedding of a type @a@ with delta types @da@ -- into the type @b@ with delta type @db@. --- See [the discussion of @Embedding@](#g:3) for a more detailed description. +-- See [the discussion of @Embedding@](#doc:Embedding) +-- for a more detailed description. data Embedding' da db where Embedding' :: (Delta da, Delta db, a ~ Base da, b ~ Base db) => @@ -208,49 +210,3 @@ applyWithEmbedding => Embedding da db -> (da -> a -> a) applyWithEmbedding e delta1 a = apply (update e a delta1) a -} - -{------------------------------------------------------------------------------- - Machine (state machines) with efficient composition --------------------------------------------------------------------------------} --- Strict pair. --- If a value of this type is in WHNF, so are the two components. --- data StrictPair a b = !a :*: !b --- infixr 1 :*: - --- | A state machine that maps deltas to deltas. --- This machine always carries a state of type 'Base'@ db@ around. -data Machine da db = Machine - { state_ :: !(Base db) - , step_ :: (Base da, da) -> (db, Machine da db) - } - --- | Composition of 'Machine' -instance Semigroupoid Machine where - (Machine c fbc) `o` (Machine b fab) = Machine c $ \ada -> - case fab ada of - (db, mab) -> case fbc (b,db) of - (dc, mbc) -> (dc, mbc `o` mab) - --- | Identity machine starting from a base type. -idle :: Delta da => Base da -> Machine da da -idle a0 = Machine a0 $ \(a1,da) -> let a2 = apply da a1 in (da, idle a2) - --- | Pair two 'Machine's. -pairMachine - :: Machine da1 db1 -> Machine da2 db2 -> Machine (da1,da2) (db1,db2) -pairMachine (Machine s1 step1) (Machine s2 step2) = - Machine (s1,s2) $ \((a1,a2), (da1,da2)) -> - let (db1, m1) = step1 (a1,da1) - (db2, m2) = step2 (a2,da2) - in ((db1,db2), pairMachine m1 m2) - --- | Create a 'Machine' from a specific state @s@, --- and the built-in state 'Base'@ db@. -fromState - :: Delta db - => ((Base da, da) -> (Base db, s) -> (db, s)) - -> (Base db, s) - -> Machine da db -fromState step (b,s0) = Machine b $ \ada -> - case step ada (b,s0) of - (db,s1) -> (db, fromState step (apply db b,s1)) diff --git a/lib/delta-types/src/Data/Delta/Embedding/Internal.hs b/lib/delta-types/src/Data/Delta/Embedding/Internal.hs new file mode 100644 index 00000000000..ff4d616651d --- /dev/null +++ b/lib/delta-types/src/Data/Delta/Embedding/Internal.hs @@ -0,0 +1,71 @@ +{-# LANGUAGE GADTs #-} +{-# LANGUAGE TypeFamilies #-} + +{-| +Copyright: © 2021-2023 IOHK, 2024-2025 Cardano Foundation +License: Apache-2.0 + +Internal representation of 'Embedding' +in terms of state machines. +-} +module Data.Delta.Embedding.Internal ( + Machine (..) + , idle + , pairMachine + , fromState + ) where + +import Prelude + +import Data.Delta.Core + ( Delta (..) + ) +import Data.Semigroupoid + ( Semigroupoid (..) + ) + +{------------------------------------------------------------------------------- + Machine (state machines) with efficient composition +-------------------------------------------------------------------------------} +-- Strict pair. +-- If a value of this type is in WHNF, so are the two components. +-- data StrictPair a b = !a :*: !b +-- infixr 1 :*: + +-- | A state machine that maps deltas to deltas. +-- This machine always carries a state of type 'Base'@ db@ around. +data Machine da db = Machine + { state_ :: !(Base db) + , step_ :: (Base da, da) -> (db, Machine da db) + } + +-- | Composition of 'Machine' +instance Semigroupoid Machine where + (Machine c fbc) `o` (Machine b fab) = Machine c $ \ada -> + case fab ada of + (db, mab) -> case fbc (b,db) of + (dc, mbc) -> (dc, mbc `o` mab) + +-- | Identity machine starting from a base type. +idle :: Delta da => Base da -> Machine da da +idle a0 = Machine a0 $ \(a1,da) -> let a2 = apply da a1 in (da, idle a2) + +-- | Pair two 'Machine's. +pairMachine + :: Machine da1 db1 -> Machine da2 db2 -> Machine (da1,da2) (db1,db2) +pairMachine (Machine s1 step1) (Machine s2 step2) = + Machine (s1,s2) $ \((a1,a2), (da1,da2)) -> + let (db1, m1) = step1 (a1,da1) + (db2, m2) = step2 (a2,da2) + in ((db1,db2), pairMachine m1 m2) + +-- | Create a 'Machine' from a specific state @s@, +-- and the built-in state 'Base'@ db@. +fromState + :: Delta db + => ((Base da, da) -> (Base db, s) -> (db, s)) + -> (Base db, s) + -> Machine da db +fromState step (b,s0) = Machine b $ \ada -> + case step ada (b,s0) of + (db,s1) -> (db, fromState step (apply db b,s1)) From 7c8e66b05d98811219cbd542e61a05d847e51d86 Mon Sep 17 00:00:00 2001 From: Heinrich Apfelmus Date: Thu, 27 Feb 2025 14:05:52 +0100 Subject: [PATCH 3/3] Remove dependency on `fmt` in `delta-types` --- lib/delta-types/delta-types.cabal | 1 - lib/delta-types/src/Data/Delta/Map.hs | 8 -------- 2 files changed, 9 deletions(-) diff --git a/lib/delta-types/delta-types.cabal b/lib/delta-types/delta-types.cabal index 341fed30be4..9669cfa3689 100644 --- a/lib/delta-types/delta-types.cabal +++ b/lib/delta-types/delta-types.cabal @@ -68,7 +68,6 @@ library build-depends: , base >= 4.14 && < 5 , containers >= 0.5 && < 0.8 - , fmt >= 0.6.3.0 && < 0.7 , semigroupoids >= 6.0.1 && < 6.1 exposed-modules: Data.Delta diff --git a/lib/delta-types/src/Data/Delta/Map.hs b/lib/delta-types/src/Data/Delta/Map.hs index 7da272336ff..e6d9ab06726 100644 --- a/lib/delta-types/src/Data/Delta/Map.hs +++ b/lib/delta-types/src/Data/Delta/Map.hs @@ -21,10 +21,6 @@ import Data.Delta.Core import Data.Map.Strict ( Map ) -import Fmt - ( Buildable (..) - ) - import qualified Data.Map.Strict as Map {------------------------------------------------------------------------------- @@ -43,7 +39,3 @@ instance (Ord key, Delta da) apply (Insert key a) = Map.insert key a apply (Delete key) = Map.delete key apply (Adjust key da) = Map.adjust (apply da) key - -instance (Show key, Show da, Show (Base da)) - => Buildable (DeltaMap key da) where - build = build . show