fr.lirmm.graphik.integraal.forward_chaining.BreadthFirstChase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of integraal-graal-ruleset-analysis Show documentation
Show all versions of integraal-graal-ruleset-analysis Show documentation
Rule base analysis for InteGraal. This is imported from Graal
/*
* Copyright (C) Inria Sophia Antipolis - Méditerranée / LIRMM
* (Université de Montpellier & CNRS) (2014 - 2017)
*
* Contributors :
*
* Clément SIPIETER
* Mélanie KÖNIG
* Swan ROCHER
* Jean-François BAGET
* Michel LECLÈRE
* Marie-Laure MUGNIER
*
*
* This file is part of Graal .
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
*
*/
package fr.lirmm.graphik.integraal.forward_chaining;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
import fr.lirmm.graphik.integraal.api.core.Atom;
import fr.lirmm.graphik.integraal.api.core.AtomSet;
import fr.lirmm.graphik.integraal.api.core.AtomSetException;
import fr.lirmm.graphik.integraal.api.core.InMemoryAtomSet;
import fr.lirmm.graphik.integraal.api.core.Predicate;
import fr.lirmm.graphik.integraal.api.core.Query;
import fr.lirmm.graphik.integraal.api.core.Rule;
import fr.lirmm.graphik.integraal.api.core.RulesCompilation;
import fr.lirmm.graphik.integraal.api.forward_chaining.AbstractChase;
import fr.lirmm.graphik.integraal.api.forward_chaining.ChaseException;
import fr.lirmm.graphik.integraal.api.forward_chaining.ChaseHaltingCondition;
import fr.lirmm.graphik.integraal.api.forward_chaining.RuleApplier;
import fr.lirmm.graphik.integraal.api.homomorphism.Homomorphism;
import fr.lirmm.graphik.integraal.api.homomorphism.HomomorphismWithCompilation;
import fr.lirmm.graphik.integraal.core.atomset.DefaultInMemoryAtomSet;
import fr.lirmm.graphik.integraal.core.atomset.graph.DefaultInMemoryGraphStore;
import fr.lirmm.graphik.integraal.core.ruleset.IndexedByBodyPredicatesRuleSet;
import fr.lirmm.graphik.integraal.forward_chaining.rule_applier.DefaultRuleApplier;
import fr.lirmm.graphik.integraal.forward_chaining.rule_applier.DefaultRuleApplierWithCompilation;
import fr.lirmm.graphik.integraal.forward_chaining.rule_applier.RestrictedChaseRuleApplier;
import fr.lirmm.graphik.util.stream.CloseableIterator;
import fr.lirmm.graphik.util.stream.CloseableIteratorWithoutException;
/**
* At each step, this chase (forward-chaining) algorithm computes all the
* homomorphisms from the rule bodies to the specified AtomSet then perform
* the corresponding rule applications. At each step after the first one, rules
* are checked based on the presence of a predicate of their body in the head of
* a rule applied in the previous step. Furthermore, for optimization reasons,
* linear rules (with a single atom in the body) are applied over a set of atoms
* restricted to the atoms generated at the previous step which have the same
* predicate as the body rule atom.
*
* @author Clément Sipieter (INRIA)
*
*/
public class BreadthFirstChase extends AbstractChase {
private IndexedByBodyPredicatesRuleSet ruleSet;
private AtomSet atomSet;
private InMemoryAtomSet tmpData = new DefaultInMemoryAtomSet();
private Map rulesToCheck;
private Map nextRulesToCheck;
// /////////////////////////////////////////////////////////////////////////
// CONSTRUCTORS
// /////////////////////////////////////////////////////////////////////////
public BreadthFirstChase(Iterator rules, AtomSet atomSet) {
super(new RestrictedChaseRuleApplier());
this.atomSet = atomSet;
this.ruleSet = new IndexedByBodyPredicatesRuleSet();
init(rules);
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet) {
super(new RestrictedChaseRuleApplier());
this.atomSet = atomSet;
this.ruleSet = new IndexedByBodyPredicatesRuleSet();
init(rules.iterator());
}
public BreadthFirstChase(Iterator rules, AtomSet atomSet, RuleApplier ruleApplier) {
super(ruleApplier);
this.atomSet = atomSet;
this.ruleSet = new IndexedByBodyPredicatesRuleSet();
init(rules);
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet, RuleApplier ruleApplier) {
this(rules.iterator(), atomSet, ruleApplier);
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet, Homomorphism solver) {
this(rules, atomSet, new DefaultRuleApplier(solver));
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet, ChaseHaltingCondition haltingCondition) {
this(rules, atomSet, new DefaultRuleApplier(haltingCondition));
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet, Homomorphism solver,
ChaseHaltingCondition haltingCondition) {
this(rules, atomSet, new DefaultRuleApplier(solver, haltingCondition));
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet, RulesCompilation compilation) {
this(rules, atomSet, new DefaultRuleApplierWithCompilation(compilation));
}
public BreadthFirstChase(Iterator rules, AtomSet atomSet, RulesCompilation compilation) {
this(rules, atomSet, new DefaultRuleApplierWithCompilation(compilation));
}
public BreadthFirstChase(Iterable rules, AtomSet atomSet, RulesCompilation compilation,
HomomorphismWithCompilation h) {
this(rules, atomSet, new DefaultRuleApplierWithCompilation(h, compilation));
}
private void init(Iterator rules) {
this.nextRulesToCheck = new TreeMap();
while (rules.hasNext()) {
Rule r = rules.next();
this.ruleSet.add(r);
this.nextRulesToCheck.put(r, atomSet);
}
}
// /////////////////////////////////////////////////////////////////////////
// PUBLICS METHODS
// /////////////////////////////////////////////////////////////////////////
@Override
public void next() throws ChaseException {
this.rulesToCheck = this.nextRulesToCheck;
this.nextRulesToCheck = new TreeMap();
try {
if (!this.rulesToCheck.isEmpty()) {
if (this.getProfiler().isProfilingEnabled()) {
this.getProfiler().start("saturationTime");
}
for (Entry e : this.rulesToCheck.entrySet()) {
String key = null;
Rule rule = e.getKey();
AtomSet data = e.getValue();
if (this.getProfiler().isProfilingEnabled()) {
key = "Rule " + rule.getLabel() + " application time";
this.getProfiler().clear(key);
this.getProfiler().trace(rule.toString());
this.getProfiler().start(key);
}
CloseableIterator it = this.getRuleApplier().delegatedApply(rule, data, this.atomSet);
tmpData.addAll(it); // extension locale
it.close();
if (this.getProfiler().isProfilingEnabled()) {
this.getProfiler().stop(key);
}
}
this.dispatchNewData(this.tmpData); // met à jour les prochaines règles à appliquer et leur champ d'application (cas des linéaires)
this.atomSet.addAll(this.tmpData); // extension globale
this.tmpData.clear();
if (this.getProfiler().isProfilingEnabled()) {
this.getProfiler().stop("saturationTime");
}
}
} catch (Exception e) {
throw new ChaseException("An error occured during saturation step.", e);
}
}
@Override
public boolean hasNext() {
return !this.nextRulesToCheck.isEmpty();
}
// /////////////////////////////////////////////////////////////////////////
// PRIVATE CLASS
// /////////////////////////////////////////////////////////////////////////
protected void dispatchNewData(InMemoryAtomSet newData) throws ChaseException {
CloseableIteratorWithoutException it = newData.iterator();
while (it.hasNext()) {
Atom a = it.next();
Predicate p = a.getPredicate();
for (Rule r : ruleSet.getRulesByBodyPredicate(p)) {
if (linearRuleCheck(r)) {
AtomSet set = nextRulesToCheck.get(r);
if (set == null) {
set = new DefaultInMemoryGraphStore();
nextRulesToCheck.put(r, set);
}
try {
set.add(a);
} catch (AtomSetException e) {
throw new ChaseException("Exception while adding data into a tmp store", e);
}
} else {
nextRulesToCheck.put(r, atomSet);
}
}
}
}
private static boolean linearRuleCheck(Rule r) {
CloseableIteratorWithoutException it = r.getBody().iterator();
if (it.hasNext()) {
it.next();
} else {
return false;
}
return !it.hasNext();
}
}