burlap.oomdp.core

Class PropositionalFunction

java.lang.Object

burlap.oomdp.core.PropositionalFunction

Direct Known Subclasses:

BlockDude.AtExitPF, BlockDude.HoldingBlockPF, BlocksWorld.ClearPF, BlocksWorld.ColorPF, BlocksWorld.OnBlockPF, BlocksWorld.OnTablePF, ExampleGridWorld.AtLocation, FrostbiteDomain.IglooBuiltPF, FrostbiteDomain.InWaterPF, FrostbiteDomain.OnIcePF, FrostbiteDomain.OnPlatformPF, FrostbiteDomain.PlatformActivePF, GridWorldDomain.AtLocationPF, GridWorldDomain.WallToPF, LunarLanderDomain.OnPadPF, LunarLanderDomain.TouchGroundPF, LunarLanderDomain.TouchPadPF, LunarLanderDomain.TouchSurfacePF, MacroCellGridWorld.InMacroCellPF

public abstract class PropositionalFunction
extends java.lang.Object

The propositional function class defines evaluations of object instances in an OO-MDP state and are part of the definition for an OO-MDP domain. Propositional functions have an name to identify them, a set of parameters that they can take, and an optional propositional function class to which they belong. The parameters of a propositional function may also be assigned to order groups that indicate any symmetry in the evaluation of the propositional function. For instance, suppose we were to define a "touching" propositional function that specified whether two objects of a class representing blocks (called BLOCK) were touching in the world or not. For instance, we can imagine evaluating touching(block0, block1). Note that there is a symmetry in this evaluation; that is touching(block0, block1) = touching(block1, block0) in which case there is no point to evaluate both propositional functions. Specifying parameter order groups allows the designer to indicate these kinds of symmetry. If two parameters are set to the same order group, then it indicates that the evaluation for the propositional function will be the same for any order of parameters within that order group. If the order group between two parameters is different, then it indicates that the order of the parameters can change the evaluation. So, in the previous touching example, if the parameter order groups of the two parameters were both "p0", then it indicates that touching(block0, block1) = touching(block1, block0); if one parameter was assigned to order group "p0" and the other to "p1", then it is possible that touching(block0, block1) != touching(block1, block0). If the parameter order groups of parameters are not specified, then they are all assumed to be different.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected Domain	domain
protected java.lang.String	name
protected java.lang.String[]	parameterClasses
protected java.lang.String[]	parameterOrderGroup
protected java.lang.String	pfClass optional; allows propositional functions to be grouped by class names

Constructor Summary

Constructors

Constructor and Description
PropositionalFunction(java.lang.String name, Domain domain, java.lang.String parameterClasses) Initializes a propositional function with the given name, domain and parameter object classes.
PropositionalFunction(java.lang.String name, Domain domain, java.lang.String[] parameterClasses) Initializes a propositional function with the given name, domain and parameter object classes.
PropositionalFunction(java.lang.String name, Domain domain, java.lang.String[] parameterClasses, java.lang.String pfClassName) Initializes a propositional function with the given name, domain, parameter object classes, and propositional function class name.
PropositionalFunction(java.lang.String name, Domain domain, java.lang.String[] parameterClasses, java.lang.String[] parameterOrderGroup) Initializes a propositional function with the given name, domain, parameter object classes, and the parameter order groups of the parameters.
PropositionalFunction(java.lang.String name, Domain domain, java.lang.String[] parameterClasses, java.lang.String[] parameterOrderGroup, java.lang.String pfClassName) Initializes a propositional function with the given name, domain, parameter object classes, the parameter order groups of the parameters, and the propositional function class name.
PropositionalFunction(java.lang.String name, Domain domain, java.lang.String parameterClasses, java.lang.String pfClassName) Initializes a propositional function with the given name, domain, parameter object classes, and propositional function class name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<GroundedProp>	getAllGroundedPropsForState(State s) Returns all possible groundings of this PropositionalFunction for the given State
static java.util.List<GroundedProp>	getAllGroundedPropsFromPFList(java.util.List<PropositionalFunction> pfs, State s) Returns all possible groundings for all of the PropositionalFunctions in the provided list for the given State.
java.lang.String	getClassName() Returns the propositional function class name of this PF.
java.lang.String	getName() Returns the name of this propositional function.
java.lang.String[]	getParameterClasses() Returns the object classes of the parameters for this propositional function
java.lang.String[]	getParameterOrderGroups() Returns the parameter order group names for the parameters of this propositional function.
int	hashCode()
protected void	init(java.lang.String name, Domain domain, java.lang.String[] parameterClasses, java.lang.String[] parameterOrderGroup, java.lang.String pfClass)
abstract boolean	isTrue(State s, java.lang.String... params) Returns whether the propositional function is true for the given state with the given parameters This version is preferred to the comma delimited version.
void	setClassName(java.lang.String cn) Sets the class name for this propositional function.
boolean	somePFGroundingIsTrue(State s) Returns true if there existing a GroundedProp for the provided State that is in true in the State.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

domain

protected Domain domain

parameterClasses

protected java.lang.String[] parameterClasses

parameterOrderGroup

protected java.lang.String[] parameterOrderGroup

pfClass

protected java.lang.String pfClass

optional; allows propositional functions to be grouped by class names

Constructor Detail

PropositionalFunction

public PropositionalFunction(java.lang.String name,
                     Domain domain,
                     java.lang.String parameterClasses)

Initializes a propositional function with the given name, domain and parameter object classes. The domain will automatically have this propositional function added to its definition. Unique parameter order groups for each parameter are assumed.

