burlap.oomdp.statehashing

Class FixedSizeStateHashableStateFactory

java.lang.Object

burlap.oomdp.statehashing.SimpleHashableStateFactory

burlap.oomdp.statehashing.ImmutableStateHashableStateFactory

burlap.oomdp.statehashing.FixedSizeStateHashableStateFactory

All Implemented Interfaces:

HashableStateFactory

public class FixedSizeStateHashableStateFactory
extends ImmutableStateHashableStateFactory

This is a hash factory specifically for FixedSizeImmutableStates. It allows you to set a mask, to only hash a subset of objects or object classes. Because it only works for FixedSizeImmutableStates, it hashes objects specifically in the order there exist in the state. It also iterates staight through when doing the state equality comparison, allowing for significant speedups for certain domains.

Author:

brawner

Nested Class Summary

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

ImmutableStateHashableStateFactory.ImmutableHashableState

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

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

Field Summary

Fields inherited from class burlap.oomdp.statehashing.ImmutableStateHashableStateFactory

maskedObjectClasses, maskedObjects, objectHashingFactory

Fields inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

identifierIndependent, useCached

Constructor Summary

Constructors

Constructor and Description
FixedSizeStateHashableStateFactory(boolean identifierIndependent, FixedSizeImmutableState initialState)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	identifierDependentEquals(ImmutableStateInterface s1, ImmutableStateInterface s2) Because the objects are assumed to be in a fixed order.
void	setObjectClassMask(boolean value, java.lang.String... objectClassNames) Sets all masking value of the provided object classes.
void	setObjectMask(boolean value, java.lang.String... objectNames) Sets all masking value of the provided objects.
protected boolean	statesEqual(State s1, State s2) Returns true if the two input states are equal.

Methods inherited from class burlap.oomdp.statehashing.ImmutableStateHashableStateFactory

computeHashCode, getImmutableState, hashState, isObjectMasked, prepareSet, setObjectClassMask, setObjectMask

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

Constructor Detail

FixedSizeStateHashableStateFactory

public FixedSizeStateHashableStateFactory(boolean identifierIndependent,
                                  FixedSizeImmutableState initialState)

Method Detail

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

Overrides:

setObjectClassMask in class ImmutableStateHashableStateFactory

Parameters:

objectClassNames - the object class names to mask

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

Overrides:

setObjectMask in class ImmutableStateHashableStateFactory

Parameters:

objectNames - the object names to mask

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 ImmutableStateHashableStateFactory

Parameters:

s1 - a State

s2 - another State with which to compare

Returns:

true if s1 equals s2, false otherwise.

identifierDependentEquals

protected boolean identifierDependentEquals(ImmutableStateInterface s1,
                                ImmutableStateInterface s2)

Because the objects are assumed to be in a fixed order. If the equality comparison is name dependent you don't need to check equality among any other objects, just the ones used in the comparison.

Parameters:

s1 - first ImmutableState to compare

s2 - second ImmutableState o compare

Returns:

true or false