Package repast.simphony.parameter

Class ListParameterSetter<T>

java.lang.Object

repast.simphony.parameter.AbstractSweepParameterSetter<T>

repast.simphony.parameter.ListParameterSetter<T>

All Implemented Interfaces:

OptimizableParameterSetter, ParameterSetter

public class ListParameterSetter<T>
extends AbstractSweepParameterSetter<T>

An initializer that will go through a list of parameters.

Author:

Jerry Vos

Field Summary

Fields inherited from class repast.simphony.parameter.AbstractSweepParameterSetter

LAST_VALUE_INDEX, lastValue, parameterName, RESET_INDEX, revertValue

Constructor Summary

Constructors

Constructor	Description
ListParameterSetter(String parameterName, T[] list)	Constructs this with the specified parameter name (where the parameter will be stored) and iterating through the given parameter list.

Method Summary

Modifier and Type	Method	Description
boolean	atBeginning()
protected boolean	atBeginning(T prevValue)
boolean	atEnd()	Compares the index to the number of elements in the list/
protected boolean	atEnd(T prevValue)
protected T	nextValue(T prevValue)	Fetches the next element in the list and increments the index.
protected T	previousValue(T prevValue)
protected T	randomValue()
void	reset(Parameters params)	Resets the index of the parameters to the next value.
protected T	resetValue()
void	revert(Parameters params)
String	toString()

Methods inherited from class repast.simphony.parameter.AbstractSweepParameterSetter

getParameterName, next, previous, randDouble, randInt, random

Methods inherited from class java.lang.Object

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

Constructor Details

ListParameterSetter

public ListParameterSetter(String parameterName,
 T[] list)

Constructs this with the specified parameter name (where the parameter will be stored) and iterating through the given parameter list.

Parameters:

parameterName - the name of the parameter values will be stored in

list - the list of values to go through

Method Details

reset

public void reset(Parameters params)

Resets the index of the parameters to the next value.

Specified by:

reset in interface ParameterSetter

Overrides:

reset in class AbstractSweepParameterSetter<T>

atEnd

public boolean atEnd()

Compares the index to the number of elements in the list/

Specified by:

atEnd in interface ParameterSetter

Overrides:

atEnd in class AbstractSweepParameterSetter<T>

Returns:

true if the list's index is greater than the list's length

nextValue

protected T nextValue(T prevValue)

Fetches the next element in the list and increments the index.

Specified by:

nextValue in class AbstractSweepParameterSetter<T>

Returns:

the next element in the list

revert

public void revert(Parameters params)

Specified by:

revert in interface OptimizableParameterSetter

Overrides:

revert in class AbstractSweepParameterSetter<T>

atBeginning

public boolean atBeginning()

Specified by:

atBeginning in interface OptimizableParameterSetter

Overrides:

atBeginning in class AbstractSweepParameterSetter<T>

previousValue

protected T previousValue(T prevValue)

Specified by:

previousValue in class AbstractSweepParameterSetter<T>

randomValue

protected T randomValue()

Specified by:

randomValue in class AbstractSweepParameterSetter<T>

resetValue

protected T resetValue()

Specified by:

resetValue in class AbstractSweepParameterSetter<T>

atEnd

protected boolean atEnd(T prevValue)

Specified by:

atEnd in class AbstractSweepParameterSetter<T>

atBeginning

protected boolean atBeginning(T prevValue)

Specified by:

atBeginning in class AbstractSweepParameterSetter<T>

toString

public String toString()

Overrides:

toString in class Object