Merge branch 'main' into yihozhang-fix-subsume2

Author: yihozhang

.github/workflows/deploy.yml

@@ -29,7 +29,7 @@ jobs:
     # (https://github.com/orgs/community/discussions/7730)
     # this can be removed.
     - name: Upload web artifact
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: www
         path: target/www

CHANGELOG.md

@@ -2,6 +2,56 @@
 
 ## [Unreleased] - ReleaseDate
 
+## [0.4.0] - 2024-1-TODO
+
+Semantic change (BREAKING)
+
+- Split `function` into `constructor` and `functions` with merge functions. (#461)
+- Remove `:default` keyword. (#461)
+- Disallow lookup functions in the right hand side. (#461)
+- Remove `:on_merge`, `:cost`, and `:unextractable` from functions, require `:no-merge` (#485)
+
+Language features
+
+- Add multi-sets (#446, #454, #471)
+- Recursive datatypes with `datatype*` (#432)
+- Add `BigInt` and `BigRat` and move `Rational` to `egglog-experimental` (#457, #475, #499)
+
+Command-line interface and web demo
+
+- Display build info when in binary mode (#427)
+- Expose egglog CLI (#507, #510)
+- Add a new interactive visualizer (#426)
+- Disable build script for library builds (#467)
+
+Rust interface improvements
+
+- Make the type constraint system user-extensible (#509)
+- New extensible parser (#435, #450, #484, #489, #497, #498, #506)
+- Remove `Value::tag` when in release mode (#448)
+
+Extraction
+
+- Remove unused 'serde-1' attribute (#465)
+- Extract egraph-serialize features  (#466)
+- Expose extraction module publicly (#503)
+- Use `set-of` instead of `set-insert` for extraction result of sets. (#514)
+
+Bug fixes
+
+- Fix the behavior of i64 primitives on overflow (#502)
+- Fix memory blowup issue in `TermDag::to_string`
+- Fix the issue that rule names are ignored (#500)
+
+Cleanups and improvements
+
+- Allow disabling messages for performance (#492)
+- Determinize egglog (#438, #439)
+- Refactor sort extraction API (#495)
+- Add automated benchmarking to continuous integration (#443)
+- Improvements to performance of testing (#458)
+- Other small cleanups and improvements (#428, #429, #433, #434, #436, #437, #440, #442, #444, #445, #449, #453, #456, #469, #474, #477, #490, #491, #494, #501, #504, #508, #511)
+
 ## [0.3.0] - 2024-9-12
 
 Cleanups
@@ -79,6 +129,7 @@ As of yet, the rust interface is not documented or well supported. We reccomend
 [0.1.0]: https://github.com/egraphs-good/egglog/tree/v0.1.0
 [0.2.0]: https://github.com/egraphs-good/egglog/tree/v0.2.0
 [0.3.0]: https://github.com/egraphs-good/egglog/tree/v0.3.0
+[0.4.0]: https://github.com/egraphs-good/egglog/tree/v0.4.0
 
 
 See release-instructions.md for more information on how to do a release.

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "egglog"
-version = "0.3.0"
+version = "0.4.0"
 description = "egglog is a language that combines the benefits of equality saturation and datalog. It can be used for analysis, optimization, and synthesis of programs. It is the successor to the popular rust library egg."
 repository = "https://github.com/egraphs-good/egglog"
 keywords = ["e-graphs", "egglog", "datalog", "compiler", "equality"]
@@ -33,7 +33,6 @@ bin = [
   "graphviz",
   "dep:clap",
   "dep:env_logger",
-  "dep:serde_json",
   "dep:chrono",
 ]
 serde = ["egraph-serialize/serde"]
@@ -42,38 +41,28 @@ wasm-bindgen = ["instant/wasm-bindgen", "dep:getrandom"]
 nondeterministic = []
 
 [dependencies]
+clap = { version = "4", features = ["derive"], optional = true }
+egraph-serialize = { version = "0.2.0", default-features = false }
+env_logger = { version = "0.10", optional = true }
 hashbrown = { version = "0.15" }
+im-rc = "15.1.0"
+im = "15.1.0"
 indexmap = "2.0"
 instant = "0.1"
+lazy_static = "1.4"
 log = "0.4"
+num = "0.4.3"
+ordered-float = { version = "3.7" }
 rustc-hash = "1.1"
+smallvec = "1.11"
 symbol_table = { version = "0.4.0", features = ["global"] }
 thiserror = "1"
-lazy_static = "1.4"
-num = "0.4.3"
-smallvec = "1.11"
-
-egraph-serialize = { version = "0.2.0", default-features = false }
-
-# binary dependencies
-clap = { version = "4", features = ["derive"], optional = true }
-env_logger = { version = "0.10", optional = true }
-serde_json = { version = "1.0.100", optional = true, features = [
-  "preserve_order",
-] }
-
-ordered-float = { version = "3.7" }
 
 # Need to add "js" feature for "graphviz-rust" to work in wasm
-getrandom = { version = "0.2.10", features = ["js"], optional = true }
-
-im-rc = "15.1.0"
-im = "15.1.0"
+getrandom = { version = "0.2.10", optional = true, features = ["js"] }
 
 [build-dependencies]
-chrono = { version = "0.4", default-features = false, optional = true, features = [
-  "now",
-] }
+chrono = { version = "0.4", default-features = false, features = ["now"], optional = true }
 
 [dev-dependencies]
 codspeed-criterion-compat = "2.7.2"

Cargo.toml

@@ -93,66 +93,3 @@ env RUST_LOG=error samply record ./target/profiling/egglog --dont-print-messages
 
 To view documentation, run `cargo doc --open`.
 
-
-
-TODO migrate the following documentation to cargo doc:
-### Sort: i64
-
-Signed 64-bit integers supporting these primitives:
-
-```
-+ - * / %           ; arithmetic
-& | ^ << >> not-i64 ; bit-wise operations
-< > <= >=           ; comparisons
-min max log2
-to-f64
-to-string
-```
-
-### Sort: f64
-
-64-bit floating point numbers supporting these primitives:
-
-```
-+ - * / %           ; arithmetic
-< > <= >=           ; comparisons
-min max neg
-to-i64
-to-string
-```
-
-### Sort: map
-
-A map from a key type to a value type supporting these primitives:
-
-```
-empty
-insert
-get
-not-contains
-contains
-set-union
-set-diff
-set-intersect
-map-remove
-```
-
-### Sort: rational
-
-Rational numbers (fractions) with 64-bit precision for numerator and denominator with these primitives:
-
-```
-+ - * /         ; arithmetic
-min max neg abs floor ceil round
-rational        ; construct from a numerator and denominator
-numer denom     ; get numerator and denominator
-pow log sqrt
-< > <= >=       ; comparisons
-```
-
-These primitives are only defined when the result itself is a pure rational.
-
-### Sort: string
-
-Use double quotes to get a quote: `"Foo "" Bar"` is `Foo " Bar`.
-No primitives defined.

README.md

@@ -338,7 +338,7 @@ impl EGraph {
 
                     let variants = values[1].bits as i64;
                     if variants == 0 {
-                        let (cost, term) = self.extract(values[0], &mut termdag, sort);
+                        let (cost, term) = self.extract(values[0], &mut termdag, sort)?;
                         // dont turn termdag into a string if we have messages disabled for performance reasons
                         if self.messages_enabled() {
                             let extracted = termdag.to_string(&term);

src/actions.rs

@@ -112,7 +112,7 @@ pub(crate) fn desugar_command(
             let s = std::fs::read_to_string(&file)
                 .unwrap_or_else(|_| panic!("{span} Failed to read file {file}"));
             return desugar_program(
-                parse_program(Some(file), &s, parser)?,
+                parser.get_program_from_string(Some(file), &s)?,
                 parser,
                 seminaive_transform,
             );

src/ast/desugar.rs

@@ -130,24 +130,30 @@ impl ResolvedExpr {
     }
 }
 
-impl Expr {
-    pub fn call_no_span(op: impl Into<Symbol>, children: impl IntoIterator<Item = Self>) -> Self {
-        Self::Call(
-            DUMMY_SPAN.clone(),
-            op.into(),
-            children.into_iter().collect(),
-        )
-    }
+#[macro_export]
+macro_rules! call {
+    ($func:expr, $args:expr) => {
+        $crate::ast::GenericExpr::Call($crate::span!(), $func.into(), $args.into_iter().collect())
+    };
+}
 
-    pub fn lit_no_span(lit: impl Into<Literal>) -> Self {
-        Self::Lit(DUMMY_SPAN.clone(), lit.into())
-    }
+#[macro_export]
+macro_rules! lit {
+    ($lit:expr) => {
+        $crate::ast::GenericExpr::Lit($crate::span!(), $lit.into())
+    };
+}
 
-    pub fn var_no_span(v: impl Into<Symbol>) -> Self {
-        Self::Var(DUMMY_SPAN.clone(), v.into())
-    }
+#[macro_export]
+macro_rules! var {
+    ($var:expr) => {
+        $crate::ast::GenericExpr::Var($crate::span!(), $var.into())
+    };
 }
 
+// Rust macro annoyance; see stackoverflow.com/questions/26731243/how-do-i-use-a-macro-across-module-files
+pub use {call, lit, var};
+
 impl<Head: Clone + Display, Leaf: Hash + Clone + Display + Eq> GenericExpr<Head, Leaf> {
     pub fn span(&self) -> Span {
         match self {