burlap.oomdp.statehashing

Class HashableObject

java.lang.Object

burlap.oomdp.statehashing.HashableObject

All Implemented Interfaces:

ObjectInstance

Direct Known Subclasses:

HashableObject.CachedHashableObject, ImmutableHashableObjectFactory.ImmutableHashableObject

public class HashableObject
extends java.lang.Object
implements ObjectInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashableObject.CachedHashableObject

Field Summary

Fields

Modifier and Type	Field and Description
ObjectInstance	source

Constructor Summary

Constructors

Constructor and Description
HashableObject(ObjectInstance source)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectInstance	addAllRelationalTargets(java.lang.String attName, java.util.Collection<java.lang.String> targets) Adds all relational targets to the attribute attName for this object instance.
ObjectInstance	addRelationalTarget(java.lang.String attName, java.lang.String target) Sets/adds the relational value of the attribute named attName for this object instance.
java.lang.StringBuilder	buildObjectDescription(java.lang.StringBuilder builder)
ObjectInstance	clearRelationalTargets(java.lang.String attName) Clears all the relational value targets of the attribute named attName for this object instance.
ObjectInstance	copy() Creates and returns a new object instance that is a copy of this object instance's values, if mutable the copy should be deep
java.util.Set<java.lang.String>	getAllRelationalTargets(java.lang.String attName) Returns the set of all relational targets to which the relational attribute named attName is set.
boolean	getBooleanValForAttribute(java.lang.String attName) Returns the boolean value of the attribute (only defined for boolean attributes, int, and disc values).
java.lang.String	getClassName() Returns the name of this object instance's object class
double[]	getDoubleArrayValForAttribute(java.lang.String attName) Returns the int array value of the attribute (only defined for int array attributes).
double[]	getFeatureVec() Returns a double vector of all the observable values in this object instance.
int[]	getIntArrayValForAttribute(java.lang.String attName) Returns the int array value of the attribute (only defined for int array attributes).
int	getIntValForAttribute(java.lang.String attName) Returns the int value assignment for the discrete-valued attribute named attName.
java.lang.String	getName() Returns the name identifier of this object instance
double[]	getNormalizedFeatureVec() Returns a normalized double vector of all the observable values in this object instance.
double	getNumericValForAttribute(java.lang.String attName) Returns the double value for the attribute named attType.
ObjectClass	getObjectClass() Returns this object instance's object class
java.lang.String	getObjectDescription() Returns a string representation of this object including its name and value attribute value assignment.
java.lang.String	getObjectDescriptionWithNullForUnsetAttributes() Returns a string description of the object with the unset attribute values listed as null.
double	getRealValForAttribute(java.lang.String attName) Returns the double value assignment for the real-valued attribute named attName.
java.lang.String	getStringValForAttribute(java.lang.String attName) Returns the string value representation for the attribute named attName.
Value	getValueForAttribute(java.lang.String attName) Returns the Value object assignment for the attribute named attName
java.util.List<Value>	getValues() Returns the list of value object assignments to all of this object instance's attributes.
ObjectInstance	removeRelationalTarget(java.lang.String attName, java.lang.String target) Removes an object target from the specified relational attribute.
ObjectInstance	setName(java.lang.String name) Sets the name of this object instance.
ObjectInstance	setValue(java.lang.String attName, boolean v) Sets the value of the attribute named attName for this object instance.
ObjectInstance	setValue(java.lang.String attName, double v) Sets the value of the attribute named attName for this object instance.
ObjectInstance	setValue(java.lang.String attName, double[] v) Sets the value of the attribute named attName for this object instance.
ObjectInstance	setValue(java.lang.String attName, int v) Sets the value of the attribute named attName for this object instance.
ObjectInstance	setValue(java.lang.String attName, int[] v) Sets the value of the attribute named attName for this object instance.
ObjectInstance	setValue(java.lang.String attName, java.lang.String v) Sets the value of the attribute named attName for this object instance.
<T> ObjectInstance	setValue(java.lang.String attName, T v)
java.util.List<java.lang.String>	unsetAttributes() Returns a list of the names of Attributes that have unset values
boolean	valueEquals(ObjectInstance obj) Returns true if the value assignments in this object instance are the same as they are in the target object instance.

Methods inherited from class java.lang.Object

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

Field Detail

source

public ObjectInstance source

Constructor Detail

HashableObject

public HashableObject(ObjectInstance source)

Method Detail

copy

public ObjectInstance copy()

Description copied from interface: ObjectInstance

Creates and returns a new object instance that is a copy of this object instance's values, if mutable the copy should be deep

Specified by:

copy in interface ObjectInstance

Returns:

a new object instance that is a copy of this object instance

setName

public ObjectInstance setName(java.lang.String name)

