Crate egglog 

egglog

egglog is a language specialized for writing equality saturation applications. It is the successor to the rust library egg. egglog is faster and more general than egg.

Documentation

Documentation for the egglog language can be found here: Command.

Tutorial

We have a text tutorial on egglog and how to use it. We also have a slightly outdated video tutorial.

Re-exports

pub use ast::ResolvedExpr;

pub use ast::ResolvedFact;

pub use ast::ResolvedVar;

Modules

ast

constraint

extract

prelude

This module makes it easier to use egglog from Rust. It is intended to be imported fully.

scheduler

sort

util

Macros

action

actions

add_primitive

This macro lets the user declare custom egglog primitives. It supports a few special features:

call

datatype

Adds sorts and constructor tables to the database.

expr

fact

facts

lit

match_term_app

sort

span

var

vars

Structs

CommandMacroRegistry

A registry of command macros

EGraph

The main interface for an e-graph in egglog.

ExecutionState

A handle on a database that may be in the process of running a rule.

Function

A function in the e-graph.

FunctionRow

A struct representing the content of a row in a function table

NotFoundError

ResolvedSchema

SerializeConfig

SerializeOutput

Output of serializing an e-graph, including values that were omitted if any.

SpecializedPrimitive

TermDag

A hashconsing arena for Terms.

TypeInfo

Stores resolved typechecking information.

Value

A generic identifier representing an egglog value

Enums

CommandOutput

Output from a command.

Error

ResolvedCall

RunMode

SerializedNode

A node in the serialized egraph.

Term

Like Exprs but with sharing and deduplication.

TypeError

Constants

GLOBAL_NAME_PREFIX

Traits

BaseValue

A simple data type that can be interned in a database.

CommandMacro

A command macro that can transform commands during desugaring

ContainerValue

A trait implemented by container types.

Primitive

A trait for implementing custom primitive operations in egglog.

UserDefinedCommand

A user-defined command allows users to inject custom command that can be called in an egglog program.

UserDefinedCommandOutput

A user-defined command output trait.

Functions

cli

Start a command-line interface for the E-graph.

file_supports_proofs

Type Aliases

ArcSort

Atom

AtomTerm

TermId