org.mariuszgromada.math.mxparser

Interface FunctionExtension

public interface FunctionExtension

FunctionExtension provides interface for function algorithm definition. In this case algorithm definition is based on source code using JAVA (for JAVA / Android) or .NET. If implemented Function Extension object can be further used while Function object construction, which means it can extend mXparser math collection. mXparser extension with your own implementation can be achieved by implementing FunctionExtension interface, creating an FunctionExtension object, creating Function object based on FunctionExtension, adding Function object to Expression / mXparser definition.

Version:

4.1.0

Author:

Mariusz Gromada
mariuszgromada.org@gmail.com
MathSpace.pl
MathParser.org - mXparser project page
mXparser on GitHub
mXparser on SourceForge
mXparser on Bitbucket
mXparser on CodePlex
Janet Sudoku - project web page
Janet Sudoku on GitHub
Janet Sudoku on CodePlex
Janet Sudoku on SourceForge
Janet Sudoku on BitBucket

See Also:

Function

Method Summary

Methods

Modifier and Type	Method and Description
double	calculate() Actual algorithm implementation.
FunctionExtension	clone() Cloning in case of usage in Expression with recursive statements.
String	getParameterName(int parameterIndex) Gets parameter name
int	getParametersNumber() Gets parameters number.
void	setParameterValue(int parameterIndex, double parameterValue) Sets value of function parameter

Method Detail

getParametersNumber

int getParametersNumber()

Gets parameters number.

Returns:

Returns parameters number.

setParameterValue

void setParameterValue(int parameterIndex,
                     double parameterValue)

Sets value of function parameter

Parameters:

parameterIndex - - parameter index (from 0 to n-1)

parameterValue - - parameter value

getParameterName

String getParameterName(int parameterIndex)

Gets parameter name

Parameters:

parameterIndex - - parameter index (from 0 to n-1)

Returns:

Returns parameter name

calculate

double calculate()

Actual algorithm implementation.

Returns:

Function Extension value.

clone

FunctionExtension clone()

Cloning in case of usage in Expression with recursive statements.

Returns:

Returns FunctionExtension object that was cloned.

See Also:

Expression.getRecursiveMode()