burlap.oomdp.core.states

Class ImmutableState

java.lang.Object

burlap.oomdp.core.states.OOMDPState

burlap.oomdp.core.states.ImmutableState

All Implemented Interfaces:

ImmutableStateInterface, State, java.lang.Iterable<ImmutableObjectInstance>

public final class ImmutableState
extends OOMDPState
implements ImmutableStateInterface

An immutable state cannot be changed (nor subclassed). It is particularly useful when memory management is crucial, as copies are only created when actual changes are applied to an ImmutableState (copy on write). If many objects are altered during a grounded action update, it is recommended to use the bulk modification methods (replaceAllObjects, addAllObjects, etc).

Author:

Stephen Brawner, James MacGlashan

Constructor Summary

Constructors

Constructor and Description
ImmutableState()
ImmutableState(com.google.common.collect.ImmutableList<ImmutableObjectInstance> objects, gnu.trove.map.hash.TObjectIntHashMap<java.lang.String> objectClassMap, com.google.common.collect.ImmutableList<gnu.trove.list.array.TIntArrayList> objectIndexByTrueClass, gnu.trove.map.hash.TObjectIntHashMap<java.lang.String> objectMap, int hashCode)
ImmutableState(java.util.List<ImmutableObjectInstance> objects, gnu.trove.map.hash.TObjectIntHashMap<java.lang.String> objectClassMap)
ImmutableState(State s) Constructs an immutable copy from any state object.

Method Summary

Methods

