2/15/2016

Overview Package

PolynomialFunction (Apache Commons Math 3.6 API)

Class

Use Tree Deprecated Index Help

PrevClass NextClass

Frames NoFrames

Summary:Nested|Field|Constr|Method

AllClasses

Detail:Field|Constr|Method

org.apache.commons.math3.analysis.polynomials

ClassPolynomialFunction
java.lang.Object
org.apache.commons.math3.analysis.polynomials.PolynomialFunction

AllImplementedInterfaces:
Serializable,DifferentiableUnivariateFunction,UnivariateDifferentiableFunction,UnivariateFunction

public class PolynomialFunction

extends Object
implements UnivariateDifferentiableFunction, DifferentiableUnivariateFunction, Serializable
Immutablerepresentationofarealpolynomialfunctionwithrealcoefficients.
Horner'sMethodisusedtoevaluatethefunction.

SeeAlso:
SerializedForm

NestedClassSummary
NestedClasses
ModifierandType
static class

ClassandDescription
PolynomialFunction.Parametric
Dedicatedparametricpolynomial
class.

ConstructorSummary
Constructors
ConstructorandDescription
PolynomialFunction(double[]c)
Constructapolynomialwiththegiven
coefficients.

MethodSummary
Methods
ModifierandType

MethodandDescription

PolynomialFunction

add(PolynomialFunctionp)
Addapolynomialtotheinstance.

int

degree()
Returnsthedegreeofthepolynomial.

UnivariateFunction

derivative()
Returnsthederivativeas
aUnivariateFunction.

protected static double[] differentiate(double[]coefficients)

