View Source API Reference Guesswork v0.4.4

Modules

Guesswork allows the creation of logical statements and knowledge databases which then can be used together to figure out answers to questions stated in those logical systems.

Answers are maps of variable id to bindings as well as any tests that must be checked.

A 'bound' entity, that is a possible values (notted or exact) and computations, connected to a variable.

Represents some arbitrary computation that can be bound to a variable or used to verify correctness.

Represents a partially evaluated enumerable of answers, allowing the answer sets to be handled one at a time.

A module for evaluating and displaying query results.

A Guesswork.Answer.Computation bound to a concrete value that can be used to verify correctness.

Helper tools/macros for building rules and statements.

Simple conjunction.

A simple assignment of a value to a variable.

A fact is just a relationship (string) and some entities (concrete or non-concrete) and states that the relationship hold for those values in that order.

Binds a variable or entity to a function (computation). If a variable is used, the computation is used to figure out its value. If an entity is used, the computation is used to test validity.

Simple negation.

Binds a value to an Enumerable of possible values.

Simple disjunction.

A rule maps a (ideally non-concrete) fact to a defining statement.

A Statement is a semantically complete value. It is in no way required to be logically consistent.

Defines the options used by the Guesswork.Ast.Statement protocol.

A Term is any possible, computable value. Note that a term doesn't necessarily made any sense or have any semantic value.

Indicates an unbound entity (also called a non-concrete value).

A collection with no facts, falsehoods, or rules.

Represents a querable knowledge base.

Allows for the easy creation of Guesswork.KnowledgeBase by using the deffact/1, deffalsehood/1, and defrule/2 macros in modules that invoke use Guesswork.KnowledgeBase.Collection.

Represents a very basic knowledge base with all rules and facts stored in memory.

Represents an un-resolved query.

Used to track queries and their metrics.

Holds event handlers for telemetry events.

A paginated response, along with the token needed pull the next page.

Represents the tracked actions a query can take

Represents a single 'run', or resolution, of a query.

Represents a span within a query run.