Struct GroundingSpace 

pub struct GroundingSpace<D: DuplicationStrategy = AllowDuplication> { /* private fields */ }

In-memory space which can contain grounded atoms.

Implementations

impl GroundingSpace

pub fn new() -> Self

Constructs new empty space.

pub fn from_vec(atoms: Vec<Atom>) -> Self

Constructs space from vector of atoms.

impl<D: DuplicationStrategy> GroundingSpace<D>

pub fn with_strategy(strategy: D) -> Self

Constructs new empty space using duplication strategy.

pub fn add(&mut self, atom: Atom)

Adds atom into space.

Examples

use hyperon_atom::sym;
use hyperon_atom::matcher::BindingsSet;
use hyperon::space::grounding::GroundingSpace;

let mut space = GroundingSpace::from_vec(vec![sym!("A")]);

space.add(sym!("B"));

assert_eq!(space.query(&sym!("A")), BindingsSet::single());
assert_eq!(space.query(&sym!("B")), BindingsSet::single());
assert_eq!(space.query(&sym!("C")), BindingsSet::empty());

pub fn remove(&mut self, atom: &Atom) -> bool

Removes atom from space. Returns true if atom was found and removed, and false otherwise.

Examples

use hyperon_atom::sym;
use hyperon_atom::matcher::BindingsSet;
use hyperon::space::grounding::GroundingSpace;

let mut space = GroundingSpace::from_vec(vec![sym!("A")]);

space.remove(&sym!("A"));

assert_eq!(space.query(&sym!("A")), BindingsSet::empty());

pub fn replace(&mut self, from: &Atom, to: Atom) -> bool

Replaces from atom to to atom inside space. Doesn’t add to when from is not found. Returns true if atom was found and replaced, and false otherwise.

Examples

use hyperon_atom::sym;
use hyperon_atom::matcher::BindingsSet;
use hyperon::space::grounding::GroundingSpace;

let mut space = GroundingSpace::from_vec(vec![sym!("A")]);

space.replace(&sym!("A"), sym!("B"));

assert_eq!(space.query(&sym!("A")), BindingsSet::empty());
assert_eq!(space.query(&sym!("B")), BindingsSet::single());

pub fn query(&self, query: &Atom) -> BindingsSet

Executes query on the space and returns variable bindings found. Query may include sub-queries glued by [COMMA_SYMBOL] symbol. Each Bindings instance in the returned [BindingsSet] represents single result.

Examples

use hyperon_atom::{expr, bind_set, sym};
use hyperon_atom::matcher::BindingsSet;
use hyperon::space::grounding::GroundingSpace;

let space = GroundingSpace::from_vec(vec![expr!("A" "B"), expr!("B" "C")]);
let query = expr!("," ("A" x) (x "C"));

let result = space.query(&query);

assert_eq!(result, bind_set![{x: sym!("B")}]);

pub fn set_name(&mut self, name: String)

Sets the name property for the GroundingSpace which can be useful for debugging

pub fn name(&self) -> Option<&str>

Returns the name property for the GroundingSpace, if one has been set

Trait Implementations

impl<D: Clone + DuplicationStrategy> Clone for GroundingSpace<D>

fn clone(&self) -> GroundingSpace<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: DuplicationStrategy> Debug for GroundingSpace<D>

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

Formats the value using the given formatter.

impl<D: DuplicationStrategy> Display for GroundingSpace<D>

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

Formats the value using the given formatter.

impl Space for GroundingSpace

fn common(&self) -> FlexRef<'_, SpaceCommon>

Access the SpaceCommon object owned by the Space

fn query(&self, query: &Atom) -> BindingsSet

Executes query on the space and returns variable bindings found. Query may include sub-queries glued by [grounding::COMMA_SYMBOL] symbol. Each Bindings instance in the returned [BindingsSet] represents single result.

fn atom_count(&self) -> Option<usize>

Returns the number of Atoms in the space, or None if this can’t be determined

fn visit(&self, v: &mut dyn SpaceVisitor) -> Result<(), ()>

Visit each atom of the space and call [SpaceVisitor::accept] method. This method is optional. Return Err(()) if method is not implemented. Cow<Atom> is used to allow passing both references and values. First is appropriate for collection based atomspace. Second one is more usable if atomspace is a generator or when values cannot be extracted easily and should be reconstructed instead.

fn as_any(&self) -> &dyn Any

Returns an &dyn Any for spaces where this is possible

fn subst(&self, pattern: &Atom, template: &Atom) -> Vec<Atom>

Executes pattern query on the space and for each result substitutes variables in template by the values from pattern. Returns results of the substitution.

impl SpaceMut for GroundingSpace

fn add(&mut self, atom: Atom)

Adds atom into space.

fn remove(&mut self, atom: &Atom) -> bool

Removes atom from space. Returns true if atom was found and removed, and false otherwise.

fn replace(&mut self, from: &Atom, to: Atom) -> bool

Replaces from atom to to atom inside space. Doesn’t add to when from is not found. Returns true if atom was found and replaced, and false otherwise.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns an &mut dyn Any for spaces where this is possible