genius.core.boaframework

Class BOAparameter

java.lang.Object

genius.core.boaframework.BOAparameter

All Implemented Interfaces:

java.io.Serializable

public class BOAparameter
extends java.lang.Object
implements java.io.Serializable

This stores the parameter specification of a BOA component: the name description and range of valid values. Used in in Tournament. If lower and higher bound is used, it also requires a step size and all in-between values in the range are being generated immediately. Basically, what is stored is [Lowerbound:Stepsize:Upperbound]. [1:5:20] = {1, 6, 11, 16}.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BOAparameter(java.lang.String name, java.lang.Double low, java.lang.Double high, java.lang.Double step) Describes a parameter for a BOA component.
BOAparameter(java.lang.String name, java.lang.Double low, java.lang.Double high, java.lang.Double step, java.lang.String description) Describes a parameter for a decoupled component.
BOAparameter(java.lang.String name, java.lang.Double defaultValue, java.lang.String description) Describes a parameter for a BOA component with a fixed single value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.Double	getHigh()
java.lang.Double	getLow()
java.lang.String	getName()
java.lang.Double	getStep()
java.util.HashSet<Pair<java.lang.String,java.lang.Double>>	getValuePairs() Returns all values of the parameters which satisfy [Lowerbound:Stepsize:Upperbound].
java.lang.String	toString()
java.lang.String	toXML()
BOAparameter	withDescription(java.lang.String newDescr)
BOAparameter	withHigh(java.lang.Double newHigh)
BOAparameter	withLow(java.lang.Double newLow)
BOAparameter	withStep(java.lang.Double step)

Methods inherited from class java.lang.Object

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

Constructor Detail

BOAparameter

public BOAparameter(java.lang.String name,
                    java.lang.Double low,
                    java.lang.Double high,
                    java.lang.Double step)

Describes a parameter for a BOA component. A parameter consists of a name, and the possible values for the parameter.

Parameters:

name - of the parameter.

low - value of the range.

high - value of the range.

step - of the range.

BOAparameter

public BOAparameter(java.lang.String name,
                    java.lang.Double defaultValue,
                    java.lang.String description)

Describes a parameter for a BOA component with a fixed single value.

Parameters:

name -

defaultValue -

description -

BOAparameter

public BOAparameter(java.lang.String name,
                    java.lang.Double low,
                    java.lang.Double high,
                    java.lang.Double step,
                    java.lang.String description)

Describes a parameter for a decoupled component. A parameter consists of a name, a description, and the possible values for the parameter.

Parameters:

name - of the parameter.

low - value of the range.

high - value of the range.

step - of the range.

description - of the parameter.

Method Detail

getValuePairs

public java.util.HashSet<Pair<java.lang.String,java.lang.Double>> getValuePairs()

Returns all values of the parameters which satisfy [Lowerbound:Stepsize:Upperbound].

Returns:

possible values for the parameter specified.

getName

public java.lang.String getName()

Returns:

name of the parameter.

getLow

public java.lang.Double getLow()

Returns:

value for the lowerbound.

getHigh

public java.lang.Double getHigh()

Returns:

upperbound of the range.

getStep

public java.lang.Double getStep()

Returns:

stepsize of the range.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescription

public java.lang.String getDescription()

Returns:

description of the parameter.

toXML

public java.lang.String toXML()

withDescription

public BOAparameter withDescription(java.lang.String newDescr)

Parameters:

newDescr - the new description for this parameter

Returns:

new BOAparameter with same settings as this but new description as given

withLow

public BOAparameter withLow(java.lang.Double newLow)

Parameters:

newLow - the new low value for this parameter.

Returns:

new BOAparameter with same settings as this but with new low value. If the high value is < newLow, it is also set to newLow.

withHigh

public BOAparameter withHigh(java.lang.Double newHigh)

Parameters:

newHigh - the new high value for this parameter

Returns:

new BOAparameter with same settings as this but with the new high value. If the high value is < low, then low is also set to newHigh.

withStep

public BOAparameter withStep(java.lang.Double step)

Parameters:

step - the new step value

Returns:

new BOAparameter with same settings as this but with step value as given