Uses of Interface
org.projog.core.predicate.PredicateFactory

Packages that use PredicateFactory

Package	Description
org.projog.api	Provides a programming interface for Java applications to interact with Projog.
org.projog.core.predicate
org.projog.core.predicate.builtin.bool	Predicates to explicitly specify when a goal succeeds of fails.
org.projog.core.predicate.builtin.classify	Predicates for classifying terms.
org.projog.core.predicate.builtin.clp	Predicates to support constraint logic programming.
org.projog.core.predicate.builtin.compare	Predicates for comparing terms, including specific predicates for comparing numeric values.
org.projog.core.predicate.builtin.compound	Predicates for the construction of compound/complex sentences.
org.projog.core.predicate.builtin.construct	Predicates for inspecting the structure of terms.
org.projog.core.predicate.builtin.db	Predicates to support working with the recorded database.
org.projog.core.predicate.builtin.debug	Predicates to aid the debugging of Prolog programs.
org.projog.core.predicate.builtin.flow	Predicates for affecting the flow of goal evaluation on backtracking.
org.projog.core.predicate.builtin.io	Predicates for system input and output with the file system.
org.projog.core.predicate.builtin.kb	Predicates for inspecting, adding and retracting clauses.
org.projog.core.predicate.builtin.list	Predicates for working with list data structures.
org.projog.core.predicate.builtin.reif	Predicates that provide reification functionality.
org.projog.core.predicate.builtin.time	Predicates to support working with dates and times.
org.projog.core.predicate.udp	Provides functionality to evaluate user defined predicates defined using Prolog syntax.

Uses of PredicateFactory in org.projog.api

Methods in org.projog.api with parameters of type PredicateFactory

Modifier and Type	Method and Description
void	Projog.addPredicateFactory(PredicateKey key, PredicateFactory predicateFactory) Associates a PredicateFactory with the KnowledgeBase of this Projog.

Uses of PredicateFactory in org.projog.core.predicate

Subinterfaces of PredicateFactory in org.projog.core.predicate

Modifier and Type	Interface and Description
interface	PreprocessablePredicateFactory

Classes in org.projog.core.predicate that implement PredicateFactory

Modifier and Type	Class and Description
class	AbstractPredicateFactory
class	AbstractSingleResultPredicate Superclass of "plug-in" predicates that are not re-evaluated as part of backtracking.
class	UnknownPredicate Represents all predicates that a KnowledgeBase has no definition of.

Methods in org.projog.core.predicate that return PredicateFactory

Modifier and Type	Method and Description
PredicateFactory	Predicates.getPredicateFactory(PredicateKey key) Returns the PredicateFactory associated with the specified PredicateKey.
PredicateFactory	Predicates.getPredicateFactory(Term term) Returns the PredicateFactory associated with the specified Term.
PredicateFactory	Predicates.getPreprocessedPredicateFactory(Term term)
PredicateFactory	UnknownPredicate.preprocess(Term arg)
PredicateFactory	PreprocessablePredicateFactory.preprocess(Term arg)

Methods in org.projog.core.predicate with parameters of type PredicateFactory

Modifier and Type	Method and Description
void	Predicates.addPredicateFactory(PredicateKey key, PredicateFactory predicateFactory) Associates a PredicateFactory with this KnowledgeBase.

Uses of PredicateFactory in org.projog.core.predicate.builtin.bool

Classes in org.projog.core.predicate.builtin.bool that implement PredicateFactory

Modifier and Type	Class and Description
class	Fail fail - always fails.
class	True true - always succeeds.

Uses of PredicateFactory in org.projog.core.predicate.builtin.classify

Classes in org.projog.core.predicate.builtin.classify that implement PredicateFactory

Modifier and Type	Class and Description
class	CharType char_type(X,Y) - classifies characters.
class	IsAtom atom(X) - checks that a term is an atom.
class	IsAtomic atomic(X) - checks that a term is atomic.
class	IsCompound compound(X) - checks that a term is a compound term.
class	IsFloat float(X) - checks that a term is a floating point number.
class	IsInteger integer(X) - checks that a term is an integer.
class	IsList is_list(X) - checks that a term is a list.
class	IsNonVar nonvar(X) - checks that a term is not an uninstantiated variable.
class	IsNumber number(X) - checks that a term is numeric.
class	IsVar var(X) - checks that a term is an uninstantiated variable.

