Crate clingo

source ·
Expand description

clingo-rs Build Status Latest Version Rust Documentation

Rust bindings to the clingo library. Clingo version 5.5.0.

Requirements

  • a c++14 conforming compiler
    • at least gcc version 4.9
    • clang version 3.1 (using either libstdc++ provided by gcc 4.9 or libc++)

Per default the crate uses the clingo library via dynamic linking. It is assumed that a clingo dynamic library is installed on the system. You have to set the environment variable CLINGO_LIBRARY_PATH. For example:

export CLINGO_LIBRARY_PATH=/scratch/miniconda3/envs/test/lib

Examples

cargo run --example=ast 0
cargo run --example=backend 0
cargo run --example=configuration
cargo run --example=control 0
cargo run --example=model 0
cargo run --example=propagator 0
cargo run --example=solve-async 0
cargo run --example=statistics 0
cargo run --example=symbol 0
cargo run --example=symbolic-atoms 0
cargo run --example=theory-atoms 0
cargo run --example=inject-terms 0
cargo run --example=version

Features

Using derive macro

The crate provides a derive macro to help easing the use of rust data types as facts.

In your Cargo.toml add:

[dependencies]
clingo = { version = "0.7.3", features = ["derive"] }

In your source write:

ⓘ
use clingo::ToSymbol;
use clingo::ClingoError;
use clingo::FactBase;

#[derive(ToSymbol)]
struct MyPoint {
    x: i32,
    y: i32,
}

let p = MyPoint{ x:4, y:2 };
let fb = FactBase::new();
fb.insert(p);

The macro performs a conversion to snake case. This means the corresponing fact for MyPoint{x:4,y:2} is my_point(4,2).

Using static-linking

You can use the clingo library via static linking.

The recommended way to use the optional static linking support is as follows.

[dependencies]
clingo = { version = "0.7.3", features = ["static-linking"] }

Contribution

How to make a contribution to clingo-rs?

Any contribution intentionally submitted for inclusion in the work by you, shall be licensed under the terms of the MIT license without any additional terms or conditions.

Modules

Structs

Enums

  • ClauseType
    Enumeration of clause types determining the lifetime of a clause.
  • ClingoError
    ClingoError in the rust wrapper, like null pointers or failed matches of C enums.
  • ErrorCode
    Enumeration of clingo error codes for ClingoError::InternalError.
  • ErrorType
    Enumeration of clingo error types See: set_error()
  • ExternalType
    Enumeration of different external statements.
  • HeuristicType
    Enumeration of different heuristic modifiers.
  • ModelType
    Enumeration for the different model types.
  • PropagatorCheckMode
    Supported check modes for propagators. Note that total checks are subject to the lock when a model is found. This means that information from previously found models can be used to discard assignments in check calls.
  • SolveEvent
    Enumeration of solve events.
  • StatisticsType
    Enumeration for entries of the statistics.
  • SymbolType
    Enumeration of available symbol types.
  • TheoryTermType
    Enumeration of theory term types.
  • TruthValue
    Represents three-valued truth values.
  • Warning
    Enumeration of warning codes.
  • WeigthConstraintType
    Enumeration of weight_constraint_types.

Traits

  • FromSymbol
  • FunctionHandler
  • GroundProgramObserver
    An instance of this struct has to be registered with a solver to observe ground directives as they are passed to the solver.
  • Logger
    An instance of this trait has to be registered with a solver to implement a custom logging.
  • Propagator
    An instance of this trait has to be registered with a solver to implement a custom propagator.
  • SolveEventHandler
  • ToSymbol
    helper types and traits to simplify conversion from structs to clingo symbols

Functions

Type Aliases

Derive Macros