net.sourceforge.cilib.controlparameter
Class LinearDecreasingControlParameter

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

All Implemented Interfaces:

Serializable, ControlParameter, Cloneable

public class LinearDecreasingControlParameter
extends BoundedControlParameter

A control parameter that is defined to update itself in an linearly decreasing 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

LinearDecreasingControlParameter()
Create a new instance of LinearDecreasingControlParameter.

LinearDecreasingControlParameter(LinearDecreasingControlParameter copy)
Create a copy of the provided instance.

Method Summary

LinearDecreasingControlParameter	getClone() Clone the current object such that a comparison of the clone and original object will yield two separate, but duplicate objects.
void	setUpperBound(double value) Set the value for the upper bound.
void	update() Update the paramter.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearDecreasingControlParameter

public LinearDecreasingControlParameter()

Create a new instance of LinearDecreasingControlParameter.

LinearDecreasingControlParameter

public LinearDecreasingControlParameter(LinearDecreasingControlParameter copy)

Create a copy of the provided instance.

Parameters:

copy - The instance to copy.

Method Detail

getClone

public LinearDecreasingControlParameter 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 paramter.

Specified by:

update in class BoundedControlParameter

setUpperBound

public void setUpperBound(double value)

Set the value for the upper bound.

Overrides:

setUpperBound in class BoundedControlParameter

Parameters:

value - The value to set.