Uses of PredicateFactory in org.projog.core.predicate.builtin.clp

Classes in org.projog.core.predicate.builtin.clp that implement PredicateFactory

Modifier and Type	Class and Description
class	AddExpressionFactory pj_add_clp_expression(X,Y) - defines a Java class as an CLP expression.
class	BooleanConstraintPredicate CLP predicates for comparing boolean values.
class	Distinct all_different([X,Y,Z]) - enforce that none of the given CLP variables share the same value.
class	In X in 1..4 / [X,Y,Z] ins 1..4 - restrict CLP variables to a range of values.
class	NumericConstraintPredicate CLP predicates for comparing numeric values.
class	Resolve label([X]) - assigns concrete values to the given CLP variables.

Uses of PredicateFactory in org.projog.core.predicate.builtin.compare

Classes in org.projog.core.predicate.builtin.compare that implement PredicateFactory

Modifier and Type	Class and Description
class	Between between(X,Y,Z) - checks if a number is within a specified range.
class	Compare compare(X,Y,Z) - compares arguments.
class	Equal X=Y - an equality test.
class	Is X is Y - evaluate arithmetic expression.
class	NotStrictEquality X\==Y - a strict equality test.
class	NotUnifiable X \= Y - checks whether two terms cannot be unified.
class	NumericEquality X=:=Y - numeric equality test.
class	NumericGreaterThan X>Y - numeric "greater than" test.
class	NumericGreaterThanOrEqual X>=Y - numeric "greater than or equal" test.
class	NumericInequality X=\=Y - numeric inequality test.
class	NumericLessThan X<Y - numeric "less than" test.
class	NumericLessThanOrEqual X=<Y - numeric "less than or equal" test.
class	PredSort predsort(X,Y,Z) - sorts a list using the specified predicate.
class	StrictEquality X==Y - a strict equality test.
class	TermGreaterThan X@>Y - term "greater than" test.
class	TermGreaterThanOrEqual X@>=Y - term "greater than or equal" test.
class	TermLessThan X@<Y - term "less than" test.
class	TermLessThanOrEqual X@=<Y - term "less than or equal" test.
class	UnifyWithOccursCheck unify_with_occurs_check(X, Y) - an equality test using sound unification.

Methods in org.projog.core.predicate.builtin.compare that return PredicateFactory

Modifier and Type	Method and Description
PredicateFactory	PredSort.preprocess(Term term)
PredicateFactory	Is.preprocess(Term arg)

Uses of PredicateFactory in org.projog.core.predicate.builtin.compound

Classes in org.projog.core.predicate.builtin.compound that implement PredicateFactory

Modifier and Type	Class and Description
class	BagOf bagof(X,P,L) - find all solutions that satisfy the goal.
class	Call call(X) - calls the goal represented by a term.
class	Conjunction X,Y - conjunction.
class	Disjunction X;Y - disjunction.
class	FindAll findall(X,P,L) - find all solutions that satisfy the goal.
class	IfThen X->Y - if X succeeds then Y is evaluated.
class	Limit limit(N, X) - calls the goal represented by a term a maximum number of times.
class	Not \+ X - "not".
class	Once once(X) - calls the goal represented by a term.
class	SetOf setof(X,P,L) - find all solutions that satisfy the goal.

Methods in org.projog.core.predicate.builtin.compound that return PredicateFactory

Modifier and Type	Method and Description
PredicateFactory	SetOf.preprocess(Term term)
PredicateFactory	Once.preprocess(Term term)
PredicateFactory	Not.preprocess(Term term)
PredicateFactory	Limit.preprocess(Term term)
PredicateFactory	IfThen.preprocess(Term term)
PredicateFactory	FindAll.preprocess(Term term)
PredicateFactory	Disjunction.preprocess(Term term)
PredicateFactory	Conjunction.preprocess(Term term)
PredicateFactory	BagOf.preprocess(Term term)

Uses of PredicateFactory in org.projog.core.predicate.builtin.construct

Classes in org.projog.core.predicate.builtin.construct that implement PredicateFactory

Modifier and Type	Class and Description
class	Arg arg(N,T,A) - allows access to an argument of a structure.
class	AtomConcat atom_concat(X, Y, Z) - concatenates atom names.
class	CopyTerm copy_term(X,Y) - makes a copy of a term.
class	Functor functor(T,F,N)
class	NumberVars numbervars(Term,Start,End) - unifies free variables of a term.
class	TermSplit atom_chars / atom_codes / number_chars / number_codes
class	Univ X=..L - "univ".

