|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectubc.cs.JLog.Foundation.jType
ubc.cs.JLog.Terms.jTerm
ubc.cs.JLog.Terms.iPredicate
ubc.cs.JLog.Terms.jBuiltinPredicate
public abstract class jBuiltinPredicate
This is the abstract base for builtin predicates. The parser must create the appropriate object for builtin predicates. Builtins do not appear in the database and are designed to provide a way to optimize a predicate or provide additional functionallity.
Field Summary |
---|
Fields inherited from class ubc.cs.JLog.Foundation.jType |
---|
type |
Fields inherited from interface ubc.cs.JLog.Terms.iTerm |
---|
EQUAL, GREATER_THAN, LESS_THAN |
Fields inherited from interface ubc.cs.JLog.Foundation.iType |
---|
TYPE_ARITHMETIC, TYPE_ATOM, TYPE_BUILTINPREDICATE, TYPE_COMMAND, TYPE_COMPARE, TYPE_COMPOUND, TYPE_CONS, TYPE_IF, TYPE_INTEGER, TYPE_LIST, TYPE_NULLLIST, TYPE_NUMERICCOMPARE, TYPE_OBJECT, TYPE_OPERATOR, TYPE_OR, TYPE_ORPREDICATE, TYPE_PREDICATE, TYPE_PREDICATETERMS, TYPE_REAL, TYPE_TYPE, TYPE_UNARYARITHMETIC, TYPE_UNARYOPERATOR, TYPE_UNDEFINED, TYPE_VARIABLE |
Constructor Summary | |
---|---|
jBuiltinPredicate()
|
Method Summary | |
---|---|
protected int |
compareArguments(iPredicate ipred,
boolean first_call,
boolean var_equal)
Compares predicate aguments. |
jTerm |
copy(jVariableRegistry vars)
Internal member function which creates a copy of this term. |
jTerm |
duplicate(jVariable[] vars)
Creates a complete and entirely independant duplicate of this term. |
void |
enumerateVariables(jVariableVector v,
boolean all)
Adds variables belonging to this term (or belonging to any sub-part of this term) to the jVariableVector |
boolean |
equivalence(jTerm term,
jEquivalenceMapping v)
The public interface for evaluating term equivalence (i.e., structural similarity). |
protected boolean |
equivalenceArguments(jBuiltinPredicate pterm,
jEquivalenceMapping v)
Equivalence test arguments. |
int |
getArity()
Returns the arity of this instance. |
boolean |
isConsultNeeded()
Determine if cached values already exist and hence if consulting is required. |
void |
registerVariables(jVariableVector v)
Adds all variables belonging to this term (or belonging to any sub-part of this term) to the jUnifiedVector
Should be called during the consultation phase by rules for their owned terms
both head and base. |
java.lang.String |
toString(boolean usename)
Produces a string identifying this term, suitable for display to the console. |
boolean |
unify(jTerm term,
jUnifiedVector v)
Unification. |
protected boolean |
unifyArguments(jBuiltinPredicate pterm,
jUnifiedVector v)
Unification of arguments. |
Methods inherited from class ubc.cs.JLog.Terms.iPredicate |
---|
addGoals, addGoals, compare, getArguments |
Methods inherited from class ubc.cs.JLog.Terms.jTerm |
---|
compare, consult, consultReset, copy, getName, getTerm, getValue, registerUnboundVariables, requiresCompleteVariableState, toString |
Methods inherited from class ubc.cs.JLog.Foundation.jType |
---|
getType, objectToString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface ubc.cs.JLog.Terms.iName |
---|
getName |
Constructor Detail |
---|
public jBuiltinPredicate()
Method Detail |
---|
public int getArity()
iNameArity
int
whose value is the arity of this instance.protected int compareArguments(iPredicate ipred, boolean first_call, boolean var_equal)
compareArguments
in class iPredicate
ipred
- the iPredicate
to compare with this instance of
iPredicate
.first_call
- true
if just invoked by public
compare
member function.
false
otherwise.var_equal
- if var_equal
is true
, then unbound
variables are considered equal.
var_equal
= false
is standard prolog
behavior.
LESS_THAN
if this instance is less than
term
,
EQUAL
if the two terms are equal, and
GREATER_THAN
if
this instance is greater than term
.public boolean isConsultNeeded()
iConsultable
isConsultNeeded
in interface iConsultable
isConsultNeeded
in interface iTerm
isConsultNeeded
in class jTerm
false
if cached values are valid,
true
otherwise, if consult
should be
called.public boolean equivalence(jTerm term, jEquivalenceMapping v)
iTerm
equivalence
in interface iTerm
equivalence
in class jTerm
term
- the jTerm
to compare with this instance of
jTerm
.v
- v
is the collection of equivalent variable pairs found.
It should be empty when first calling this function.
true
if this instance is equivalent to term
,
false
otherwise.public boolean unify(jTerm term, jUnifiedVector v)
unify
in interface iUnifiable
unify
in interface iTerm
unify
in class jTerm
term
- the term to unify with this instance.v
- the vector of variables bound during unification. Even if
unification fails, this vector may contain recently
bound vectors. This parameter is used to as output to the
caller, not as input for unify
.
true
if unification succeeded,
false
otherwise.protected boolean equivalenceArguments(jBuiltinPredicate pterm, jEquivalenceMapping v)
equivalence
.
pterm
- We are assured that pterm has the same type, name, and arity.v
- same as jEquivalenceMapping
parameter in
equivalence
.
protected boolean unifyArguments(jBuiltinPredicate pterm, jUnifiedVector v)
unify
.
pterm
- We are assured that pterm has the same type, name, and arity.v
- same as jUnifiedVector
parameter in
unify
.
public void registerVariables(jVariableVector v)
jTerm
jUnifiedVector
Should be called during the consultation phase by rules for their owned terms
both head and base. all variables encountered should be unbound.
After call, this term should not be modified in any way.
registerVariables
in interface iTerm
registerVariables
in class jTerm
v
- The jUnifiedVector
where variables are
added to. This parameter is used to as output to the
caller, not as input.public void enumerateVariables(jVariableVector v, boolean all)
jTerm
jVariableVector
enumerateVariables
in interface iTerm
enumerateVariables
in class jTerm
v
- The jVariabeVector
where variables are
added to. This parameter is used to as output to the
caller, not as input.all
- If true
, then all variables should register,
otherwise only add non-existentially qualified variables.public jTerm duplicate(jVariable[] vars)
jTerm
registerVariables
has already been
invoked.
Within duplicate
, any other calls to duplicate should pass along
the same vars
array produced by registerVariables
since the same duplication path previously taken by registerVariables
should be taken by duplicate
. This call is designed only for terms
which belong to rules and are templates for instantiation. Any variables in the
term should be unbound. As implied by the modification restrictions on
registerVariables
, terms and their children cannot change
(especially during call!)
duplicate
in interface iTerm
duplicate
in class jTerm
vars
- The user passes in a duplicate of the variable vector produced
from the previous call to registerVariables
.
vars
is produced from the
jVariableVector
by creating a single duplicate
variable for each variable. Since this is created in the same
order as the registerVariables
, it is now
efficient for jVariables
to return their
unique duplicate.
jTerm
which is an instantiated duplicate of this
term.public jTerm copy(jVariableRegistry vars)
jTerm
duplicate
function. Should only be invoked by copy()
or other copy(vars)
. Should only invoke other
copy(vars)
functions.
Bound variables should return a copy of the bound term.
copy
in interface iTerm
copy
in class jTerm
vars
- The registry of variables and their duplicates. Initially this
is empty. As variables generate copies, they add themselves
and their copy to the jVariableRegistry
, and this
is output from the function call. Any further calls with the
same vars
ensures that the same variable
(in a different term) returns the same copy.
jTerm
which is an instantiated copy of this
term.public java.lang.String toString(boolean usename)
jTerm
false
is the default for displaying the term,
true
for displaying this term in a user query.
toString
in interface iTerm
toString
in class jTerm
String
which is a textual representation of this
term.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |