burlap.oomdp.statehashing

Class HashableState

java.lang.Object

burlap.oomdp.statehashing.HashableState

All Implemented Interfaces:

State

Direct Known Subclasses:

HashableState.CachedHashableState, HashableTabularBeliefStateFactory.HashableTabularBeliefState, ImmutableStateHashableStateFactory.ImmutableHashableState, SimpleHashableStateFactory.SimpleHashableState

public abstract class HashableState
extends java.lang.Object
implements State

This class provides a hash value for State objects. This is useful for tabular planning and learning algorithms that make use of hash-backed sets or maps for fast retrieval. You can access the state it hashes from the public data member s. If the State delegate s is a HashableState itself, and you wish to get the underlying State, then you should use the getSourceState() method, which will recursively descend and return the base source State.

Implementing this class requires implementing the hashCode() and equals(Object) method.

Note that this class implements the State interface; however, because the purpose of this class is to used with hashed data structures, it is not recommended that you modify the state.

Author:

James MacGlashan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashableState.CachedHashableState A hash code cached abstract implementation of HashableState.

Field Summary

Fields

Modifier and Type	Field and Description
State	s The source State to be hashed and evaluated by the hashCode() and equals(Object) method.

Constructor Summary

Constructors

Constructor and Description
HashableState(State s)

Method Summary

Methods

