com.graphbuilder.math

Class FuncMap

java.lang.Object

com.graphbuilder.math.FuncMap

public class FuncMap
extends Object

FuncMap maps a name to a function. A FuncMap is used in the eval method of an Expression object. This class can be used as the default function-map. The loadDefaultFunctions() method can be used to take advantage of the many already implemented functions (see below).

During the evaluation of an expression, if a function is not supported then a RuntimeException is thrown.

Default functions:

No Parameters

• e() → Math.E
• pi() → Math.PI
• rand() → Math.random()
• min() → Double.MIN_VALUE
• max() → Double.MAX_VALUE

1 Parameter

• sin(x) → Math.sin(double)
• cos(x) → Math.cos(double)
• tan(x) → Math.tan(double)
• asin(x) → Math.asin(double)
• acos(x) → Math.acos(double)
• atan(x) → Math.atan(double)
• asinh(x) → 2 * ln(sqrt((x+1)/2) + sqrt((x-1)/2))
• acosh(x) → ln(x + sqrt(1 + x²))
• atanh(x) → (ln(1+x) - ln(1-x)) / 2
• sinh(x) → (e^x - e^-x)/2
• cosh(x) → (e^x + e^-x)/2
• tanh(x) → (e^x - e^-x)/(e^x + e^-x)
• sqrt(x) → Math.sqrt(double)
• abs(x) → Math.abs(double)
• ceil(x) → Math.ceil(double)
• floor(x) → Math.floor(double)
• exp(x) → e^x
• ln(x) → log_ex
• lg(x) → log₂x
• log(x) → log₁₀x
• sign(x) → x > 0 = 1, x < 0 = -1, else 0
• fact(n) → n! = 1 * 2 * ... * (n - 1) * n
• round(x) → Math.round(double)

2 Parameters

• log(x,y) → log_yx
• combin(n, r) → PascalsTriangle.nCr(n, r)
• mod(x, y) → x % y
• pow(x, y) → x^y

n Parameters

• min(x1,x2,...,xn)
• max(x1,x2,...,xn)
• sum(x1,x2,...,xn) → x1 + x2 + ... + xn
• avg(x1,x2,...,xn) → (x1 + x2 + ... + xn) / n

Note: Case sensitivity can only be specified in the constructor (for consistency). When case sensitivity is false, the String.equalsIgnoreCase method is used. When case sensitivity is true, the String.equals method is used. The matching does not include the parenthesis. For example, when case sensitivity is false and the default functions have been loaded, then "RaNd", "rand", and "RAND" all map to the RandFunction(). By default, case sensitivity is false.

Constructor Summary

Constructors

Constructor and Description
FuncMap()
FuncMap(boolean caseSensitive)

Method Summary

Modifier and Type	Method and Description
Function	getFunction(String funcName, int numParam) Returns a function based on the name and the specified number of parameters.
String[]	getFunctionNames() Returns an array of exact length of the function names stored in this map.
Function[]	getFunctions() Returns an array of exact length of the functions stored in this map.
boolean	isCaseSensitive() Returns true if the case of the function names is considered.
void	loadDefaultFunctions() Adds the mappings for many common functions.
void	remove(String funcName) Removes the function-name and the associated function from the map.
void	setFunction(String funcName, Function f) Assigns the name to map to the specified function.

Methods inherited from class java.lang.Object

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

Constructor Detail

FuncMap

public FuncMap()

FuncMap

public FuncMap(boolean caseSensitive)

Method Detail

loadDefaultFunctions

public void loadDefaultFunctions()

Adds the mappings for many common functions. The names are specified in all lowercase letters.

getFunction

public Function getFunction(String funcName,
                            int numParam)

Returns a function based on the name and the specified number of parameters.

Throws:

RuntimeException - If no supporting function can be found.

setFunction

public void setFunction(String funcName,
                        Function f)

Assigns the name to map to the specified function.

Throws:

IllegalArgumentException - If any of the parameters are null.

isCaseSensitive

public boolean isCaseSensitive()

Returns true if the case of the function names is considered.

getFunctionNames

public String[] getFunctionNames()

Returns an array of exact length of the function names stored in this map.

getFunctions

public Function[] getFunctions()

Returns an array of exact length of the functions stored in this map. The returned array corresponds to the order of the names returned by getFunctionNames.

remove

public void remove(String funcName)

Removes the function-name and the associated function from the map. Does nothing if the function-name is not found.