Uses of PredicateFactory in org.projog.core.predicate.builtin.db

Classes in org.projog.core.predicate.builtin.db that implement PredicateFactory

Modifier and Type	Class and Description
class	Erase erase(X) - removes a record from the recorded database.
class	InsertRecord recorda(X,Y,Z) / recordz(X,Y,Z) - associates a term with a key.
class	Recorded recorded(X,Y,Z) - checks if a term is associated with a key.

Uses of PredicateFactory in org.projog.core.predicate.builtin.debug

Classes in org.projog.core.predicate.builtin.debug that implement PredicateFactory

Modifier and Type	Class and Description
class	AlterSpyPoint spy(X) / nospy(X) - add or remove a spy point for a predicate.
class	Debugging debugging - lists current spy points.
class	NoDebug nodebug - removes all current spy points.
class	NoTrace notrace - disables exhaustive tracing.
class	Trace trace - enables exhaustive tracing.

Uses of PredicateFactory in org.projog.core.predicate.builtin.flow

Classes in org.projog.core.predicate.builtin.flow that implement PredicateFactory

Modifier and Type	Class and Description
class	Cut ! - the "cut".
class	RepeatInfinitely repeat - always succeeds.
class	RepeatSetAmount repeat(N) - succeeds N times.
class	Throw throw(X) - throws an exception with the given message.

Uses of PredicateFactory in org.projog.core.predicate.builtin.io

Classes in org.projog.core.predicate.builtin.io that implement PredicateFactory

Modifier and Type	Class and Description
class	Close close(X) - closes a stream.
class	CurrentInput current_input(X) - match a term to the current input stream.
class	CurrentOutput current_output(X) - match a term to the current output stream.
class	GetChar get_char(X) - reads the next character from the input stream.
class	GetCode get_code(X) - reads the next character from the input stream.
class	NewLine nl - outputs a new line character.
class	Op op(X,Y,Z)
class	Open open(X,Y,Z) - opens a file.
class	PutChar put_char(X) - writes a character.
class	Read read(X) - reads a term from the input stream.
class	See see(X) - opens a file and sets it as the current input stream.
class	Seen seen - closes the current input stream.
class	SetInput set_input(X) - sets the current input.
class	SetOutput set_output(X) - sets the current output.
class	Tab tab(X) - writes X number of spaces to the output stream.
class	Tell tell(X) - opens a file and sets it as the current output stream.
class	Told told - closes the current output stream.
class	Write write(X) - writes a term to the output stream.
class	WriteCanonical write_canonical(X) - writes a term to the output stream.
class	Writef writef(X,Y) - writes formatted text to the output stream.

Uses of PredicateFactory in org.projog.core.predicate.builtin.kb

Classes in org.projog.core.predicate.builtin.kb that implement PredicateFactory

Modifier and Type	Class and Description
class	AddArithmeticOperator pj_add_arithmetic_operator(X,Y) - defines a Java class as an arithmetic operator.
class	AddPredicateFactory pj_add_predicate(X,Y) - defines a Java class as a built-in predicate.
class	AddUserDefinedArithmeticOperator arithmetic_function(X) - defines a predicate as an arithmetic function.
class	Assert asserta(X) / assertz(X) - adds a clause to the knowledge base.
class	Consult consult(X) - reads clauses and goals from a file.
class	ConsultList Read clauses and goals from a list of files.
class	CurrentPredicate current_predicate(X) - unifies with defined predicates.
class	Dynamic dynamic/1 - indicates that a user defined predicate is dynamic.
class	EnsureLoaded ensure_loaded(X) - reads clauses and goals from a file.
class	Flag flag(X,Y,Z) - associates a key with a value.
class	Inspect clause(X,Y) / retract(X) - matches terms to existing clauses.
class	Listing listing(X) - outputs current clauses.
class	RetractAll retractall(X) - remove clauses from the knowledge base.

Uses of PredicateFactory in org.projog.core.predicate.builtin.list

Classes in org.projog.core.predicate.builtin.list that implement PredicateFactory

