Package org.opensourcephysics.tools

Class KnownPolynomial

java.lang.Object

org.opensourcephysics.numerics.Polynomial

org.opensourcephysics.numerics.PolynomialLeastSquareFit

org.opensourcephysics.tools.KnownPolynomial

All Implemented Interfaces:

Function, KnownFunction

public class KnownPolynomial
extends PolynomialLeastSquareFit
implements KnownFunction

A polynomial that implements KnownFunction. Limited to degree 5 or less.

Field Summary

Fields inherited from class org.opensourcephysics.numerics.Polynomial

coefficients

Method Summary

Modifier and Type	Method	Description
KnownPolynomial	clone()	Gets a clone of this function.
boolean	equals(java.lang.Object f)	Determines if another KnownFunction is the same as this one.
java.lang.String	getDescription()	Gets the description of the function.
java.lang.String	getExpression(java.lang.String indepVarName)	Gets the expression.
java.lang.String	getName()	Gets the name of the function.
int	getParameterCount()	Gets the parameter count.
java.lang.String	getParameterDescription(int i)	Gets a parameter description.
java.lang.String	getParameterName(int i)	Gets a parameter name.
double	getParameterValue(int i)	Gets a parameter value.
void	setDescription(java.lang.String aDescription)	Sets the description of the function.
void	setName(java.lang.String aName)	Sets the name of the function.
void	setParameters(java.lang.String[] names, double[] values, java.lang.String[] descriptions)	Sets the parameters.
void	setParameterValue(int i, double value)	Sets a parameter value.

Methods inherited from interface org.opensourcephysics.numerics.Function

evaluate

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.opensourcephysics.numerics.Polynomial

add, add, coefficient, deflate, degree, derivative, divide, divide, divideWithRemainder, evalPolynomial, evaluate, getCoefficients, integral, integral, multiply, multiply, roots, rootsReal, subtract, subtract, toString, valueAndDerivative

Methods inherited from class org.opensourcephysics.numerics.PolynomialLeastSquareFit

computeCoefficients, fitData

Method Detail

getParameterCount

public int getParameterCount()

Gets the parameter count.

Specified by:

getParameterCount in interface KnownFunction

Returns:

the number of parameters

getParameterName

public java.lang.String getParameterName(int i)

Gets a parameter name.

Specified by:

getParameterName in interface KnownFunction

Parameters:

i - the parameter index

Returns:

the name of the parameter

getParameterDescription

public java.lang.String getParameterDescription(int i)

Gets a parameter description. May be null.

Specified by:

getParameterDescription in interface KnownFunction

Parameters:

i - the parameter index

Returns:

the description of the parameter (may be null)

getParameterValue

public double getParameterValue(int i)

Gets a parameter value.

Specified by:

getParameterValue in interface KnownFunction

Parameters:

i - the parameter index

Returns:

the value of the parameter

setParameterValue

public void setParameterValue(int i,
                              double value)

Sets a parameter value.

Specified by:

setParameterValue in interface KnownFunction

Parameters:

i - the parameter index

value - the value

setParameters

public void setParameters(java.lang.String[] names,
                          double[] values,
                          java.lang.String[] descriptions)

Sets the parameters.

Specified by:

setParameters in interface KnownFunction

Parameters:

names - the parameter names (may be null)

values - the parameter values (may be null)

descriptions - the parameter descriptions (may be null)

getExpression

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

Gets the expression.

Specified by:

getExpression in interface KnownFunction

Parameters:

indepVarName - the name of the independent variable

Returns:

the equation expression

getName

public java.lang.String getName()

Gets the name of the function.

Specified by:

getName in interface KnownFunction

Returns:

the name

setName

public void setName(java.lang.String aName)

Sets the name of the function.

Specified by:

setName in interface KnownFunction

Parameters:

aName - the name

getDescription

public java.lang.String getDescription()

Gets the description of the function.

Specified by:

getDescription in interface KnownFunction

Returns:

the description

setDescription

public void setDescription(java.lang.String aDescription)

Sets the description of the function.

Specified by:

setDescription in interface KnownFunction

Parameters:

aDescription - the description

clone

public KnownPolynomial clone()

Gets a clone of this function.

Specified by:

clone in interface KnownFunction

Overrides:

clone in class java.lang.Object

Returns:

the clone

equals

public boolean equals(java.lang.Object f)

Determines if another KnownFunction is the same as this one.

Specified by:

equals in interface KnownFunction

Overrides:

equals in class java.lang.Object

Parameters:

f - the KnownFunction to test

Returns:

true if equal