Skip to main content

IrProgram

Struct IrProgram 

Source
pub struct IrProgram {
    pub clauses: Vec<IrClause>,
    pub queries: Vec<IrQuery>,
    pub tabled_predicates: HashSet<(String, usize)>,
    pub diff_neural_predicates: HashSet<(String, usize, String)>,
    pub neural_gen_predicates: HashSet<(String, usize)>,
    pub neural_models: HashMap<String, String>,
    pub actions: Vec<IrAction>,
    pub neural_unify_threshold: f64,
    pub type_hierarchy: Vec<(Vec<String>, Option<String>)>,
}
Expand description

A complete IR program: a collection of clauses, queries, and planning actions.

Fields§

§clauses: Vec<IrClause>

All clauses (facts and rules) in the program.

§queries: Vec<IrQuery>

All queries in the program.

§tabled_predicates: HashSet<(String, usize)>

Predicates declared with :- table functor/arity.

§diff_neural_predicates: HashSet<(String, usize, String)>

Predicates declared with :- differentiable neural functor/arity using "model".

§neural_gen_predicates: HashSet<(String, usize)>

Generative neural predicates declared with :- neural_gen functor/arity.

§neural_models: HashMap<String, String>

Mapping from neural predicate (name/arity) to a named model (from :- neural_model).

§actions: Vec<IrAction>

STRIPS-style planning actions registered in this program.

§neural_unify_threshold: f64

Cosine-similarity threshold used by the ~= (neural unification) operator.

Set via :- neural_unify threshold(<value>).; defaults to 0.85.

§type_hierarchy: Vec<(Vec<String>, Option<String>)>

PDDL type hierarchy: each entry is (child_types, parent).

Preserves the full type hierarchy from a PDDL domain so that round-tripping through IR does not flatten the type tree. For example, city location - object and truck car - vehicle become [ (["city", "location"], Some("object")), (["truck", "car"], Some("vehicle")) ].

Union (either) types in parameter annotations are stored with |-separated names (e.g. "brick|window").

Implementations§

Source§

impl IrProgram

Source

pub fn new() -> Self

Create an empty IrProgram.

Source§

impl IrProgram

Source

pub fn validate_actions(&self) -> Result<(), (usize, ActionValidationError)>

Validate all actions in the program, returning the index of the first invalid action together with its ActionValidationError, or Ok(()) if all actions are well-formed.

This is a convenience wrapper around IrAction::validate that makes it easy to gate the planning pipeline on structural correctness.

§Example
use gollum_ir::{IrAction, IrProgram, IrTerm};

let mut prog = IrProgram::new();
prog.actions.push(IrAction {
    name: "move".into(),
    parameters: vec!["X".into(), "Y".into()],
    preconditions: vec![
        IrTerm::Structure { name: "at".into(), args: vec![IrTerm::Var("X".into())] },
    ],
    effects: vec![
        IrTerm::Structure { name: "at".into(), args: vec![IrTerm::Var("Y".into())] },
    ],
    metadata: None,
});
assert!(prog.validate_actions().is_ok());

Trait Implementations§

Source§

impl Clone for IrProgram

Source§

fn clone(&self) -> IrProgram

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IrProgram

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for IrProgram

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for IrProgram

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for IrProgram

Source§

fn eq(&self, other: &IrProgram) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for IrProgram

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for IrProgram

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,