burlap.behavior.functionapproximation.dense

Class NormalizedVariableFeatures

java.lang.Object

burlap.behavior.functionapproximation.dense.NormalizedVariableFeatures

All Implemented Interfaces:

DenseStateFeatures

public class NormalizedVariableFeatures
extends java.lang.Object
implements DenseStateFeatures

This class is will construct a double array from states by iterating over numeric state variables and setting values in the double array to the variables normalized value. To set a normalized value, you must specify the domain of each variable key that is used in the produced vector. Set these with the variableDomain(Object, VariableDomain) method. If you do not set a range for a variable, then that variable will not have a corresponding entry in the constructed double array. If a state implements StateDomain, then you can give an example state to the useAllDomains(StateDomain) method, and it will automatically define the ranges for all variables that have corresponding VariableDomain entries defined in teh StateDomain.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Object,VariableDomain>	domains

Constructor Summary

Constructors

Constructor and Description
NormalizedVariableFeatures()
NormalizedVariableFeatures(java.util.Map<java.lang.Object,VariableDomain> domains)

Method Summary

Modifier and Type	Method and Description
DenseStateFeatures	copy() Returns a copy of this DenseStateFeatures
double[]	features(State s) Returns a feature vector represented as a double array for a given input state.
NormalizedVariableFeatures	useAllDomains(StateDomain state) Goes through the state and sets the ranges for all variables that have a VariableDomain set.
NormalizedVariableFeatures	variableDomain(java.lang.Object key, VariableDomain range) Sets the variable range for the given variable.

Methods inherited from class java.lang.Object

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

Field Detail

domains

protected java.util.Map<java.lang.Object,VariableDomain> domains

Constructor Detail

NormalizedVariableFeatures

public NormalizedVariableFeatures()

NormalizedVariableFeatures

public NormalizedVariableFeatures(java.util.Map<java.lang.Object,VariableDomain> domains)

Method Detail

variableDomain

public NormalizedVariableFeatures variableDomain(java.lang.Object key,
                                                 VariableDomain range)

Sets the variable range for the given variable.

Parameters:

key - the variable key

range - the range of the variable.

Returns:

this object, so a builder design pattern may be used.

useAllDomains

public NormalizedVariableFeatures useAllDomains(StateDomain state)

Goes through the state and sets the ranges for all variables that have a VariableDomain set. If the StateDomain.domain(Object) method returns null for a state variable key, then a range will not be set and the variable will be skipped (unless a range is then manually added with the variableDomain(Object, VariableDomain) method).

Parameters:

state - the StateDomain to query for the the state ranges.

Returns:

this object, so a builder design pattern may be used

features

public double[] features(State s)

Description copied from interface: DenseStateFeatures

Returns a feature vector represented as a double array for a given input state.

Specified by:

features in interface DenseStateFeatures

Parameters:

s - the input state to turn into a feature vector.

Returns:

the feature vector represented as a double array.

copy

public DenseStateFeatures copy()

Description copied from interface: DenseStateFeatures

Returns a copy of this DenseStateFeatures

Specified by:

copy in interface DenseStateFeatures

Returns:

a copy of this DenseStateFeatures