org.ai_heuristic.functs

Class MathStat

java.lang.Object

org.ai_heuristic.functs.MathStat

public class MathStat
extends java.lang.Object

This class implements some basic mathematical and statistical functions. For them to be sensible probably requires using only the basic number types.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
MathStat()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	abs(java.lang.String valueType, java.lang.Object value) Get the absolute value of the value passed in.
static java.lang.Object	cos(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value, int numTerms) Use the Taylor series to approximate the Cosine angle of x.
static java.lang.Object	exp(int power) Calculate the value of e raised to the power of power.
static java.lang.Double	logBaseTwo(java.lang.Double logValue, EvaluateMathDef eval) Calculate the 'log to the base 2' value.
static java.lang.Object	mean(java.lang.String valueType, EvaluateMathDef eval, java.util.ArrayList<?> valueList) Calculate the sum average value of the list of elements.
static java.lang.Object	median(java.lang.String valueType, EvaluateMathDef eval, java.util.ArrayList<?> valueList) Calculate the middle value of the list of elements.
static java.lang.Object	numEquiv(java.lang.String valueType, double numerical) Get the equivalent of the double numerical value for the data type.
static java.lang.Object	numEquiv(java.lang.String valueType, long numerical) Get the equivalent of the long numerical value for the data type.
static java.lang.Object	pow(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value, int power) Calculate the value raised to the power of power.
static java.lang.Object	powFrac(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value, double fraction) Calculate the power of the value to a fraction.
static java.lang.Object	rtNum(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value, int rootNumber) Calculate the root of the value for a number larger than 2.
static java.lang.Object	sd(java.lang.String valueType, EvaluateMathDef eval, java.util.ArrayList<?> valueList) Calculate the standard deviation value of the list of elements.
static java.lang.Object	sin(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value, int numTerms) Use the Taylor series to approximate the Sine angle of x.
static java.lang.Object	sqr(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value) Calculate the square of the value.
static java.lang.Object	sqrt(java.lang.String valueType, EvaluateMathDef eval, java.lang.Object value) Calculate the square root of the value.
static java.lang.Object	sum(java.lang.String valueType, EvaluateMathDef eval, java.util.ArrayList<?> valueList) Calculate the sum total value of the list of elements.
static java.lang.Object	var(java.lang.String valueType, EvaluateMathDef eval, java.util.ArrayList<?> valueList) Calculate the variance value of the list of elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

MathStat

public MathStat()

Method Detail

abs

public static java.lang.Object abs(java.lang.String valueType,
                                   java.lang.Object value)
                            throws java.lang.Exception

Get the absolute value of the value passed in.

Parameters:

valueType - the type of the value.

value - the value.

Returns:

the absolute (positive) value.

Throws:

java.lang.Exception - any error.

sqr

public static java.lang.Object sqr(java.lang.String valueType,
                                   EvaluateMathDef eval,
                                   java.lang.Object value)
                            throws java.lang.Exception

Calculate the square of the value.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the array of values.

Returns:

the statistical square value.

Throws:

java.lang.Exception - any error.

pow

public static java.lang.Object pow(java.lang.String valueType,
                                   EvaluateMathDef eval,
                                   java.lang.Object value,
                                   int power)
                            throws java.lang.Exception

Calculate the value raised to the power of power.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the value to raise to the power.

power - the power to raise the value to. Must be a positive integer.

Returns:

the statistical to power of value.

Throws:

java.lang.Exception - any error.

powFrac

public static java.lang.Object powFrac(java.lang.String valueType,
                                       EvaluateMathDef eval,
                                       java.lang.Object value,
                                       double fraction)
                                throws java.lang.Exception

Calculate the power of the value to a fraction. This is iterative and so might be costly for large numbers. The equation is Newton's method, modified from http://introcs.cs.princeton.edu/java/21function/Newton.java.html This calls rtNum with a root value of (1.0 / denominator).

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the array of values.

fraction - the number fraction specified as 1.0 / denominator, so the fraction of a half or (1/2) is entered as the value 0.5, for example. This should be convertible back into a whole integer number again, as that is what gets passed to rtNum to calculate the fraction power value.

Returns:

the statistical value^fraction.

Throws:

java.lang.Exception - any error.

exp

public static java.lang.Object exp(int power)

Calculate the value of e raised to the power of power. This is a rough approximation method that does work more quickly than Math.exp, but not nearly as accurate. Copied from http://www.javamex.com/tutorials/math/exp.shtml.

Parameters:

power - the power to raise the value e to. Must be a positive integer.

Returns:

the statistical to power of value. This is a Double value only.

sqrt

public static java.lang.Object sqrt(java.lang.String valueType,
                                    EvaluateMathDef eval,
                                    java.lang.Object value)
                             throws java.lang.Exception

