net.objecthunter.exp4j.function

Class Function

java.lang.Object

net.objecthunter.exp4j.function.Function

public abstract class Function
extends Object

A class representing a Function which can be used in an expression

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected int	numArguments

Constructor Summary

Constructors

Constructor and Description
Function(String name) Create a new Function with a given name that takes a single argument
Function(String name, int numArguments) Create a new Function with a given name and number of arguments

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	apply(double... args) Method that does the actual calculation of the function value given the arguments
static char[]	getAllowedFunctionCharacters() Deprecated. since 0.4.5 All unicode letters are allowed to be used in function names since 0.4.3. This API Function can be safely ignored. Checks for function name validity can be done using Character.isLetter() et al.
String	getName() Get the name of the Function
int	getNumArguments() Get the number of arguments for this function
static boolean	isValidFunctionName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

numArguments

protected final int numArguments

Constructor Detail

Function

public Function(String name,
        int numArguments)

Create a new Function with a given name and number of arguments

Parameters:

name - the name of the Function

numArguments - the number of arguments the function takes

Function

public Function(String name)

Create a new Function with a given name that takes a single argument

Parameters:

name - the name of the Function

Method Detail

getName

public String getName()

Get the name of the Function

Returns:

the name

getNumArguments

public int getNumArguments()

Get the number of arguments for this function

Returns:

the number of arguments

apply

public abstract double apply(double... args)

Method that does the actual calculation of the function value given the arguments

Parameters:

args - the set of arguments used for calculating the function

Returns:

the result of the function evaluation

getAllowedFunctionCharacters

public static char[] getAllowedFunctionCharacters()

Deprecated. since 0.4.5 All unicode letters are allowed to be used in function names since 0.4.3. This API Function can be safely ignored. Checks for function name validity can be done using Character.isLetter() et al.

Get the set of characters which are allowed for use in Function names.

Returns:

the set of characters allowed

isValidFunctionName

public static boolean isValidFunctionName(String name)