org.apache.commons.math.analysis.function
Class HarmonicOscillator

java.lang.Object
  org.apache.commons.math.analysis.function.HarmonicOscillator

All Implemented Interfaces:

DifferentiableUnivariateRealFunction, UnivariateRealFunction

public class HarmonicOscillator
extends java.lang.Object
implements DifferentiableUnivariateRealFunction

simple harmonic oscillator function.

Since:

3.0

Version:

$Id$

Nested Class Summary

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

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

Method Summary

UnivariateRealFunction	derivative() Returns the derivative of the function
double	value(double x) Compute the value of 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 UnivariateRealFunction

Parameters:

x - Point at which the function value should be computed.

Returns:

the value of the function.

derivative

public UnivariateRealFunction derivative()

Returns the derivative of the function

Specified by:

derivative in interface DifferentiableUnivariateRealFunction

Returns:

the derivative function