joptima.functions

Class Arctangent

java.lang.Object

joptima.functions.ConstrainableFunction

joptima.functions.Arctangent

All Implemented Interfaces:

Function

public class Arctangent
extends ConstrainableFunction

Function atan((x - offset) / amplitude) / (2 * pi * frequency). A concrete implementation of joptima.Function that calculates an arctangent.

Field Summary

Fields

Modifier and Type	Field and Description
double	m_amplitude
double	m_frequency
double	m_xoffset

Constructor Summary

Constructors

Constructor and Description
Arctangent() Default constructor: amplitude = 1, frequency = 1, xoffset = 0.
Arctangent(double amplitude, double frequency, double xoffset) Constructor.

Method Summary

Modifier and Type	Method and Description
double	calculate(double x) Calculates the value of the function at the given point using the preset parameters.
void	constrain(java.lang.String parametername) Removes the given parameter from the parameter list.
double	getAmplitude()
double	getAngularFrequency()
double	getFrequency()
java.lang.String	getName() Gets the (user-settable) name of this function.
Parameter[]	getParameters() Lists all the mutable parameters to this function.
double	getXoffset()
void	setAmplitude(double amplitude)
void	setAngularFrequency(double omega)
void	setFrequency(double frequency)
void	setName(java.lang.String newname) Overrides the default function name.
void	setXoffset(double xoffset)

Methods inherited from class joptima.functions.ConstrainableFunction

constrain, constrain

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_amplitude

public double m_amplitude

m_frequency

public double m_frequency

m_xoffset

public double m_xoffset

Constructor Detail

Arctangent

public Arctangent()

Default constructor: amplitude = 1, frequency = 1, xoffset = 0.

Arctangent

public Arctangent(double amplitude,
                  double frequency,
                  double xoffset)

Constructor.

Method Detail

getParameters

public Parameter[] getParameters()

Description copied from interface: Function

Lists all the mutable parameters to this function.

Returns:

a Parameter[] of delegates that access the proper member variables.

constrain

public void constrain(java.lang.String parametername)

Description copied from class: ConstrainableFunction

Removes the given parameter from the parameter list. This constraint is mandatory to implement.

Specified by:

constrain in class ConstrainableFunction

getName

public java.lang.String getName()

Description copied from interface: Function

Gets the (user-settable) name of this function.

Returns:

the name of the function

setName

public void setName(java.lang.String newname)

Description copied from interface: Function

Overrides the default function name.

Parameters:

newname - the new name for the function

calculate

public double calculate(double x)

Description copied from interface: Function

Calculates the value of the function at the given point using the preset parameters.

Parameters:

x - the x coordinate to calculate the function at

Returns:

the value of the function at the given coordinate

setAngularFrequency

public void setAngularFrequency(double omega)

getAngularFrequency

public double getAngularFrequency()

getAmplitude

public double getAmplitude()

setAmplitude

public void setAmplitude(double amplitude)

getFrequency

public double getFrequency()

setFrequency

public void setFrequency(double frequency)

getXoffset

public double getXoffset()

setXoffset

public void setXoffset(double xoffset)