Modifier and Type	Method and Description
State	addAllObjects(java.util.Collection<ObjectInstance> objects) Adds the collection of objects to the state
State	addObject(ObjectInstance o) Adds object instance o to this state.
abstract boolean	equals(java.lang.Object obj)
java.util.List<ObjectInstance>	getAllObjects() Returns the list of observable and hidden object instances in this state.
java.util.List<java.util.List<ObjectInstance>>	getAllObjectsByClass() Returns a list of list of object instances, grouped by object class
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllUnsetAttributes() Returns a mapping from object instance names to the list of attributes names that have unset values.
java.lang.String	getCompleteStateDescription() Returns a string representation of this state using observable and hidden object instances.
java.lang.String	getCompleteStateDescriptionWithUnsetAttributesAsNull() Returns a string description of the state with unset attribute values listed as null.
ObjectInstance	getFirstObjectOfClass(java.lang.String oclass) Returns the first indexed object of the object class named oclass
ObjectInstance	getObject(java.lang.String oname) Returns the object in this state with the name oname
java.util.Set<java.lang.String>	getObjectClassesPresent() Returns a set of of the object class names for all object classes that have instantiated objects in this state.
java.util.Map<java.lang.String,java.lang.String>	getObjectMatchingTo(State so, boolean enforceStateExactness) This method computes a matching from objects in the receiver to value-identical objects in the parameter state so.
java.util.List<ObjectInstance>	getObjectsOfClass(java.lang.String oclass) Returns all objects that belong to the object class named oclass
java.util.List<java.util.List<java.lang.String>>	getPossibleBindingsGivenParamOrderGroups(java.lang.String[] paramClasses, java.lang.String[] paramOrderGroups) Given an array of parameter object classes and an array of their corresponding parameter order groups, returns all possible object instance bindings to the parameters, excluding bindings that are equivalent due to the parameter order grouping.
State	getSourceState() Returns the underlying source state is hashed.
abstract int	hashCode()
int	numTotalObjects() Returns the number of object instances in this state.
State	removeAllObjects(java.util.Collection<ObjectInstance> objects) Removes the collection of objects from the state
State	removeObject(ObjectInstance o) Removes the object instance o from this state.
State	removeObject(java.lang.String oname) Removes the object instance with the name oname from this state.
State	renameObject(ObjectInstance o, java.lang.String newName) Renames the identifier for object instance o in this state to newName.
State	renameObject(java.lang.String originalName, java.lang.String newName) Renames the identifier for the object instance currently named originalName with the name newName.
<T> State	setObjectsValue(java.lang.String objectName, java.lang.String attName, T value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface burlap.oomdp.core.states.State

copy

Field Detail

s

public State s

The source State to be hashed and evaluated by the hashCode() and equals(Object) method.

Constructor Detail

HashableState

public HashableState(State s)

Method Detail

getSourceState

public State getSourceState()

Returns the underlying source state is hashed. If the delegate State of this HashableState is also a HashableState, then it recursively returns its getSourceState().

Returns:

The underlying source State that this object hashes and evaluates.

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

addObject

public State addObject(ObjectInstance o)

Description copied from interface: State

Adds object instance o to this state.

Specified by:

addObject in interface State

Parameters:

o - the object instance to be added to this state.

Returns:

the modified state

addAllObjects

public State addAllObjects(java.util.Collection<ObjectInstance> objects)

Description copied from interface: State

Adds the collection of objects to the state

Specified by:

addAllObjects in interface State

Returns:

the modified state

removeObject

public State removeObject(java.lang.String oname)

Description copied from interface: State

Removes the object instance with the name oname from this state.

Specified by:

removeObject in interface State

Parameters:

oname - the name of the object instance to remove.

Returns:

the modified state

removeObject

public State removeObject(ObjectInstance o)

Description copied from interface: State

Removes the object instance o from this state.

Specified by:

removeObject in interface State

Parameters:

o - the object instance to remove from this state.

Returns:

the modified state

removeAllObjects

public State removeAllObjects(java.util.Collection<ObjectInstance> objects)

Description copied from interface: State

Removes the collection of objects from the state

Specified by:

removeAllObjects in interface State

Returns:

the modified state

renameObject

public State renameObject(java.lang.String originalName,
                 java.lang.String newName)

Description copied from interface: State

Renames the identifier for the object instance currently named originalName with the name newName.

Specified by:

renameObject in interface State

Parameters:

originalName - the original name of the object instance to be renamed in this state

newName - the new name of the object instance

Returns:

the modified state

renameObject

public State renameObject(ObjectInstance o,
                 java.lang.String newName)

Description copied from interface: State

Renames the identifier for object instance o in this state to newName.

Specified by:

renameObject in interface State

Parameters:

o - the object instance to rename in this state

newName - the new name of the object instance

Returns:

the modified state

getObjectMatchingTo

public java.util.Map<java.lang.String,java.lang.String> getObjectMatchingTo(State so,
                                                                   boolean enforceStateExactness)

Description copied from interface: State

This method computes a matching from objects in the receiver to value-identical objects in the parameter state so. The matching is returned as a map from the object names in the receiving state to the matched objects in state so. If enforceStateExactness is set to true, then the returned matching will be an empty map if the two states are not OO-MDP-wise identical (i.e., if there is a not a bijection between value-identical objects of the two states). If enforceExactness is false and the states are not identical, the the method will return the largest matching between objects that can be made.

Specified by:

getObjectMatchingTo in interface State

Parameters:

so - the state to whose objects the receiving state's objects should be matched

enforceStateExactness - whether to require that states are identical to return a matching

Returns:

a matching from this receiving state's objects to objects in so that have identical values.

numTotalObjects

public int numTotalObjects()

Description copied from interface: State

Returns the number of object instances in this state.

Specified by:

numTotalObjects in interface State

Returns:

the number of object instances in this state.

getObject

public ObjectInstance getObject(java.lang.String oname)

Description copied from interface: State

Returns the object in this state with the name oname

Specified by:

getObject in interface State

Parameters:

oname - the name of the object instance to return

Returns:

the object instance with the name oname or null if there is no object in this state named oname

getAllObjects

public java.util.List<ObjectInstance> getAllObjects()

Description copied from interface: State

Returns the list of observable and hidden object instances in this state.

Specified by:

getAllObjects in interface State

Returns:

the list of observable and hidden object instances in this state.

getObjectsOfClass

public java.util.List<ObjectInstance> getObjectsOfClass(java.lang.String oclass)

Description copied from interface: State

Returns all objects that belong to the object class named oclass

Specified by:

getObjectsOfClass in interface State

Parameters:

oclass - the name of the object class for which objects should be returned

Returns:

all objects that belong to the object class named oclass

getFirstObjectOfClass

public ObjectInstance getFirstObjectOfClass(java.lang.String oclass)

Description copied from interface: State

Returns the first indexed object of the object class named oclass

Specified by:

getFirstObjectOfClass in interface State

Parameters:

oclass - the name of the object class for which the first indexed object should be returned.

Returns:

the first indexed object of the object class named oclass

getObjectClassesPresent

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

Description copied from interface: State

Returns a set of of the object class names for all object classes that have instantiated objects in this state.

Specified by:

getObjectClassesPresent in interface State

Returns:

a set of of the object class names for all object classes that have instantiated objects in this state.

getAllObjectsByClass

public java.util.List<java.util.List<ObjectInstance>> getAllObjectsByClass()

Description copied from interface: State

Returns a list of list of object instances, grouped by object class

Specified by:

getAllObjectsByClass in interface State

Returns:

a list of list of object instances, grouped by object class

getCompleteStateDescription

public java.lang.String getCompleteStateDescription()

Description copied from interface: State

Returns a string representation of this state using observable and hidden object instances.

Specified by:

getCompleteStateDescription in interface State

Returns:

a string representation of this state using observable and hidden object instances.

getAllUnsetAttributes

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllUnsetAttributes()

Description copied from interface: State

Returns a mapping from object instance names to the list of attributes names that have unset values.

Specified by:

getAllUnsetAttributes in interface State

Returns:

a mapping from object instance names to the list of attributes names that have unset values.

getCompleteStateDescriptionWithUnsetAttributesAsNull

public java.lang.String getCompleteStateDescriptionWithUnsetAttributesAsNull()

Description copied from interface: State

Returns a string description of the state with unset attribute values listed as null. This avoids runtime exceptions when attributes are unset and informs you which they are.

Specified by:

getCompleteStateDescriptionWithUnsetAttributesAsNull in interface State

Returns:

a string description of the state with unset attribute values listed as null.

getPossibleBindingsGivenParamOrderGroups

public java.util.List<java.util.List<java.lang.String>> getPossibleBindingsGivenParamOrderGroups(java.lang.String[] paramClasses,
                                                                                        java.lang.String[] paramOrderGroups)

Description copied from interface: State

Given an array of parameter object classes and an array of their corresponding parameter order groups, returns all possible object instance bindings to the parameters, excluding bindings that are equivalent due to the parameter order grouping.

Specified by:

getPossibleBindingsGivenParamOrderGroups in interface State

Parameters:

paramClasses - the name of object classes to which the bound object instances must belong

paramOrderGroups - the parameter order group names.

Returns:

A list of all possible object instance bindings for the parameters, were a binding is represented by a list of object instance names

setObjectsValue

public <T> State setObjectsValue(java.lang.String objectName,
                        java.lang.String attName,
                        T value)

Specified by:

setObjectsValue in interface State