Returnsthecoefficientsofthederivativeofthe
polynomialwiththegivencoefficients.
data:text/html;charset=utf-8,%3Cdiv%20class%3D%22topNav%22%20style%3D%22color%3A%20rgb(255%2C%20255%2C%2025

1/6

2/15/2016

PolynomialFunction (Apache Commons Math 3.6 API)

boolean

equals(Objectobj)

protected static double

evaluate(double[]coefficients,
doubleargument)
UsesHorner'sMethodtoevaluatethe
polynomialwiththegivencoefficientsatthe
argument.

double[]

getCoefficients()
Returnsacopyofthecoefficientsarray.

int

hashCode()

PolynomialFunction

multiply(PolynomialFunctionp)
Multiplytheinstancebyapolynomial.

PolynomialFunction

negate()
Negatetheinstance.

PolynomialFunction

polynomialDerivative()
Returnsthederivativeas
aPolynomialFunction.

PolynomialFunction

subtract(PolynomialFunctionp)
Subtractapolynomialfromtheinstance.

String

toString()
Returnsastringrepresentationofthe
polynomial.

DerivativeStructure

value(DerivativeStructuret)
Simplemathematicalfunction.

double

value(doublex)
Computethevalueofthefunctionforthegiven
argument.

Methodsinheritedfromclassjava.lang.Object
clone,finalize,getClass,notify,notifyAll,wait,wait,wait

ConstructorDetail
PolynomialFunction
publicPolynomialFunction(double[]c)
throws NullArgumentException,
NoDataException
Constructapolynomialwiththegivencoefficients.Thefirstelementofthecoefficientsarrayistheconstantterm.Higherdegreecoefficientsfollow
insequence.Thedegreeoftheresultingpolynomialistheindexofthelastnonnullelementofthearray,or0ifallelementsarenull.
Theconstructormakesacopyoftheinputarrayandassignsthecopytothecoefficientsproperty.

Parameters:

cPolynomialcoefficients.
Throws:

NullArgumentExceptionifcisnull.
NoDataExceptionifcisempty.

MethodDetail
value
data:text/html;charset=utf-8,%3Cdiv%20class%3D%22topNav%22%20style%3D%22color%3A%20rgb(255%2C%20255%2C%2025

2/6

2/15/2016

PolynomialFunction (Apache Commons Math 3.6 API)

publicdoublevalue(doublex)
Computethevalueofthefunctionforthegivenargument.
Thevaluereturnedis

coefficients[n] * x^n + ... + coefficients[1] * x + coefficients[0]

Specifiedby:

valueininterfaceUnivariateFunction
Parameters:

xArgumentforwhichthefunctionvalueshouldbecomputed.
Returns:
thevalueofthepolynomialatthegivenpoint.

SeeAlso:

UnivariateFunction.value(double)

degree
publicintdegree()
Returnsthedegreeofthepolynomial.

Returns:
thedegreeofthepolynomial.

getCoefficients
publicdouble[]getCoefficients()
Returnsacopyofthecoefficientsarray.
Changesmadetothereturnedcopywillnotaffectthecoefficientsofthepolynomial.

Returns:
afreshcopyofthecoefficientsarray.

evaluate
protected staticdoubleevaluate(double[]coefficients,
doubleargument)
throws NullArgumentException,
NoDataException
UsesHorner'sMethodtoevaluatethepolynomialwiththegivencoefficientsattheargument.

Parameters:

coefficientsCoefficientsofthepolynomialtoevaluate.
argumentInputvalue.
Returns:
thevalueofthepolynomial.

Throws:

NoDataExceptionifcoefficientsisempty.
NullArgumentExceptionifcoefficientsisnull.

value
data:text/html;charset=utf-8,%3Cdiv%20class%3D%22topNav%22%20style%3D%22color%3A%20rgb(255%2C%20255%2C%2025

3/6

2/15/2016

PolynomialFunction (Apache Commons Math 3.6 API)

publicDerivativeStructurevalue(DerivativeStructuret)
throws NullArgumentException,
NoDataException
Simplemathematicalfunction.

UnivariateDifferentiableFunctionclassescomputeboththevalueandthefirstderivativeofthefunction.
Specifiedby:

valueininterfaceUnivariateDifferentiableFunction
Parameters:

tfunctioninputvalue
Returns:
functionresult

Throws:

NoDataExceptionifcoefficientsisempty.
NullArgumentExceptionifcoefficientsisnull.
Since:
3.1

add
publicPolynomialFunctionadd(PolynomialFunctionp)
Addapolynomialtotheinstance.

Parameters:

pPolynomialtoadd.
Returns:
anewpolynomialwhichisthesumoftheinstanceandp.

subtract
publicPolynomialFunctionsubtract(PolynomialFunctionp)
Subtractapolynomialfromtheinstance.

Parameters:

pPolynomialtosubtract.
Returns:
anewpolynomialwhichistheinstanceminusp.

negate
publicPolynomialFunctionnegate()
Negatetheinstance.

Returns:
anewpolynomialwithallcoefficientsnegated

multiply
publicPolynomialFunctionmultiply(PolynomialFunctionp)
data:text/html;charset=utf-8,%3Cdiv%20class%3D%22topNav%22%20style%3D%22color%3A%20rgb(255%2C%20255%2C%2025

4/6

2/15/2016

PolynomialFunction (Apache Commons Math 3.6 API)

Multiplytheinstancebyapolynomial.

Parameters:

pPolynomialtomultiplyby.
Returns:
anewpolynomialequaltothistimesp

differentiate
protected staticdouble[]differentiate(double[]coefficients)
throws NullArgumentException,
NoDataException
Returnsthecoefficientsofthederivativeofthepolynomialwiththegivencoefficients.

Parameters:

coefficientsCoefficientsofthepolynomialtodifferentiate.
Returns:
thecoefficientsofthederivativeornullifcoefficientshaslength1.

Throws:

NoDataExceptionifcoefficientsisempty.
NullArgumentExceptionifcoefficientsisnull.

polynomialDerivative
publicPolynomialFunctionpolynomialDerivative()
ReturnsthederivativeasaPolynomialFunction.

Returns:
thederivativepolynomial.

derivative
publicUnivariateFunctionderivative()
ReturnsthederivativeasaUnivariateFunction.

Specifiedby:

derivativeininterfaceDifferentiableUnivariateFunction
Returns:
thederivativefunction.

toString
publicStringtoString()
Returnsastringrepresentationofthepolynomial.
Therepresentationisuseroriented.Termsaredisplayedlowestdegreesfirst.Themultiplicationssigns,coefficientsequalstooneandnullterms
arenotdisplayed(exceptifthepolynomialis0,inwhichcasethe0constanttermisdisplayed).Additionoftermswithnegativecoefficientsare
replacedbysubtractionoftermswithpositivecoefficientsexceptforthefirstdisplayedterm(i.e.wedisplay-3foraconstantnegativepolynomial,
but1 - 3 x + x^2ifthenegativecoefficientisnotthefirstonedisplayed).

Overrides:

toStringinclassObject
data:text/html;charset=utf-8,%3Cdiv%20class%3D%22topNav%22%20style%3D%22color%3A%20rgb(255%2C%20255%2C%2025

5/6

2/15/2016

PolynomialFunction (Apache Commons Math 3.6 API)

Returns:
astringrepresentationofthepolynomial.

hashCode
publicinthashCode()
Overrides:

hashCodeinclassObject

equals
publicbooleanequals(Objectobj)
Overrides:

equalsinclassObject

PrevClass NextClass
Overview Package

Class

Use Tree Deprecated Index Help

Frames NoFrames

Summary:Nested|Field|Constr|Method

AllClasses

Detail:Field|Constr|Method

Copyright20032016TheApacheSoftwareFoundation.Allrightsreserved.

data:text/html;charset=utf-8,%3Cdiv%20class%3D%22topNav%22%20style%3D%22color%3A%20rgb(255%2C%20255%2C%2025

6/6