Description copied from interface: ObjectInstance

Sets the name of this object instance.

Specified by:

setName in interface ObjectInstance

Parameters:

name - the name for this object instance.

setValue

public <T> ObjectInstance setValue(java.lang.String attName,
                          T v)

Specified by:

setValue in interface ObjectInstance

setValue

public ObjectInstance setValue(java.lang.String attName,
                      java.lang.String v)

Description copied from interface: ObjectInstance

Sets the value of the attribute named attName for this object instance.

Specified by:

setValue in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value is to be set.

v - the string rep value to which the attribute of this object instance should be set.

setValue

public ObjectInstance setValue(java.lang.String attName,
                      double v)

Description copied from interface: ObjectInstance

Sets the value of the attribute named attName for this object instance.

Specified by:

setValue in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value is to be set.

v - the double rep value to which the attribute of this object instance should be set.

setValue

public ObjectInstance setValue(java.lang.String attName,
                      int v)

Description copied from interface: ObjectInstance

Sets the value of the attribute named attName for this object instance.

Specified by:

setValue in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value is to be set.

v - the int rep value to which the attribute of this object instance should be set.

setValue

public ObjectInstance setValue(java.lang.String attName,
                      boolean v)

Description copied from interface: ObjectInstance

Sets the value of the attribute named attName for this object instance.

Specified by:

setValue in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value is to be set.

v - the int rep value to which the attribute of this object instance should be set.

setValue

public ObjectInstance setValue(java.lang.String attName,
                      int[] v)

Description copied from interface: ObjectInstance

Sets the value of the attribute named attName for this object instance.

Specified by:

setValue in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value is to be set.

v - the int array rep value to which the attribute of this object instance should be set.

setValue

public ObjectInstance setValue(java.lang.String attName,
                      double[] v)

Description copied from interface: ObjectInstance

Sets the value of the attribute named attName for this object instance.

Specified by:

setValue in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value is to be set.

v - the double array rep value to which the attribute of this object instance should be set.

addRelationalTarget

public ObjectInstance addRelationalTarget(java.lang.String attName,
                                 java.lang.String target)

Description copied from interface: ObjectInstance

Sets/adds the relational value of the attribute named attName for this object instance. If the attribute is a multi-target relational attribute, then this value is added to the target list.

Specified by:

addRelationalTarget in interface ObjectInstance

Parameters:

attName - the name of the relational attribute that will have a relational target added/set

target - the name of the object reference that is to be added as a target.

addAllRelationalTargets

public ObjectInstance addAllRelationalTargets(java.lang.String attName,
                                     java.util.Collection<java.lang.String> targets)

Description copied from interface: ObjectInstance

Adds all relational targets to the attribute attName for this object instance. For a single-target relational attribute, the value that is ultimately set depends on the iteration order of iterable.

Specified by:

addAllRelationalTargets in interface ObjectInstance

Parameters:

attName - the name of the relational attribute that will have a relational target added/set

targets - the names of the object references that are to be added as a targets.

clearRelationalTargets

public ObjectInstance clearRelationalTargets(java.lang.String attName)

Description copied from interface: ObjectInstance

Clears all the relational value targets of the attribute named attName for this object instance.

Specified by:

clearRelationalTargets in interface ObjectInstance

removeRelationalTarget

public ObjectInstance removeRelationalTarget(java.lang.String attName,
                                    java.lang.String target)

Description copied from interface: ObjectInstance

Removes an object target from the specified relational attribute.

Specified by:

removeRelationalTarget in interface ObjectInstance

Parameters:

attName - the name of the relational attribute from which the target should be removed.

target - the target to remove from the relational attribute value.

getName

public java.lang.String getName()

Description copied from interface: ObjectInstance

Returns the name identifier of this object instance

Specified by:

getName in interface ObjectInstance

Returns:

the name identifier of this object instance

getObjectClass

public ObjectClass getObjectClass()

Description copied from interface: ObjectInstance

Returns this object instance's object class

Specified by:

getObjectClass in interface ObjectInstance

Returns:

this object instance's object class

getClassName

public java.lang.String getClassName()

Description copied from interface: ObjectInstance

Returns the name of this object instance's object class

Specified by:

getClassName in interface ObjectInstance

Returns:

the name of this object instance's object class

getValueForAttribute

public Value getValueForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the Value object assignment for the attribute named attName

Specified by:

getValueForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the Value object assignment for the attribute named attName

getRealValForAttribute

public double getRealValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the double value assignment for the real-valued attribute named attName. Will throw a runtime exception is the attribute named attName is not of type REAL or REALUNBOUNDED

Specified by:

getRealValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the double value assignment for the real-valued attribute named attName.

getNumericValForAttribute

