hu.ibello.functions

Interface Function

All Known Implementing Classes:

ConstantFunction, LinearFunction, Logistic4Function, Logistic4InverseFunction, Logistic5Function, Logistic5InverseFunction, PowerFunction

public interface Function

Represents a function which can be fittted to a dataset.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
default String	getFormattedParameter(int paramIndex) Formats the value of an indexed parameter.
double	getParameter(int paramIndex) Returns the value of a parameter by index.
int	getParameterCount() How many parameters this function has?
default double[]	getParameters() Returns an array with the parameters.
void	setParameter(int paramIndex, double value) Sets the value of a parameter by index.
default void	setParameters(double... parameters) Sets all the parameters.
double	value(double x) Value of the function at x.

Method Detail

value

double value(double x)

Value of the function at x.

Parameters:

x - the input value

Returns:

function's value at x

getParameterCount

int getParameterCount()

How many parameters this function has?

Returns:

number of function parameters

getParameter

double getParameter(int paramIndex)

Returns the value of a parameter by index. The index of the first parameter is 0.

Parameters:

paramIndex - index of the parameter

Returns:

the parameter's value

setParameter

void setParameter(int paramIndex,
                  double value)

Sets the value of a parameter by index. The index of the first parameter is 0.

Parameters:

paramIndex - index of the parameter

value - new value of the parameter

getParameters

default double[] getParameters()

Returns an array with the parameters. The index in this array correlates with the index in the getParameter(int) and setParameter(int, double) methods.

Returns:

array of parameters

setParameters

default void setParameters(double... parameters)

Sets all the parameters. The index in the input array should correlate with the index in the getParameter(int) and setParameter(int, double) methods.

Parameters:

parameters - array of parameters

getFormattedParameter

default String getFormattedParameter(int paramIndex)

Formats the value of an indexed parameter. The index of the first parameter is 0. Negative value will be in parenthesis.

Parameters:

paramIndex - index of the parameter

Returns:

the formatted value