Modifier and Type	Class and Description
class	Append append(X,Y,Z) - concatenates two lists.
class	AppendListOfLists append(ListOfLists, List) - concatenates a list of lists.
class	AtomicListConcat atomic_list_concat(List,Separator,Atom) / atomic_list_concat(List,Atom)
class	Delete delete(X,Y,Z) - remove all occurrences of a term from a list.
class	ExtremumList min_list / max_list
class	Flatten flatten(X,Y) - flattens a nested list.
class	Fold foldl(PredicateName, Values, Start, Result) - combines elements of a list into a single term.
class	KeySort keysort(X,Y) - sorts a list of key/value pairs.
class	Last last(X,Y) - finds the last element of a list.
class	Length length(X,Y) - determines the length of a list.
class	MapList maplist(X,Y) / maplist(X,Y,Z) - determines if a goal succeeds against elements of a list.
class	Member member(E, L) - enumerates members of a list.
class	MemberCheck memberchk(E, L) - checks is a term is a member of a list.
class	Nth nth0(X,Y,Z) / nth1(X,Y,Z) - examines an element of a list.
class	PairsElements pairs_keys(Pairs,Keys) / pairs_values(Pairs,Values) - get keys or values from list of Key-Value pairs.
class	Reverse reverse(X,Y) - reverses the order of elements in a list.
class	Select select(X,Y,Z) - removes an element from a list.
class	Sort msort(X,Y) - sorts a list.
class	SortAsSet sort(X,Y) - sorts a list and removes duplicates.
class	SubList include(X,Y,Z) - filters a list by a goal.
class	Subset subset(X,Y) - checks if a set is a subset.
class	SubtractFromList subtract(X,Y,Z) - removes elements from a list.

Methods in org.projog.core.predicate.builtin.list that return PredicateFactory

Modifier and Type	Method and Description
static PredicateFactory	PartialApplicationUtils.getCurriedPredicateFactory(Predicates predicates, Term partiallyAppliedFunction)
static PredicateFactory	PartialApplicationUtils.getPartiallyAppliedPredicateFactory(Predicates predicates, Term partiallyAppliedFunction, int numberOfExtraArguments)
static PredicateFactory	PartialApplicationUtils.getPreprocessedCurriedPredicateFactory(Predicates predicates, Term partiallyAppliedFunction)
static PredicateFactory	PartialApplicationUtils.getPreprocessedPartiallyAppliedPredicateFactory(Predicates predicates, Term partiallyAppliedFunction, int extraArgs)
PredicateFactory	SubList.preprocess(Term term)
PredicateFactory	MemberCheck.preprocess(Term term)
PredicateFactory	MapList.preprocess(Term input)
PredicateFactory	Fold.preprocess(Term arg)

Methods in org.projog.core.predicate.builtin.list with parameters of type PredicateFactory

Modifier and Type	Method and Description
static boolean	PartialApplicationUtils.apply(PredicateFactory pf, Term[] args)
static Predicate	PartialApplicationUtils.getPredicate(PredicateFactory pf, Term action, Term... args)

Uses of PredicateFactory in org.projog.core.predicate.builtin.reif

Classes in org.projog.core.predicate.builtin.reif that implement PredicateFactory

Modifier and Type	Class and Description
class	Dif dif(X,Y) - enforces restriction that the two given terms are never equal.

Uses of PredicateFactory in org.projog.core.predicate.builtin.time

Classes in org.projog.core.predicate.builtin.time that implement PredicateFactory

Modifier and Type	Class and Description
class	ConvertTime convert_time(X,Y) - converts a timestamp to a textual representation.
class	GetTime get_time(X) - gets the current system time.

Uses of PredicateFactory in org.projog.core.predicate.udp

Subinterfaces of PredicateFactory in org.projog.core.predicate.udp

Modifier and Type	Interface and Description
interface	UserDefinedPredicateFactory Maintains a record of the clauses that define a user defined predicate.

Classes in org.projog.core.predicate.udp that implement PredicateFactory

Modifier and Type	Class and Description
class	DynamicUserDefinedPredicateFactory Maintains a record of the clauses that represents a "dynamic" user defined predicate.
class	InterpretedTailRecursivePredicateFactory Creates "tail recursion optimised" versions of user defined predicates.
class	StaticUserDefinedPredicateFactory Maintains a record of the clauses that represents a "static" user defined predicate.

Methods in org.projog.core.predicate.udp that return PredicateFactory

Modifier and Type	Method and Description
PredicateFactory	StaticUserDefinedPredicateFactory.getActualPredicateFactory()
PredicateFactory	StaticUserDefinedPredicateFactory.preprocess(Term arg)