burlap.oomdp.statehashing

Class ImmutableStateHashableStateFactory

java.lang.Object

burlap.oomdp.statehashing.SimpleHashableStateFactory

burlap.oomdp.statehashing.ImmutableStateHashableStateFactory

All Implemented Interfaces:

HashableStateFactory

Direct Known Subclasses:

FixedSizeStateHashableStateFactory

public class ImmutableStateHashableStateFactory
extends SimpleHashableStateFactory

This Hashing factory works for states that implement the ImmutableStateInterface. It caches the value by default, and also will check object equality through the == comparison, since ImmutableStates may share the same objects.

Author:

brawner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ImmutableStateHashableStateFactory.ImmutableHashableState

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>	maskedObjectClasses
protected java.util.Set<java.lang.String>	maskedObjects
protected ImmutableHashableObjectFactory	objectHashingFactory

Fields inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

identifierIndependent, useCached

Constructor Summary

Constructors

Constructor and Description
ImmutableStateHashableStateFactory(boolean identifierIndependent)

Method Summary

Methods

Modifier and Type	Method and Description
protected int	computeHashCode(State s) Computes the hash code for the input state.
protected ImmutableStateInterface	getImmutableState(State s)
HashableState	hashState(State s) Turns State s into a HashableState
protected boolean	isObjectMasked(ObjectInstance obj)
protected java.util.Set<ObjectInstance>	prepareSet(ImmutableStateInterface s)
void	setObjectClassMask(boolean value, java.lang.String... objectClassNames) Sets all masking value of the provided object classes.
void	setObjectClassMask(java.lang.String... objectClasses) Sets all objects of the provided object class to not be hashed, or used in an equality comparison.
void	setObjectMask(boolean value, java.lang.String... objectNames) Sets all masking value of the provided objects.
void	setObjectMask(java.lang.String... objectNames) Sets all objects provided to not be hashed, or used in an equality comparison
protected boolean	statesEqual(State s1, State s2) Returns true if the two input states are equal.

Methods inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

appendHashcodeForValue, computeHashCode, getAttClass, identifierDependentEquals, identifierIndependentEquals, objectIdentifierIndependent, objectValuesEqual, valuesEqual

Methods inherited from class java.lang.Object

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

Field Detail

objectHashingFactory

protected final ImmutableHashableObjectFactory objectHashingFactory

maskedObjectClasses

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

maskedObjects

protected final java.util.Set<java.lang.String> maskedObjects

Constructor Detail

ImmutableStateHashableStateFactory

public ImmutableStateHashableStateFactory(boolean identifierIndependent)

Method Detail

setObjectClassMask

public void setObjectClassMask(java.lang.String... objectClasses)

Sets all objects of the provided object class to not be hashed, or used in an equality comparison.

Parameters:

objectClasses - the object class names to mask

setObjectClassMask

public void setObjectClassMask(boolean value,
                      java.lang.String... objectClassNames)

Sets all masking value of the provided object classes. A value of true, signifies an object will be included in hashing/equality testing

Parameters:

objectClassNames - the object class names to mask

setObjectMask

public void setObjectMask(java.lang.String... objectNames)

Sets all objects provided to not be hashed, or used in an equality comparison

Parameters:

objectNames -

setObjectMask

public void setObjectMask(boolean value,
                 java.lang.String... objectNames)

Sets all masking value of the provided objects. A value of true, signifies an object will be included in hashing/equality testing

Parameters:

objectNames - the object names to mask

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.

isObjectMasked

protected boolean isObjectMasked(ObjectInstance obj)

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

statesEqual

protected boolean statesEqual(State s1,
                  State s2)

Description copied from class: SimpleHashableStateFactory

Returns true if the two input states are equal. Equality respect this hashing factory's identifier independence setting.

Overrides:

statesEqual in class SimpleHashableStateFactory

Parameters:

s1 - a State

s2 - another State with which to compare

Returns:

true if s1 equals s2, false otherwise.

prepareSet

protected java.util.Set<ObjectInstance> prepareSet(ImmutableStateInterface s)

getImmutableState

protected ImmutableStateInterface getImmutableState(State s)