burlap.behavior.singleagent.auxiliary.gridset

Class FlatStateGridder

java.lang.Object

burlap.behavior.singleagent.auxiliary.gridset.FlatStateGridder

public class FlatStateGridder
extends java.lang.Object

This class is used to generate a set of continuous states that are spaced over grid points. The grid dimensions are specified using the gridDimension(Object, VariableGridSpec) or gridDimension(Object, double, double, int) method. Gridding is performed by manipulating (and copying) an input MutableState. If the input state contains state variables that do not have a grid spec, then those values will hold constant.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Object,VariableGridSpec>	gridSpecs

Constructor Summary

Constructors

Constructor and Description
FlatStateGridder()

Method Summary

Modifier and Type	Method and Description
FlatStateGridder	gridDimension(java.lang.Object varKey, double lowerVal, double upperVal, int numGridPoints) Specify a state variable as a dimension of the grid
FlatStateGridder	gridDimension(java.lang.Object varKey, VariableGridSpec gridSpec) Specify a state variable as a dimension of a the grid
VariableGridSpec	gridSpec(java.lang.Object varKey) Returns the grid spec defined for the variable key
java.util.List<State>	gridState(MutableState s) Grids the input state.
protected void	gridStateHelper(MutableState s, java.util.List<java.util.Map.Entry<java.lang.Object,VariableGridSpec>> gridDims, int index, java.util.List<State> createdStates)
java.util.Set<java.util.Map.Entry<java.lang.Object,VariableGridSpec>>	specs() Returns the set of all grid specs defined.

Methods inherited from class java.lang.Object

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

Field Detail

gridSpecs

protected java.util.Map<java.lang.Object,VariableGridSpec> gridSpecs

Constructor Detail

FlatStateGridder

public FlatStateGridder()

Method Detail

gridDimension

public FlatStateGridder gridDimension(java.lang.Object varKey,
                                      double lowerVal,
                                      double upperVal,
                                      int numGridPoints)

Specify a state variable as a dimension of the grid

Parameters:

varKey - the variable key

lowerVal - the lower value of grid

upperVal - the upper value of the grid

numGridPoints - the number of grid points that spans the lower to upper bound

Returns:

this object, so that the builder paradigm can be used for specifying multiple dimensions.

gridDimension

public FlatStateGridder gridDimension(java.lang.Object varKey,
                                      VariableGridSpec gridSpec)

Specify a state variable as a dimension of a the grid

Parameters:

varKey - the variable key

gridSpec - the grid specification

Returns:

this object, so that the builder paradigm can be used for specifying multiple dimensions.

gridSpec

public VariableGridSpec gridSpec(java.lang.Object varKey)

Returns the grid spec defined for the variable key

Parameters:

varKey - the variable key

Returns:

the grid spec

specs

public java.util.Set<java.util.Map.Entry<java.lang.Object,VariableGridSpec>> specs()

Returns the set of all grid specs defined. The key in each returned entry is the variable key.

Returns:

the set of all grid specs defined.

gridState

public java.util.List<State> gridState(MutableState s)

Grids the input state. Any variables in the state for which grid specifications have not be specified will be held constant in the set of returned states.

Parameters:

s - the input state to grid.

Returns:

the list of states spaced on the grid

gridStateHelper

protected void gridStateHelper(MutableState s,
                               java.util.List<java.util.Map.Entry<java.lang.Object,VariableGridSpec>> gridDims,
                               int index,
                               java.util.List<State> createdStates)