burlap.oomdp.core.states

Interface ImmutableStateInterface

All Superinterfaces:

java.lang.Iterable<ImmutableObjectInstance>, State

All Known Implementing Classes:

FixedSizeImmutableState, ImmutableState

public interface ImmutableStateInterface
extends State, java.lang.Iterable<ImmutableObjectInstance>

A state that implements this interface implies that it itself is immutable and the ObjectInstances it uses are immutable. An immutable state is one that doesn't allow you to make modifications to its underlying data structure, by using the getObject, setValue paradigm. Any changes to a state will result in a copy that reflects those changes. The original state will not be modified.

Author:

Stephen Brawner

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<ImmutableObjectInstance>	getImmutableObjects()
boolean	isHashed()
ImmutableStateInterface	replaceAllObjects(java.util.List<ImmutableObjectInstance> objectsToRemove, java.util.List<ImmutableObjectInstance> objectsToAdd)
ImmutableStateInterface	replaceAndHash(com.google.common.collect.ImmutableList<ImmutableObjectInstance> objects, int code)
ImmutableStateInterface	replaceObject(ObjectInstance objectToReplace, ObjectInstance newObject)

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

addAllObjects, addObject, copy, getAllObjects, getAllObjectsByClass, getAllUnsetAttributes, getCompleteStateDescription, getCompleteStateDescriptionWithUnsetAttributesAsNull, getFirstObjectOfClass, getObject, getObjectClassesPresent, getObjectMatchingTo, getObjectsOfClass, getPossibleBindingsGivenParamOrderGroups, numTotalObjects, removeAllObjects, removeObject, removeObject, renameObject, renameObject, setObjectsValue

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

replaceAndHash

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

replaceObject

ImmutableStateInterface replaceObject(ObjectInstance objectToReplace,
                                    ObjectInstance newObject)

replaceAllObjects

ImmutableStateInterface replaceAllObjects(java.util.List<ImmutableObjectInstance> objectsToRemove,
                                        java.util.List<ImmutableObjectInstance> objectsToAdd)

getImmutableObjects

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

isHashed

boolean isHashed()