gov.sandia.cognition.learning.function.scalar
Class CosineFunction

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.math.AbstractScalarFunction<Double>
          extended by gov.sandia.cognition.math.AbstractUnivariateScalarFunction
              extended by gov.sandia.cognition.math.AbstractDifferentiableUnivariateScalarFunction
                  extended by gov.sandia.cognition.learning.function.scalar.CosineFunction
All Implemented Interfaces:
Evaluator<Double,Double>, DifferentiableEvaluator<Double,Double,Double>, DifferentiableUnivariateScalarFunction, Vectorizable, ScalarFunction<Double>, UnivariateScalarFunction, CloneableSerializable, Serializable, Cloneable

public class CosineFunction
extends AbstractDifferentiableUnivariateScalarFunction
implements Vectorizable

A closed-form cosine function. The output "y" is given by the equation y=A*cos(2*pi*f*x + phase).

Since:
3.0
Author:
Kevin R. Dixon
See Also:
Serialized Form

Field Summary
static double TWO_PI
          Value of 2.0*pi = 6.283185307179586.
 
Constructor Summary
CosineFunction()
          Creates a new instance of CosineFunction
CosineFunction(double amplitude, double frequency)
          Creates a new instance of CosineFunction
CosineFunction(double amplitude, double frequency, double phase)
          Creates a new instance of CosineFunction
 
Method Summary
 CosineFunction clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 void convertFromVector(Vector parameters)
          Converts the object from a Vector of parameters.
 Vector convertToVector()
          Converts the object to a vector.
 double differentiate(double input)
          Differentiates the output of the function about the given input
 double evaluate(double input)
          Produces a double output for the given double input
 double getAmplitude()
          Getter for amplitude
 double getFrequency()
          Getter for frequency
 double getPhase()
          Getter for phase
 void setAmplitude(double amplitude)
          Setter for amplitude
 void setFrequency(double frequency)
          Setter for frequency
 void setPhase(double phase)
          Setter for phase
 String toString()
           
 
Methods inherited from class gov.sandia.cognition.math.AbstractDifferentiableUnivariateScalarFunction
differentiate
 
Methods inherited from class gov.sandia.cognition.math.AbstractUnivariateScalarFunction
evaluate, evaluateAsDouble
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.math.ScalarFunction
evaluateAsDouble
 
Methods inherited from interface gov.sandia.cognition.evaluator.Evaluator
evaluate
 

Field Detail

TWO_PI

public static final double TWO_PI
Value of 2.0*pi = 6.283185307179586.

See Also:
Constant Field Values
Constructor Detail

CosineFunction

public CosineFunction()
Creates a new instance of CosineFunction


CosineFunction

public CosineFunction(double amplitude,
                      double frequency)
Creates a new instance of CosineFunction

Parameters:
amplitude - Maximum value of the cosine function. The value of "A" in y=A*cos(2*pi*f*x + phase).
frequency - Frequency of the cosine function. The value of "f" in y=A*cos(2*pi*f*x + phase).

CosineFunction

public CosineFunction(double amplitude,
                      double frequency,
                      double phase)
Creates a new instance of CosineFunction

Parameters:
amplitude - Maximum value of the cosine function. The value of "A" in y=A*cos(2*pi*f*x + phase).
frequency - Frequency of the cosine function. The value of "f" in y=A*cos(2*pi*f*x + phase).
phase - Phase of the cosine function. The value of "phase" in y=A*cos(2*pi*f*x + phase).
Method Detail

clone

public CosineFunction clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface Vectorizable
Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

evaluate

public double evaluate(double input)
Description copied from interface: UnivariateScalarFunction
Produces a double output for the given double input

Specified by:
evaluate in interface UnivariateScalarFunction
Parameters:
input - Input to the Evaluator
Returns:
output at the given input

differentiate

public double differentiate(double input)
Description copied from interface: DifferentiableUnivariateScalarFunction
Differentiates the output of the function about the given input

Specified by:
differentiate in interface DifferentiableUnivariateScalarFunction
Parameters:
input - Input about which to compute the derivative of the function output
Returns:
Derivative of the output with respect to the input

getAmplitude

public double getAmplitude()
Getter for amplitude

Returns:
Maximum value of the cosine function. The value of "A" in y=A*cos(2*pi*f*x + phase).

setAmplitude

public void setAmplitude(double amplitude)
Setter for amplitude

Parameters:
amplitude - Maximum value of the cosine function. The value of "A" in y=A*cos(2*pi*f*x + phase).

getFrequency

public double getFrequency()
Getter for frequency

Returns:
Frequency of the cosine function. The value of "f" in y=A*cos(2*pi*f*x + phase).

setFrequency

public void setFrequency(double frequency)
Setter for frequency

Parameters:
frequency - Frequency of the cosine function. The value of "f" in y=A*cos(2*pi*f*x + phase).

getPhase

public double getPhase()
Getter for phase

Returns:
Phase of the cosine function. The value of "phase" in y=A*cos(2*pi*f*x + phase).

setPhase

public void setPhase(double phase)
Setter for phase

Parameters:
phase - Phase of the cosine function. The value of "phase" in y=A*cos(2*pi*f*x + phase).

convertToVector

public Vector convertToVector()
Description copied from interface: Vectorizable
Converts the object to a vector.

Specified by:
convertToVector in interface Vectorizable
Returns:
The Vector form of the object.

convertFromVector

public void convertFromVector(Vector parameters)
Description copied from interface: Vectorizable
Converts the object from a Vector of parameters.

Specified by:
convertFromVector in interface Vectorizable
Parameters:
parameters - The parameters to incorporate.

toString

public String toString()
Overrides:
toString in class Object