burlap.mdp.core.oo.state

Class OOStateUtilities

java.lang.Object

burlap.mdp.core.oo.state.OOStateUtilities

public class OOStateUtilities
extends java.lang.Object

A class with various static utility methods for working with OOState instances.

Author:

James MacGlashan.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Object>	flatStateKeys(OOState s) Returns all object-variable_key keys.
static OOVariableKey	generateKey(java.lang.Object key) Generates an OOVariableKey from a key that is either already an OOVariableKey or a string representation of one.
static java.lang.Object	get(OOState s, java.lang.Object variableKey) Returns the value of an ObjectInstance variable, where the key is a OOVariableKey or a string representation of an OOVariableKey.
static java.util.List<java.util.List<java.lang.String>>	getPossibleBindingsGivenParamOrderGroups(OOState s, java.lang.String[] paramClasses, java.lang.String[] paramOrderGroups) Returns all possible object assignments from a OOState for a given set of parameters that are typed to OO-MDP object classes.
static java.util.Set<java.lang.String>	objectClassesPresent(OOState s) Returns the set of object classes that have instantiated ObjectInstances in the input state.
static <T extends ObjectInstance> int	objectIndexWithName(java.util.List<T> objects, java.lang.String name) Returns the index of an ObjectInstance with the given name in a list
static java.lang.String	objectInstanceToString(ObjectInstance o) A common approach for turning an ObjectInstance into a string representation.
static java.util.Map<java.lang.String,java.util.List<ObjectInstance>>	objectsByClass(OOState s) Returns a list of list of ObjectInstances where the objects are organized by their class.
static <T extends ObjectInstance> T	objectWithName(java.util.List<T> objects, java.lang.String name) Returns the ObjectInstance with the given name
static java.lang.String	ooStateToString(OOState s) A common approach for turning an OOState into a string representation.

Methods inherited from class java.lang.Object

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

Method Detail

objectWithName

public static <T extends ObjectInstance> T objectWithName(java.util.List<T> objects,
                                                          java.lang.String name)

Returns the ObjectInstance with the given name

Type Parameters:

T - the type of the ObjectInstance

Parameters:

objects - a list ObjectInstances

name - the name of the query ObjectInstance

Returns:

the found ObjectInstance or null if it is not found

objectIndexWithName

public static <T extends ObjectInstance> int objectIndexWithName(java.util.List<T> objects,
                                                                 java.lang.String name)

Returns the index of an ObjectInstance with the given name in a list

Type Parameters:

T - the type of the ObjectInstance

Parameters:

objects - a list ObjectInstances

name - the name of the query ObjectInstance

Returns:

the index of the found ObjectInstance or -1 if it is not found

flatStateKeys

public static java.util.List<java.lang.Object> flatStateKeys(OOState s)

Returns all object-variable_key keys. Useful for implementing the State.variableKeys() method.

Parameters:

s - the input state

Returns:

the list of all keys.

get

public static java.lang.Object get(OOState s,
                                   java.lang.Object variableKey)

Returns the value of an ObjectInstance variable, where the key is a OOVariableKey or a string representation of an OOVariableKey.

Parameters:

s - the input state

variableKey - the object-variable key

Returns:

the value of the object variable.

generateKey

public static OOVariableKey generateKey(java.lang.Object key)

Generates an OOVariableKey from a key that is either already an OOVariableKey or a string representation of one.

Parameters:

key - an OOVariableKey or a string representation of one.

Returns:

the corresponding OOVariableKey

objectsByClass

public static java.util.Map<java.lang.String,java.util.List<ObjectInstance>> objectsByClass(OOState s)

Returns a list of list of ObjectInstances where the objects are organized by their class.

Parameters:

s - the input OOState

Returns:

the ObjectInstances organized by their class

objectClassesPresent

public static java.util.Set<java.lang.String> objectClassesPresent(OOState s)

Returns the set of object classes that have instantiated ObjectInstances in the input state.

Parameters:

s - the input state

Returns:

the set of object classes that have instantiated ObjectInstances in the input state.

ooStateToString

public static java.lang.String ooStateToString(OOState s)

A common approach for turning an OOState into a string representation. Useful for implementing Object.toString() methods.

Parameters:

s - the input OOState

Returns:

the string representation

objectInstanceToString

public static java.lang.String objectInstanceToString(ObjectInstance o)

A common approach for turning an ObjectInstance into a string representation. Useful for implementing the Object.toString() method.

Parameters:

o - the input ObjectInstance

Returns:

the string representation

getPossibleBindingsGivenParamOrderGroups

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

Returns all possible object assignments from a OOState for a given set of parameters that are typed to OO-MDP object classes. For example, parameters for a PropositionalFunction or ObjectParameterizedAction.

Parameters:

s - the OOState

paramClasses - the object class type for a parameter array that needs object assignments

paramOrderGroups - indicates the order group of a parameter. Parameters in the same order group can have their object assignments shuffled without affecting the evaluation. By default, you probably can have a unique order group for each parameters

Returns:

the list of all object assignments, where each object assignment is a list of object names of equal size to the input parameters.