Calculate the square root of the value. This is iterative and so might be costly for large numbers. The equation is Newton's method, modified from http://introcs.cs.princeton.edu/java/21function/Newton.java.html

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the array of values.

Returns:

the statistical square root value.

Throws:

java.lang.Exception - any error.

rtNum

public static java.lang.Object rtNum(java.lang.String valueType,
                                     EvaluateMathDef eval,
                                     java.lang.Object value,
                                     int rootNumber)
                              throws java.lang.Exception

Calculate the root of the value for a number larger than 2. This is iterative and so might be costly for large numbers. The equation is Newton's method, modified from http://introcs.cs.princeton.edu/java/21function/Newton.java.html to iterate over multiple root values, not just the square root.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the array of values.

rootNumber - the root to find the source to. 3 indicates a cube root, and so on.

Returns:

the statistical root value.

Throws:

java.lang.Exception - any error.

logBaseTwo

public static java.lang.Double logBaseTwo(java.lang.Double logValue,
                                          EvaluateMathDef eval)
                                   throws java.lang.Exception

Calculate the 'log to the base 2' value.

Parameters:

logValue - the value as a java object.

eval - the evaluation function.

Returns:

the 'log to the base 2' value of logValue.

Throws:

java.lang.Exception - any error.

sum

public static java.lang.Object sum(java.lang.String valueType,
                                   EvaluateMathDef eval,
                                   java.util.ArrayList<?> valueList)
                            throws java.lang.Exception

Calculate the sum total value of the list of elements. This is not reliable over any data type.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

valueList - the array of values.

Returns:

the statistical sqr value.

Throws:

java.lang.Exception - any error.

mean

public static java.lang.Object mean(java.lang.String valueType,
                                    EvaluateMathDef eval,
                                    java.util.ArrayList<?> valueList)
                             throws java.lang.Exception

Calculate the sum average value of the list of elements. This is not reliable over any data type.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

valueList - the array of values.

Returns:

the statistical mean value.

Throws:

java.lang.Exception - any error.

median

public static java.lang.Object median(java.lang.String valueType,
                                      EvaluateMathDef eval,
                                      java.util.ArrayList<?> valueList)
                               throws java.lang.Exception

Calculate the middle value of the list of elements. This is the middle value in the list as it is ordered and is not reliable over every data type.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

valueList - the array of values.

Returns:

the statistical median value.

Throws:

java.lang.Exception - any error.

var

public static java.lang.Object var(java.lang.String valueType,
                                   EvaluateMathDef eval,
                                   java.util.ArrayList<?> valueList)
                            throws java.lang.Exception

Calculate the variance value of the list of elements. This is the difference from the average or mean value and is not reliable over all data types.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

valueList - the array of values.

Returns:

the statistical median value.

Throws:

java.lang.Exception - any error.

sd

public static java.lang.Object sd(java.lang.String valueType,
                                  EvaluateMathDef eval,
                                  java.util.ArrayList<?> valueList)
                           throws java.lang.Exception

Calculate the standard deviation value of the list of elements. This is the deviation from the average or mean value and is not reliable over all data types.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

valueList - the array of values.

Returns:

the statistical median value.

Throws:

java.lang.Exception - any error.

numEquiv

public static java.lang.Object numEquiv(java.lang.String valueType,
                                        long numerical)
                                 throws java.lang.Exception

Get the equivalent of the long numerical value for the data type.

Parameters:

valueType - the type of the value.

numerical - an integer numerical value.

Returns:

the equivalent of the numerical value for the data type.

Throws:

java.lang.Exception - any error.

numEquiv

public static java.lang.Object numEquiv(java.lang.String valueType,
                                        double numerical)
                                 throws java.lang.Exception

Get the equivalent of the double numerical value for the data type.

Parameters:

valueType - the type of the value.

numerical - an integer numerical value.

Returns:

the equivalent of the numerical value for the data type.

Throws:

java.lang.Exception - any error.

sin

public static java.lang.Object sin(java.lang.String valueType,
                                   EvaluateMathDef eval,
                                   java.lang.Object value,
                                   int numTerms)
                            throws java.lang.Exception

Use the Taylor series to approximate the Sine angle of x. This can be used as an alternative to Math.sin.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the value to convert.

numTerms - the number of Taylor terms to evaluate.

Returns:

the Sine angle value.

Throws:

java.lang.Exception - any error.

cos

public static java.lang.Object cos(java.lang.String valueType,
                                   EvaluateMathDef eval,
                                   java.lang.Object value,
                                   int numTerms)
                            throws java.lang.Exception

Use the Taylor series to approximate the Cosine angle of x. This can be used as an alternative to Math.sin.

Parameters:

valueType - the object type being evaluated.

eval - the evaluation function.

value - the value to convert.

numTerms - the number of Taylor terms to evaluate.

Returns:

the Cosine angle value.

Throws:

java.lang.Exception - any error.