joptima.functions

Class Linear

java.lang.Object

joptima.functions.ConstrainableFunction

joptima.functions.Linear

All Implemented Interfaces:

Function

public class Linear
extends ConstrainableFunction

Function a * x + b. A concrete implementation of joptima.Function that calculates a linear function of one argument.

Field Summary

Fields

Modifier and Type	Field and Description
double	m_a
double	m_b

Constructor Summary

Constructors

Constructor and Description
Linear() Default constructor: a = 1, b = 0.
Linear(double a, double b) 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	getA()
double	getB()
java.lang.String	getName() Gets the (user-settable) name of this function.
Parameter[]	getParameters() Lists all the mutable parameters to this function.
void	setA(double a)
void	setB(double b)
void	setName(java.lang.String newname) Overrides the default function name.

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_a

public double m_a

m_b

public double m_b

Constructor Detail

Linear

public Linear()

Default constructor: a = 1, b = 0.

Linear

public Linear(double a,
              double b)

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

getA

public double getA()

setA

public void setA(double a)

getB

public double getB()

setB

public void setB(double b)