org.linqs.psl.reasoner.term

Interface TermStore<T extends ReasonerTerm,V extends ReasonerLocalVariable>

All Superinterfaces:

Iterable<T>

All Known Subinterfaces:

VariableTermStore<T,V>

All Known Implementing Classes:

ADMMTermStore, DCDMemoryTermStore, DCDStreamingTermStore, MemoryConsensusTermStore, MemoryTermStore, MemoryVariableTermStore, OnlineTermStore, SGDMemoryTermStore, SGDOnlineTermStore, SGDStreamingTermStore, StreamingTermStore

public interface TermStore<T extends ReasonerTerm,V extends ReasonerLocalVariable>
extends Iterable<T>

A place to store terms that are to be optimized.

Method Summary

Modifier and Type	Method and Description
void	add(GroundRule rule, T term, Hyperplane hyperplane) Add a term to the store that was generated from the given ground rule.
void	clear() Remove any existing terms and prepare for a new set.
void	close() Close down the term store, it will not be used any more.
V	createLocalVariable(GroundAtom atom) Create a variable local to a specific reasoner term.
void	ensureCapacity(long capacity) Ensure that the underlying structures can have the required term capacity.
void	ensureVariableCapacity(int capacity) Ensure that the underlying structures can have the required variable capacity.
T	get(long index)
void	initForOptimization() A notification by the Reasoner that optimization is about to begin.
void	iterationComplete() A notification by the Reasoner that a single iteration is complete.
Iterator<T>	noWriteIterator() Get an iterator over the terms in the store that does not write to disk.
void	reset() Reset the existing terms for another round of inference.
long	size()
double	syncAtoms() Ensure that atoms tracked by this term store match the internal representation of those atoms.
void	variablesExternallyUpdated() Notify the term store that the variables have been updated through a process external to standard optimization.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

void add(GroundRule rule,
         T term,
         Hyperplane hyperplane)

Add a term to the store that was generated from the given ground rule. The hyperplane used to create the term is provided for reference.

clear

void clear()

Remove any existing terms and prepare for a new set.

reset

void reset()

Reset the existing terms for another round of inference. Atom values are used to reset variables. Does NOT clear().

close

void close()

Close down the term store, it will not be used any more.

iterationComplete

void iterationComplete()

A notification by the Reasoner that a single iteration is complete. TermStores may use this as a chance to update and data structures.

initForOptimization

void initForOptimization()

A notification by the Reasoner that optimization is about to begin. TermStores may use this as a chance to finalize data structures.

get

T get(long index)

size

long size()

ensureCapacity

void ensureCapacity(long capacity)

Ensure that the underlying structures can have the required term capacity. This is more of a hint to the store about how much memory will be used. This is best called on an empty store so it can prepare.

ensureVariableCapacity

void ensureVariableCapacity(int capacity)

Ensure that the underlying structures can have the required variable capacity. This is more of a hint to the store about how much memory will be used. This is best called on an empty store so it can prepare. Not all term stores will even manage variables.

createLocalVariable

V createLocalVariable(GroundAtom atom)

Create a variable local to a specific reasoner term.

variablesExternallyUpdated

void variablesExternallyUpdated()

Notify the term store that the variables have been updated through a process external to standard optimization.

noWriteIterator

Iterator<T> noWriteIterator()

Get an iterator over the terms in the store that does not write to disk.

syncAtoms

double syncAtoms()

Ensure that atoms tracked by this term store match the internal representation of those atoms. Note that atoms not tracked by this term store may not be updated.

Returns:

The RMSE between the tracked atoms and their internal representation.