net.sourceforge.cilib.controlparameter
Interface ControlParameter

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

BoundedControlParameter, ConstantControlParameter, ExponentiallyDecreasingControlParameter, ExponentiallyIncreasingControlParameter, LinearDecreasingControlParameter, LinearIncreasingControlParameter, ProportionalControlParameter, RandomizingControlParameter

public interface ControlParameter
extends Cloneable, Serializable

A control parameter is a parameter that is used within most algorithm types. These parameters are updatable and can be changed over time, if required.

Author:

Gary Pampara, Andries Engelbrecht

Method Summary

ControlParameter	getClone() Clone the current object such that a comparison of the clone and original object will yield two separate, but duplicate objects.
double	getParameter() Get the value of the represented parameter.
double	getParameter(double min, double max) Get the parameter value based on the provided min and max.
void	setParameter(double value) Set the value of the represented parameter.
void	updateParameter() Update the required and needed parameters contained within this parameter.

Method Detail

getClone

ControlParameter 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 Cloneable

Returns:

The cloned ControlParameter

See Also:

Object.clone()

getParameter

double getParameter()

Get the value of the represented parameter.

Returns:

The value of the represented parameter.

getParameter

double getParameter(double min,
                    double max)

Get the parameter value based on the provided min and max.

Parameters:

min - The minimum value to use in getting the parameter value

max - The maximum value to use in getting the parameter value

Returns:

The value of the represented parameter.

setParameter

void setParameter(double value)

Set the value of the represented parameter.

Parameters:

value - The value to be used.

updateParameter

void updateParameter()

Update the required and needed parameters contained within this parameter.