HarmonicOscillator (VirtualDataSet API)

java.lang.Object
- org.apache.commons.math4.analysis.function.HarmonicOscillator

All Implemented Interfaces:

UnivariateDifferentiableFunction, UnivariateFunction
```
public class HarmonicOscillator
extends java.lang.Object
implements UnivariateDifferentiableFunction
```
simple harmonic oscillator function.

Since:

3.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HarmonicOscillator.Parametric`	Parametric function where the input array contains the parameters of the harmonic oscillator function, ordered as follows: Amplitude Angular frequency Phase

Constructor Summary

Constructors
Constructor Description

HarmonicOscillator(double amplitude, double omega, double phase)
Harmonic oscillator function.

Method Summary

Modifier and Type Method Description

double value(double x)
Compute the value of the function.

DerivativeStructure value(DerivativeStructure t)
Simple mathematical function.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HarmonicOscillator
```
public HarmonicOscillator(double amplitude,
                          double omega,
                          double phase)
```
    Harmonic oscillator function.
    
    Parameters:
    
    amplitude - Amplitude.
    
    omega - Angular frequency.
    
    phase - Phase.
- Method Detail
  - value
```
public double value(double x)
```
    Compute the value of the function.
    
    Specified by:
    
    value in interface UnivariateFunction
    
    Parameters:
    
    x - Point at which the function value should be computed.
    
    Returns:
    
    the value of the function.
  - value
```
public DerivativeStructure value(DerivativeStructure t)
                          throws DimensionMismatchException
```
    Simple mathematical function.
    UnivariateDifferentiableFunction classes compute both the value and the first derivative of the function.
    
    Specified by:
    
    value in interface UnivariateDifferentiableFunction
    
    Parameters:
    
    t - function input value
    
    Returns:
    
    function result
    
    Throws:
    
    DimensionMismatchException - if t is inconsistent with the function's free parameters or order
    
    Since:
    
    3.1