Modifier and Type	Method and Description
ImmutableState	addAllObjects(java.util.Collection<ObjectInstance> objectsToAdd) Adds the collection of objects to the state
ImmutableState	addObject(ObjectInstance object) Adds object instance o to this state.
ImmutableState	copy() This method doesn't actually copy.
boolean	equals(java.lang.Object other)
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
com.google.common.collect.ImmutableList<ImmutableObjectInstance>	getImmutableObjects()
ObjectInstance	getObject(int i)
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<ObjectInstance>	getObservableObjects() Returns the list of observable object instances in this state.
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.
java.util.List<java.util.List<ObjectInstance>>	getPossibleObjectBindingsGivenParamOrderGroups(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.
int	hashCode()
boolean	isHashed()
java.util.Iterator<ImmutableObjectInstance>	iterator()
int	numObservableObjects() Returns the number of observable object instances in this state.
int	numTotalObjects() Returns the number of observable and hidden object instances in this state.
ImmutableState	removeAllObjects(java.util.Collection<ObjectInstance> objectsToRemove) Removes the collection of objects from the state
ImmutableState	removeObject(ObjectInstance object) Removes the object instance o from this state.
ImmutableState	removeObject(java.lang.String objectName) 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.
ImmutableState	replaceAllObjects(java.util.List<ImmutableObjectInstance> objectsToRemove, java.util.List<ImmutableObjectInstance> objectsToAdd)
ImmutableState	replaceAllObjectsUnsafe(java.util.List<ObjectInstance> objectsToAdd)
ImmutableState	replaceAndHash(com.google.common.collect.ImmutableList<ImmutableObjectInstance> objects, int code)
ImmutableState	replaceObject(ObjectInstance objectToReplace, ObjectInstance newObject)
<T> State	setObjectsValue(java.lang.String objectName, java.lang.String attName, T value) Sets an object's value.

Methods inherited from class burlap.oomdp.core.states.OOMDPState

renameObject, toString

Methods inherited from class java.lang.Object

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

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

renameObject

Constructor Detail

ImmutableState

public ImmutableState()

ImmutableState

public ImmutableState(State s)

Constructs an immutable copy from any state object. All underlying lists are also copied so changes to the original state are not reflected in this copy.

Parameters:

s - the source state from which this state will be initialized.

ImmutableState

public ImmutableState(java.util.List<ImmutableObjectInstance> objects,
              gnu.trove.map.hash.TObjectIntHashMap<java.lang.String> objectClassMap)

ImmutableState

public ImmutableState(com.google.common.collect.ImmutableList<ImmutableObjectInstance> objects,
              gnu.trove.map.hash.TObjectIntHashMap<java.lang.String> objectClassMap,
              com.google.common.collect.ImmutableList<gnu.trove.list.array.TIntArrayList> objectIndexByTrueClass,
              gnu.trove.map.hash.TObjectIntHashMap<java.lang.String> objectMap,
              int hashCode)

Method Detail

copy

public ImmutableState copy()

This method doesn't actually copy. This implementation only copies on write.

Specified by:

copy in interface State

Returns:

the same state.

replaceAndHash

public final ImmutableState replaceAndHash(com.google.common.collect.ImmutableList<ImmutableObjectInstance> objects,
                            int code)

Specified by:

replaceAndHash in interface ImmutableStateInterface

addObject

public final ImmutableState addObject(ObjectInstance object)

Description copied from interface: State

Adds object instance o to this state.

Specified by:

addObject in interface State

Parameters:

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

Returns:

the modified state

addAllObjects

public final ImmutableState addAllObjects(java.util.Collection<ObjectInstance> objectsToAdd)

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 final ImmutableState removeObject(java.lang.String objectName)

Description copied from interface: State

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

Specified by:

removeObject in interface State

Parameters:

objectName - the name of the object instance to remove.

Returns:

the modified state

removeObject

public final ImmutableState removeObject(ObjectInstance object)

Description copied from interface: State

Removes the object instance o from this state.

Specified by:

removeObject in interface State

Parameters:

object - the object instance to remove from this state.

Returns:

the modified state

removeAllObjects

public final ImmutableState removeAllObjects(java.util.Collection<ObjectInstance> objectsToRemove)

Description copied from interface: State

Removes the collection of objects from the state

Specified by:

removeAllObjects in interface State

Returns:

the modified state

replaceObject

public final ImmutableState replaceObject(ObjectInstance objectToReplace,
                           ObjectInstance newObject)

Specified by:

replaceObject in interface ImmutableStateInterface

replaceAllObjects

public final ImmutableState replaceAllObjects(java.util.List<ImmutableObjectInstance> objectsToRemove,
                               java.util.List<ImmutableObjectInstance> objectsToAdd)

Specified by:

replaceAllObjects in interface ImmutableStateInterface

replaceAllObjectsUnsafe

public final ImmutableState replaceAllObjectsUnsafe(java.util.List<ObjectInstance> objectsToAdd)

renameObject

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

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

setObjectsValue

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

Description copied from class: OOMDPState

Sets an object's value.

Specified by:

setObjectsValue in interface State

Overrides:

setObjectsValue in class OOMDPState

getObjectMatchingTo

public 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. 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.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

numTotalObjects

public int numTotalObjects()

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

Specified by:

numTotalObjects in interface State

Returns:

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

numObservableObjects

public int numObservableObjects()

Returns the number of observable object instances in this state.

Returns:

the number of observable object instances in this state.

getObject

public ObjectInstance getObject(int i)

getObject

public ObjectInstance getObject(java.lang.String oname)

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

getObservableObjects

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

Returns the list of observable object instances in this state.

Returns:

the list of observable object instances in this state.

getAllObjects

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

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.

getImmutableObjects

public com.google.common.collect.ImmutableList<ImmutableObjectInstance> getImmutableObjects()

Specified by:

getImmutableObjects in interface ImmutableStateInterface

getObjectsOfClass

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

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)

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

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

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

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.

getPossibleObjectBindingsGivenParamOrderGroups

public java.util.List<java.util.List<ObjectInstance>> getPossibleObjectBindingsGivenParamOrderGroups(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.

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

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

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.

isHashed

public boolean isHashed()

Specified by:

isHashed in interface ImmutableStateInterface

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

iterator

public java.util.Iterator<ImmutableObjectInstance> iterator()

Specified by:

iterator in interface java.lang.Iterable<ImmutableObjectInstance>