burlap.statehashing.masked

Class MaskedHashableStateFactory

java.lang.Object

burlap.statehashing.simple.SimpleHashableStateFactory

burlap.statehashing.masked.MaskedHashableStateFactory

All Implemented Interfaces:

HashableStateFactory

public class MaskedHashableStateFactory
extends SimpleHashableStateFactory

This class produces HashableState instances in which the hash code and equality of the states masks (ignores) specified state variables. For OOStates, this class can also be specified to mask entire OO-MDP objects belonging to specified OO-MDP classes.

If masks are specified for variables, and the state is an OOState then the variables names specified for the masks are assumed to be on the object-level. Therefore, if two different objects have the same set of variables keys, a single mask for the variable name key will mask variable values for all objects that have that key.

This class extends SimpleHashableStateFactory, which means it can be toggled to to be object identifier/name independent or dependent and can be set to use HashableState instances that cache their hash code or not. See the SimpleHashableStateFactory class documentation for more information on those features.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected MaskedConfig	config

Fields inherited from class burlap.statehashing.simple.SimpleHashableStateFactory

identifierIndependent

Constructor Summary

Constructors

Constructor and Description
MaskedHashableStateFactory() Default constructor: object identifier independent, no hash code caching, and no object class or attribute masks.
MaskedHashableStateFactory(boolean identifierIndependent) Initializes with no hash code caching and no object class or attribute masks.
MaskedHashableStateFactory(boolean identifierIndependent, boolean maskNamesAreForVariables, java.lang.String... masks) Initializes with a specified variable or object class mask.

Method Summary

Modifier and Type	Method and Description
void	addObjectClassMasks(java.lang.String... masks) Adds masks for entire OO-MDP objects that belong to the specified OO-MDP object class.
void	addVariableMasks(java.lang.Object... masks) Adds masks for specific state variables.
void	clearAllAttributeMasks() Clears all state variable masks.
void	clearAllObjectClassMasks() Clears all object class masks.
MaskedConfig	getConfig()
HashableState	hashState(State s) Turns State s into a HashableState
void	removeAttributeMasks(java.lang.Object... masks) Removes variable masks.
void	removeObjectClassMasks(java.lang.String... masks) Removes masks for OO-MDP object classes
void	setConfig(MaskedConfig config)

Methods inherited from class burlap.statehashing.simple.SimpleHashableStateFactory

objectIdentifierIndependent

Methods inherited from class java.lang.Object

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

Field Detail

config

protected MaskedConfig config

Constructor Detail

MaskedHashableStateFactory

public MaskedHashableStateFactory()

Default constructor: object identifier independent, no hash code caching, and no object class or attribute masks.

MaskedHashableStateFactory

public MaskedHashableStateFactory(boolean identifierIndependent)

Initializes with no hash code caching and no object class or attribute masks.

Parameters:

identifierIndependent - if true then state evaluations are object identifier independent; if false then dependent.

MaskedHashableStateFactory

public MaskedHashableStateFactory(boolean identifierIndependent,
                                  boolean maskNamesAreForVariables,
                                  java.lang.String... masks)

Initializes with a specified variable or object class mask.

Parameters:

identifierIndependent - if true then state evaluations are object identifier independent; if false then dependent.

maskNamesAreForVariables - whether the specified masks are masks for state variables or object classes. True for variables, false for object classes.

masks - the names of the state variables or OO-MDP object class that will be masked (ignored from state hashing and equality checks)

Method Detail

addVariableMasks

public void addVariableMasks(java.lang.Object... masks)

Adds masks for specific state variables. Mask keys should match what is returned by the State.variableKeys() method.

Parameters:

masks - keys of the state variables to mask

addObjectClassMasks

public void addObjectClassMasks(java.lang.String... masks)

Adds masks for entire OO-MDP objects that belong to the specified OO-MDP object class.

Parameters:

masks - the names of the object classes to mask.

removeAttributeMasks

public void removeAttributeMasks(java.lang.Object... masks)

Removes variable masks.

Parameters:

masks - variable keys for which masks should be removed

removeObjectClassMasks

public void removeObjectClassMasks(java.lang.String... masks)

Removes masks for OO-MDP object classes

Parameters:

masks - the names object classes that will no longer be masked.

clearAllAttributeMasks

public void clearAllAttributeMasks()

Clears all state variable masks.

clearAllObjectClassMasks

public void clearAllObjectClassMasks()

Clears all object class masks.

getConfig

public MaskedConfig getConfig()

setConfig

public void setConfig(MaskedConfig config)

hashState

public HashableState hashState(State s)

Description copied from interface: HashableStateFactory

Turns State s into a HashableState

Specified by:

hashState in interface HashableStateFactory

Overrides:

hashState in class SimpleHashableStateFactory

Parameters:

s - the input State to transform.

Returns:

a HashableState.