burlap.oomdp.statehashing

Class MaskedHashableStateFactory

java.lang.Object

burlap.oomdp.statehashing.SimpleHashableStateFactory

burlap.oomdp.statehashing.MaskedHashableStateFactory

All Implemented Interfaces:

HashableStateFactory

Direct Known Subclasses:

DiscretizingMaskedHashableStateFactory

public class MaskedHashableStateFactory
extends SimpleHashableStateFactory

This class produces HashableState instances in which the hash code and equality of the states ignores either ObjectInstance belonging to specific ObjectClass or value assignments for specific Attributes. You can specify which attributes and object classes to ignore through an attribute name mask and an object class name mask. There are a variety of methods for manipulating the masks.

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 hash their hash code or not. See the SimpleHashableStateFactory class documentation for more information on those features.

Author:

James MacGlashan.

Nested Class Summary

Nested classes/interfaces inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

SimpleHashableStateFactory.AttClass, SimpleHashableStateFactory.SimpleCachedHashableState, SimpleHashableStateFactory.SimpleHashableState, SimpleHashableStateFactory.SimpleHashableStateInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	maskedAttributes
protected java.util.Set<java.lang.String>	maskedObjectClasses

Fields inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

identifierIndependent, useCached

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 useCached) Initializes with no object class or attribute masks.
MaskedHashableStateFactory(boolean identifierIndependent, boolean useCached, boolean maskNamesAreForAttributes, java.lang.String... masks) Initializes with a specified attribute or object class mask.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeMasks(java.lang.String... masks) Adds masks for Attributes
void	addObjectClassMasks(java.lang.String... masks) Adds masks for ObjectClasss
void	clearAllAttributeMasks() Clears all Attribute masks.
void	clearAllObjectClassMasks() Clears all ObjectClass masks.
protected int	computeHashCode(ObjectInstance o) Computes the hash code for an individual ObjectInstance.
protected int	computeHashCode(State s) Computes the hash code for the input state.
java.util.Set<java.lang.String>	getMaskedAttributes()
java.util.Set<java.lang.String>	getMaskedObjectClasses()
protected boolean	identifierDependentEquals(State s1, State s2) Evaluates whether two states are equal when equality depends on object identifiers/names being equal.
protected boolean	identifierIndependentEquals(State s1, State s2) Evaluates whether two states are equal when equality is independent of object identifiers/names being equal
protected boolean	objectValuesEqual(ObjectInstance o1, ObjectInstance o2) Evaluates whether the values of two ObjectInstances are equal.
void	removeAttributeMasks(java.lang.String... masks) Removes Attribute masks.
void	removeObjectClassMasks(java.lang.String... masks) Removes ObjectClass masks.

Methods inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

appendHashcodeForValue, getAttClass, hashState, objectIdentifierIndependent, statesEqual, valuesEqual

Methods inherited from class java.lang.Object

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

Field Detail

maskedAttributes

protected java.util.Set<java.lang.String> maskedAttributes

maskedObjectClasses

protected java.util.Set<java.lang.String> maskedObjectClasses

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 useCached)

Initializes with no object class or attribute masks.

Parameters:

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

useCached - if true then the hash code for each produced HashableState will be cached; if false then they will not be cached.

MaskedHashableStateFactory

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

Initializes with a specified attribute or object class mask.

Parameters:

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

useCached - if true then the hash code for each produced HashableState will be cached; if false then they will not be cached.

maskNamesAreForAttributes - whether the specified masks are masks for attributes or object classes. True for attributes, false for object classes.

masks - the names of the Attributes or ObjectClass that will be masks (ignored from state hashing and equality checks)

Method Detail

addAttributeMasks

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

Adds masks for Attributes

Parameters:

masks - the names of the Attributes to mask.

addObjectClassMasks

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

Adds masks for ObjectClasss

Parameters:

masks - the names of the ObjectClasss to mask.

removeAttributeMasks

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

Removes Attribute masks.

Parameters:

masks - the names of the Attributes that will no longer be masked.

removeObjectClassMasks

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

Removes ObjectClass masks.

Parameters:

masks - the names of the ObjectClasss that will no longer be masked.

clearAllAttributeMasks

public void clearAllAttributeMasks()

Clears all Attribute masks.

clearAllObjectClassMasks

public void clearAllObjectClassMasks()

Clears all ObjectClass masks.

getMaskedAttributes

public java.util.Set<java.lang.String> getMaskedAttributes()

getMaskedObjectClasses

public java.util.Set<java.lang.String> getMaskedObjectClasses()

computeHashCode

protected int computeHashCode(State s)

Description copied from class: SimpleHashableStateFactory

Computes the hash code for the input state.

Overrides:

computeHashCode in class SimpleHashableStateFactory

Parameters:

s - the input state for which a hash code is to be computed

Returns:

the hash code

computeHashCode

protected int computeHashCode(ObjectInstance o)

Description copied from class: SimpleHashableStateFactory

Computes the hash code for an individual ObjectInstance.

Overrides:

computeHashCode in class SimpleHashableStateFactory

Parameters:

o - the ObjectInstance whose hash code will be computed.

Returns:

the hash code for the ObjectInstance.

identifierIndependentEquals

protected boolean identifierIndependentEquals(State s1,
                                  State s2)

Description copied from class: SimpleHashableStateFactory

Evaluates whether two states are equal when equality is independent of object identifiers/names being equal

Overrides:

identifierIndependentEquals in class SimpleHashableStateFactory

Parameters:

s1 - the first State to compare

s2 - the second State to compare

Returns:

true if s1 = s2; false otherwise

identifierDependentEquals

protected boolean identifierDependentEquals(State s1,
                                State s2)

Description copied from class: SimpleHashableStateFactory

Evaluates whether two states are equal when equality depends on object identifiers/names being equal.

Overrides:

identifierDependentEquals in class SimpleHashableStateFactory

Parameters:

s1 - the first State to compare

s2 - the second State to compare

Returns:

true if s1 = s2; false otherwise

objectValuesEqual

protected boolean objectValuesEqual(ObjectInstance o1,
                        ObjectInstance o2)

Description copied from class: SimpleHashableStateFactory

Evaluates whether the values of two ObjectInstances are equal.

Overrides:

objectValuesEqual in class SimpleHashableStateFactory

Parameters:

o1 - the first ObjectInstance to compare

o2 - the second ObjectInstance to compare

Returns:

true if the values of o1 = o2; false otherwise.