hex.grid

Interface HyperSpaceWalker.HyperSpaceIterator<MP extends Model.Parameters>

Enclosing interface:

HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

public static interface HyperSpaceWalker.HyperSpaceIterator<MP extends Model.Parameters>

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object[]	getCurrentRawParameters() Returns current "raw" state of iterator.
boolean	hasNext(Model previousModel) Returns true if the iterator can continue.
int	max_models()
double	max_runtime_secs()
void	modelFailed(Model failedModel) Inform the Iterator that a model build failed in case it needs to adjust its internal state.
MP	nextModelParameters(Model previousModel) Get next model parameters.
void	reset()
double	time_remaining_secs()

Method Detail

nextModelParameters

MP nextModelParameters(Model previousModel)

Get next model parameters.

It should return model parameters for next point in hyper space. Throws NoSuchElementException if there is no remaining point in space to explore.

The method can optimize based on previousModel, but should be able to handle null-value.

Parameters:

previousModel - model generated for the previous point in hyper space, can be null.

Returns:

model parameters for next point in hyper space or null if there is no such point.

Throws:

java.lang.IllegalArgumentException - when model parameters cannot be constructed

java.util.NoSuchElementException - if the iteration has no more elements

hasNext

boolean hasNext(Model previousModel)

Returns true if the iterator can continue. Takes into account strategy-specific stopping criteria, if any.

Parameters:

previousModel - optional parameter which helps to determine next step, can be null

Returns:

true if the iterator can produce one more model parameters configuration.

reset

void reset()

max_runtime_secs

double max_runtime_secs()

Returns:

the total time allowed for building this grid, in seconds.

max_models

int max_models()

Returns:

the total time allowed for building this grid, in seconds.

time_remaining_secs

double time_remaining_secs()

Returns:

the time remaining for building this grid, in seconds.

modelFailed

void modelFailed(Model failedModel)

Inform the Iterator that a model build failed in case it needs to adjust its internal state.

Parameters:

failedModel -

getCurrentRawParameters

java.lang.Object[] getCurrentRawParameters()

Returns current "raw" state of iterator. The state is represented by a permutation of values of grid parameters.

Returns:

array of "untyped" values representing configuration of grid parameters