Package org.projog.core.math

Class AbstractArithmeticOperator

java.lang.Object

org.projog.core.math.AbstractArithmeticOperator

All Implemented Interfaces:

KnowledgeBaseConsumer, ArithmeticOperator, PreprocessableArithmeticOperator

Direct Known Subclasses:

AbstractBinaryArithmeticOperator, AbstractBinaryIntegerArithmeticOperator, AbstractUnaryArithmeticOperator, Divide, Max, Min, Random, Round

public abstract class AbstractArithmeticOperator
extends java.lang.Object
implements PreprocessableArithmeticOperator, KnowledgeBaseConsumer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	AbstractArithmeticOperator.PreprocessedBinaryOperator
private class	AbstractArithmeticOperator.PreprocessedUnaryOperator

Field Summary

Fields

Modifier and Type	Field	Description
private ArithmeticOperators	operators

Constructor Summary

Constructors

Constructor	Description
AbstractArithmeticOperator()

Method Summary

Modifier and Type	Method	Description
protected Numeric	calculate(Numeric n)
protected Numeric	calculate(Numeric n1, Numeric n2)
Numeric	calculate(Term[] args)	Returns the result of the calculation using the specified arguments.
private java.lang.IllegalArgumentException	createWrongNumberOfArgumentsException(int numberOfArguments)
protected boolean	isPure()	Indicates if this operator is pure and so can be preprocessed.
ArithmeticOperator	preprocess(Term expression)
private ArithmeticOperator	preprocessBinaryOperator(Term argument1, Term argument2)
private ArithmeticOperator	preprocessUnaryOperator(Term argument)
void	setKnowledgeBase(KnowledgeBase kb)	Provides a reference to a KnowledgeBase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

operators

private ArithmeticOperators operators

Constructor Detail

AbstractArithmeticOperator

public AbstractArithmeticOperator()

Method Detail

setKnowledgeBase

public final void setKnowledgeBase(KnowledgeBase kb)

Provides a reference to a KnowledgeBase.

Meaning this object will always have access to a KnowledgeBase by the time its calculate method is invoked.

Specified by:

setKnowledgeBase in interface KnowledgeBaseConsumer

calculate

public final Numeric calculate(Term[] args)

Description copied from interface: ArithmeticOperator

Returns the result of the calculation using the specified arguments.

Specified by:

calculate in interface ArithmeticOperator

Parameters:

args - the arguments to use in the calculation

Returns:

the result of the calculation using the specified arguments

calculate

protected Numeric calculate(Numeric n)

calculate

protected Numeric calculate(Numeric n1,
                            Numeric n2)

createWrongNumberOfArgumentsException

private java.lang.IllegalArgumentException createWrongNumberOfArgumentsException(int numberOfArguments)

preprocess

public final ArithmeticOperator preprocess(Term expression)

Specified by:

preprocess in interface PreprocessableArithmeticOperator

isPure

protected boolean isPure()

Indicates if this operator is pure and so can be preprocessed.

An operator is pure if multiple calls with identical arguments always produce the same result.

Returns:

true if pure and so can be preprocessed, else false

preprocessUnaryOperator

private ArithmeticOperator preprocessUnaryOperator(Term argument)

preprocessBinaryOperator

private ArithmeticOperator preprocessBinaryOperator(Term argument1,
                                                    Term argument2)