org.opensourcephysics.tools
Interface KnownFunction

All Superinterfaces:

Function

All Known Implementing Classes:

KnownPolynomial, UserFunction

public interface KnownFunction
extends Function

Title: KnownFunction Description: A function that provides its name, expression and parameters to users.

Method Summary

java.lang.String	getExpression(java.lang.String indepVarName) Gets the equation.
java.lang.String	getName() Gets the name of the function.
int	getParameterCount() Gets the parameter count.
java.lang.String	getParameterName(int i) Gets a parameter name.
double	getParameterValue(int i) Gets a parameter value.
void	setParameterValue(int i, double value) Sets a parameter value.

Methods inherited from interface org.opensourcephysics.numerics.Function

evaluate

Method Detail

getParameterCount

int getParameterCount()

Gets the parameter count.

Returns:

the number of parameters

getParameterName

java.lang.String getParameterName(int i)

Gets a parameter name.

Parameters:

i - the parameter index

Returns:

the name of the parameter

getParameterValue

double getParameterValue(int i)

Gets a parameter value.

Parameters:

i - the parameter index

Returns:

the value of the parameter

setParameterValue

void setParameterValue(int i,
                       double value)

Sets a parameter value.

Parameters:

i - the parameter index

value - the value

getExpression

java.lang.String getExpression(java.lang.String indepVarName)

Gets the equation.

Parameters:

indepVarName - the name of the independent variable

Returns:

the equation

getName

java.lang.String getName()

Gets the name of the function.

Returns:

the name