HarmonicOscillator (Hipparchus 3.0 API)

java.lang.Object
- org.hipparchus.analysis.function.HarmonicOscillator

All Implemented Interfaces:

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

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`value(double x)`	Compute the value of the function.
`<T extends Derivative<T>> T`	`value(T t)`	Compute the value for the 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 <T extends Derivative<T>> T value(T t)
                                  throws MathIllegalArgumentException
```
    Compute the value for the function.
    
    Specified by:
    
    value in interface UnivariateDifferentiableFunction
    
    Type Parameters:
    
    T - the type of the field elements
    
    Parameters:
    
    t - the point for which the function value should be computed
    
    Returns:
    
    the value
    
    Throws:
    
    MathIllegalArgumentException - if x does not satisfy the function's constraints (argument out of bound, or unsupported derivative order for example)