Parameters:

name - the name of the propositional function

domain - the domain to which this propositional function should be connected.

parameterClasses - a comma delineated string specifying the name of object classes that the parameters must satisfy.

PropositionalFunction

public PropositionalFunction(java.lang.String name,
                     Domain domain,
                     java.lang.String parameterClasses,
                     java.lang.String pfClassName)

Initializes a propositional function with the given name, domain, parameter object classes, and propositional function class name. The domain will automatically have this propositional function added to its definition. Unique parameter order groups for each parameter are assumed.

Parameters:

name - the name of the propositional function

domain - the domain to which this propositional function should be connected.

parameterClasses - a comma delineated string specifying the name of object classes that the parameters must satisfy.

pfClassName - the name of the propositional function class to which this PF belongs.

PropositionalFunction

public PropositionalFunction(java.lang.String name,
                     Domain domain,
                     java.lang.String[] parameterClasses)

Initializes a propositional function with the given name, domain and parameter object classes. The domain will automatically have this propositional function added to its definition. Unique parameter order groups for each parameter are assumed.

Parameters:

name - the name of the propositional function

domain - the domain to which this propositional function should be connected.

parameterClasses - an array of strings specifying the name of object classes that the parameters must satisfy.

PropositionalFunction

public PropositionalFunction(java.lang.String name,
                     Domain domain,
                     java.lang.String[] parameterClasses,
                     java.lang.String pfClassName)

Initializes a propositional function with the given name, domain, parameter object classes, and propositional function class name. The domain will automatically have this propositional function added to its definition. Unique parameter order groups for each parameter are assumed.

Parameters:

name - the name of the propositional function

domain - the domain to which this propositional function should be connected.

parameterClasses - an array of strings specifying the name of object classes that the parameters must satisfy.

pfClassName - the name of the propositional function class to which this PF belongs.

PropositionalFunction

public PropositionalFunction(java.lang.String name,
                     Domain domain,
                     java.lang.String[] parameterClasses,
                     java.lang.String[] parameterOrderGroup)

Initializes a propositional function with the given name, domain, parameter object classes, and the parameter order groups of the parameters. The domain will automatically have this propositional function added to its definition.

Parameters:

name - the name of the propositional function

domain - the domain to which this propositional function should be connected.

parameterClasses - an array of strings specifying the name of object classes that the parameters must satisfy.

parameterOrderGroup - an array of strings specifying order group names for the parameters

PropositionalFunction

public PropositionalFunction(java.lang.String name,
                     Domain domain,
                     java.lang.String[] parameterClasses,
                     java.lang.String[] parameterOrderGroup,
                     java.lang.String pfClassName)

Initializes a propositional function with the given name, domain, parameter object classes, the parameter order groups of the parameters, and the propositional function class name. The domain will automatically have this propositional function added to its definition.

Parameters:

name - the name of the propositional function

domain - the domain to which this propositional function should be connected.

parameterClasses - an array of strings specifying the name of object classes that the parameters must satisfy.

parameterOrderGroup - an array of strings specifying order group names for the parameters

pfClassName - the name of the propositional function class to which this PF belongs.

Method Detail

init

protected final void init(java.lang.String name,
        Domain domain,
        java.lang.String[] parameterClasses,
        java.lang.String[] parameterOrderGroup,
        java.lang.String pfClass)

getName

public final java.lang.String getName()

Returns the name of this propositional function.

Returns:

the name of this propositional function.

getParameterClasses

public final java.lang.String[] getParameterClasses()

Returns the object classes of the parameters for this propositional function

Returns:

the object classes of the parameters for this propositional function

getParameterOrderGroups

public final java.lang.String[] getParameterOrderGroups()

Returns the parameter order group names for the parameters of this propositional function.

Returns:

the parameter order group names for the parameters of this propositional function.

setClassName

public final void setClassName(java.lang.String cn)

Sets the class name for this propositional function.

Parameters:

cn - the propositional function class name to which this PF should be assigned.

getClassName

public final java.lang.String getClassName()

Returns the propositional function class name of this PF.

Returns:

the propositional function class name of this PF.

isTrue

public abstract boolean isTrue(State s,
             java.lang.String... params)

Returns whether the propositional function is true for the given state with the given parameters This version is preferred to the comma delimited version.

Parameters:

s - the state that is being checked

params - the parameters being passed in to the propositional function

Returns:

whether the propositional function is true

getAllGroundedPropsFromPFList

public static java.util.List<GroundedProp> getAllGroundedPropsFromPFList(java.util.List<PropositionalFunction> pfs,
                                                         State s)

Returns all possible groundings for all of the PropositionalFunctions in the provided list for the given State.

Parameters:

pfs - The list of PropositionalFunctions for which all groundings will be returned.

s - the State in which the groundings should be produced.

Returns:

a List of all possible groundings for all of the PropositionalFunctions in the provided list for the given State

getAllGroundedPropsForState

public java.util.List<GroundedProp> getAllGroundedPropsForState(State s)

Returns all possible groundings of this PropositionalFunction for the given State

Parameters:

s - the State in which all groundings will be returned

Returns:

a List of all possible groundings of this PropositionalFunction for the given State

somePFGroundingIsTrue

public boolean somePFGroundingIsTrue(State s)

Returns true if there existing a GroundedProp for the provided State that is in true in the State.

Parameters:

s - the State to test.

Returns:

true if there existing a GroundedProp for the provided State that is in true in the State; false otherwise.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object