net.sourceforge.cilib.controlparameter
Class LinearIncreasingControlParameter

java.lang.Object
  net.sourceforge.cilib.controlparameter.BoundedControlParameter
      net.sourceforge.cilib.controlparameter.LinearIncreasingControlParameter

All Implemented Interfaces:

Serializable, ControlParameter, Cloneable

public class LinearIncreasingControlParameter
extends BoundedControlParameter

A control parameter that is defined to update itself in an linearly increasing manner. The rate of change within the parameter is based on the percentage complete of the running algorithm.

Author:

Gary Pampara

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sourceforge.cilib.controlparameter.BoundedControlParameter

parameter, range

Constructor Summary

LinearIncreasingControlParameter()
Create an instance of LinearDecreasingControlParameter.

LinearIncreasingControlParameter(LinearIncreasingControlParameter copy)
Copy constructor.

Method Summary

LinearIncreasingControlParameter	getClone() Clone the current object such that a comparison of the clone and original object will yield two separate, but duplicate objects.
void	setLowerBound(double lower) Set the value of the lower bound.
void	update() Update the parameter linearly based on the current percentage complete of the running algorithm.

Methods inherited from class net.sourceforge.cilib.controlparameter.BoundedControlParameter

clamp, getLowerBound, getParameter, getParameter, getRange, getUpperBound, setParameter, setRange, setUpperBound, updateParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearIncreasingControlParameter

public LinearIncreasingControlParameter()

Create an instance of LinearDecreasingControlParameter.

LinearIncreasingControlParameter

public LinearIncreasingControlParameter(LinearIncreasingControlParameter copy)

Copy constructor. Create a copy of the provided instance.

Parameters:

copy - The instance to copy.

Method Detail

getClone

public LinearIncreasingControlParameter getClone()

Clone the current object such that a comparison of the clone and original object will yield two separate, but duplicate objects.

Specified by:

getClone in interface ControlParameter

Specified by:

getClone in interface Cloneable

Specified by:

getClone in class BoundedControlParameter

Returns:

The cloned ControlParameter

See Also:

Object.clone()

update

public void update()

Update the parameter linearly based on the current percentage complete of the running algorithm. The update is done in an increasing manner.

Specified by:

update in class BoundedControlParameter

setLowerBound

public void setLowerBound(double lower)

Set the value of the lower bound.

Overrides:

setLowerBound in class BoundedControlParameter

Parameters:

lower - The value to set.