org.ai_heuristic.eval

Class MathBOW

java.lang.Object

org.ai_heuristic.eval.MathBOW

All Implemented Interfaces:

EvaluateMathDef

public class MathBOW
extends java.lang.Object
implements EvaluateMathDef

Provides one implementation of a Bag-Of-Words evaluation function that includes mathematical operations. This class can be used to compare one Bag-Of-Words value with another one and return a result. Because the mathematical comparisons are not well-defined, this is just one set of possibilities and those operations might be highly dubious.

If the value Object is a MetricValue, then this is checked for and the value stored in it used instead.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
MathBOW() Create a new instance of MathBOW.

Method Summary

Modifier and Type	Method and Description
protected BagOfWords	add(BagOfWords value1, BagOfWords value2) Add the two bag-of-words together.
java.lang.Object	add(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Add the two objects together and return.
java.lang.Object	divide(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Divide the first value by the second and return the result.
<T> boolean	mathCompare(java.lang.String valueType, T value1, T value2, java.lang.String operator) Not defined for a BagOfWords.
java.lang.Object	mathOperation(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2, java.lang.String operator) Evaluate the mathematical expression value1 operator value2.
java.lang.Object	multiply(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Multiply the first value by the second and return the result.
protected BagOfWords	subtract(BagOfWords value1, BagOfWords value2) Subtract the second value from the first and return the result.
java.lang.Object	subtract(java.lang.String valueType, java.lang.Object value1, java.lang.Object value2) Subtract the second value from the first and return the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

MathBOW

public MathBOW()
        throws java.lang.Exception

Create a new instance of MathBOW.

Throws:

java.lang.Exception - any error.

Method Detail

mathCompare

public <T> boolean mathCompare(java.lang.String valueType,
                               T value1,
                               T value2,
                               java.lang.String operator)
                        throws java.lang.Exception

Not defined for a BagOfWords.

Specified by:

mathCompare in interface EvaluateMathDef

Type Parameters:

T - object type.

Parameters:

valueType - the type of the value. This is the object type classname.

value1 - first value.

value2 - second value.

operator - comparison operator, which evaluates 'value1 operator value2'. Operator can be greater than (GT), less than (LT), etc. These are all defined in the AiHeuristicConst class.

Returns:

true if compare operation is true, false otherwise.

Throws:

java.lang.Exception - any error.

mathOperation

public java.lang.Object mathOperation(java.lang.String valueType,
                                      java.lang.Object value1,
                                      java.lang.Object value2,
                                      java.lang.String operator)
                               throws java.lang.Exception

Evaluate the mathematical expression value1 operator value2.

Specified by:

mathOperation in interface EvaluateMathDef

Parameters:

valueType - the type of the value, assumed to be BagOfWords.

value1 - first value.

value2 - second value.

operator - mathematical operator - can be add, subtract, multiply, divide. These are all defined in the AiHeuristicConst class.

Returns:

true if comparison is true and false otherwise.

Throws:

java.lang.Exception - any error.

add

public java.lang.Object add(java.lang.String valueType,
                            java.lang.Object value1,
                            java.lang.Object value2)
                     throws java.lang.Exception

Add the two objects together and return.

Specified by:

add in interface EvaluateMathDef

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the two values added together.

Throws:

java.lang.Exception - any error.

add

protected BagOfWords add(BagOfWords value1,
                         BagOfWords value2)
                  throws java.lang.Exception

Add the two bag-of-words together.

Parameters:

value1 - first value.

value2 - second value.

Returns:

the values added together.

Throws:

java.lang.Exception - any error.

subtract

public java.lang.Object subtract(java.lang.String valueType,
                                 java.lang.Object value1,
                                 java.lang.Object value2)
                          throws java.lang.Exception

Subtract the second value from the first and return the result.

Specified by:

subtract in interface EvaluateMathDef

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the second value subtracted from the first.

Throws:

java.lang.Exception - any error.

subtract

protected BagOfWords subtract(BagOfWords value1,
                              BagOfWords value2)
                       throws java.lang.Exception

Subtract the second value from the first and return the result.

Parameters:

value1 - first value.

value2 - second value.

Returns:

the values added together.

Throws:

java.lang.Exception - any error.

multiply

public java.lang.Object multiply(java.lang.String valueType,
                                 java.lang.Object value1,
                                 java.lang.Object value2)

Multiply the first value by the second and return the result. This operation is not defined for a BagOfWords.

Specified by:

multiply in interface EvaluateMathDef

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the first value multiplied by the second.

divide

public java.lang.Object divide(java.lang.String valueType,
                               java.lang.Object value1,
                               java.lang.Object value2)

Divide the first value by the second and return the result. This operation is not defined for a BagOfWords.

Specified by:

divide in interface EvaluateMathDef

Parameters:

valueType - the type of the value.

value1 - first value.

value2 - second value.

Returns:

the first value divided by the second.