Class HarmonicOscillator.Parametric
java.lang.Object
org.apache.commons.math3.analysis.function.HarmonicOscillator.Parametric
- All Implemented Interfaces:
ParametricUnivariateFunction
- Enclosing class:
HarmonicOscillator
public static class HarmonicOscillator.Parametric
extends Object
implements ParametricUnivariateFunction
Parametric function where the input array contains the parameters of
the harmonic oscillator function, ordered as follows:
- Amplitude
- Angular frequency
- Phase
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
Parametric
public Parametric()
-
-
Method Details
-
value
public double value(double x, double... param) throws NullArgumentException, DimensionMismatchException Computes the value of the harmonic oscillator atx.- Specified by:
valuein interfaceParametricUnivariateFunction- Parameters:
x- Value for which the function must be computed.param- Values of norm, mean and standard deviation.- Returns:
- the value of the function.
- Throws:
NullArgumentException- ifparamisnull.DimensionMismatchException- if the size ofparamis not 3.
-
gradient
public double[] gradient(double x, double... param) throws NullArgumentException, DimensionMismatchException Computes the value of the gradient atx. The components of the gradient vector are the partial derivatives of the function with respect to each of the parameters (amplitude, angular frequency and phase).- Specified by:
gradientin interfaceParametricUnivariateFunction- Parameters:
x- Value at which the gradient must be computed.param- Values of amplitude, angular frequency and phase.- Returns:
- the gradient vector at
x. - Throws:
NullArgumentException- ifparamisnull.DimensionMismatchException- if the size ofparamis not 3.
-