org.opensourcephysics.tools
Interface KnownFunction

All Superinterfaces:

Function

public interface KnownFunction

extends Function

Title: KnownFunction Description: A function that provides its equation and parameters to users.

Method Summary

java.lang.String	getEquation(java.lang.String indepVarName) Gets the equation.
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

public int getParameterCount()

Gets the parameter count.

Returns:

the number of parameters

getParameterName

public java.lang.String getParameterName(int i)

Gets a parameter name.

Parameters:

i - the parameter index

Returns:

the name of the parameter

getParameterValue

public double getParameterValue(int i)

Gets a parameter value.

Parameters:

i - the parameter index

Returns:

the value of the parameter

setParameterValue

public void setParameterValue(int i,
                              double value)

Sets a parameter value.

Parameters:

i - the parameter index

value - the value

getEquation

public java.lang.String getEquation(java.lang.String indepVarName)

Gets the equation.

Parameters:

indepVarName - the name of the independent variable

Returns:

the equation