public double getNumericValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the double value for the attribute named attType. This method differs from the ObjectInstance.getRealValForAttribute(String) method because it will cast the int values for non real attributes to double values and will not throw an exception. Note that if this method is called on relational attributes, it will return 0., where as attributes like Attribute.AttributeType.INT and Attribute.AttributeType.DISC will cast their int values to doubles.

Specified by:

getNumericValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

a double value assignment for the attribute; casting occurs if the attribute is not real-valued.

getStringValForAttribute

public java.lang.String getStringValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the string value representation for the attribute named attName.

Specified by:

getStringValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the string value assignment for the attribute named attName.

getIntValForAttribute

public int getIntValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the int value assignment for the discrete-valued attribute named attName. Will throw a runtime exception is the attribute named attName is not of type DISC

Specified by:

getIntValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

the int value assignment for the discrete-valued attribute named attName.

getAllRelationalTargets

public java.util.Set<java.lang.String> getAllRelationalTargets(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the set of all relational targets to which the relational attribute named attName is set. If attName is a single target relational attribute, then it will return a set of at most cardinality one.

Specified by:

getAllRelationalTargets in interface ObjectInstance

Parameters:

attName - attName the name of the attribute whose value should be returned

Returns:

the set of all object instance targets (indicated by their object instance name) for the relational-valued attribute named attName.

getBooleanValForAttribute

public boolean getBooleanValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the boolean value of the attribute (only defined for boolean attributes, int, and disc values).

Specified by:

getBooleanValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned

Returns:

true if the value for the attribute evaluates to true, false otherwise.

getIntArrayValForAttribute

public int[] getIntArrayValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the int array value of the attribute (only defined for int array attributes).

Specified by:

getIntArrayValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned.

Returns:

the int array value.

getDoubleArrayValForAttribute

public double[] getDoubleArrayValForAttribute(java.lang.String attName)

Description copied from interface: ObjectInstance

Returns the int array value of the attribute (only defined for int array attributes).

Specified by:

getDoubleArrayValForAttribute in interface ObjectInstance

Parameters:

attName - the name of the attribute whose value should be returned.

Returns:

the int array value.

getValues

public java.util.List<Value> getValues()

Description copied from interface: ObjectInstance

Returns the list of value object assignments to all of this object instance's attributes.

Specified by:

getValues in interface ObjectInstance

Returns:

the list of value object assignments to all of this object instance's attributes.

unsetAttributes

public java.util.List<java.lang.String> unsetAttributes()

Description copied from interface: ObjectInstance

Returns a list of the names of Attributes that have unset values

Specified by:

unsetAttributes in interface ObjectInstance

Returns:

a list of the names of attributes that have unset values

getObjectDescription

public java.lang.String getObjectDescription()

Description copied from interface: ObjectInstance

Returns a string representation of this object including its name and value attribute value assignment.

Specified by:

getObjectDescription in interface ObjectInstance

Returns:

a string representation of this object including its name and value attribute value assignment.

buildObjectDescription

public java.lang.StringBuilder buildObjectDescription(java.lang.StringBuilder builder)

Specified by:

buildObjectDescription in interface ObjectInstance

getObjectDescriptionWithNullForUnsetAttributes

public java.lang.String getObjectDescriptionWithNullForUnsetAttributes()

Description copied from interface: ObjectInstance

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

Specified by:

getObjectDescriptionWithNullForUnsetAttributes in interface ObjectInstance

Returns:

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

getFeatureVec

public double[] getFeatureVec()

Description copied from interface: ObjectInstance

Returns a double vector of all the observable values in this object instance. Discrete values have their int stored valued converted to a double for this array. This method will throw a runtime exception if the object instance includes relational values. This method may be useful if objects need to be indexed in data structures like kd-trees.

Specified by:

getFeatureVec in interface ObjectInstance

Returns:

a double vector of all the observable values in this object instance.

getNormalizedFeatureVec

public double[] getNormalizedFeatureVec()

Description copied from interface: ObjectInstance

Returns a normalized double vector of all the observable values in this object instance. This method relies on the lowerlims and upperlims being set for the corresponding attribute. Furthermore, this method will throw a runtime exception if the object instance includes attributes that are *not* type REAL or INT.

Specified by:

getNormalizedFeatureVec in interface ObjectInstance

Returns:

a normalized double vector of all the observable values in this object instance.

valueEquals

public boolean valueEquals(ObjectInstance obj)

Description copied from interface: ObjectInstance

Returns true if the value assignments in this object instance are the same as they are in the target object instance. This may differ from a normal equals because it does not require the object instance name identifiers to be the same.

Specified by:

valueEquals in interface ObjectInstance

Parameters:

obj - the object instance against which this object instance should be compared.

Returns:

true if this object instance and obj have identical value assignments; false otherwise.