burlap.oomdp.statehashing

Class DiscretizingMaskedHashableStateFactory

java.lang.Object

burlap.oomdp.statehashing.SimpleHashableStateFactory

burlap.oomdp.statehashing.MaskedHashableStateFactory

burlap.oomdp.statehashing.DiscretizingMaskedHashableStateFactory

All Implemented Interfaces:

HashableStateFactory

public class DiscretizingMaskedHashableStateFactory
extends MaskedHashableStateFactory

A class for producing HashableState objects that computes hash codes and tests for State equality by discretizing real-valued attributes and by masking (ignoring) either Attributes and/or ObjectClasses. For more information on how discretization is performed, see the DiscretizingHashableStateFactory class documentation and for more information on how Attribute/ObjectClass masking is performed see the MaskedHashableStateFactory class documentation.

This class extends SimpleHashableStateFactory, which means it can be toggled to to be object identifier/name independent or dependent and can be set to use HashableState instances that hash their hash code or not. See the SimpleHashableStateFactory class documentation for more information on those features.

Author:

James MacGlashan.

Nested Class Summary

Nested classes/interfaces inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

SimpleHashableStateFactory.AttClass, SimpleHashableStateFactory.SimpleCachedHashableState, SimpleHashableStateFactory.SimpleHashableState, SimpleHashableStateFactory.SimpleHashableStateInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Double>	attributeWiseMultiples The multiples to use for specific attributes
protected double	defaultMultiple The default multiple to use for any continuous attributes that have not been specifically set.

Fields inherited from class burlap.oomdp.statehashing.MaskedHashableStateFactory

maskedAttributes, maskedObjectClasses

Fields inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

identifierIndependent, useCached

Constructor Summary

Constructors

Constructor and Description
DiscretizingMaskedHashableStateFactory(boolean identifierIndependent, boolean useCached, double defaultMultiple) Initializes.
DiscretizingMaskedHashableStateFactory(boolean identifierIndependent, boolean useCached, double defaultMultiple, boolean maskNamesAreForAttributes, java.lang.String... masks) Initializes with a specified attribute or object class mask.
DiscretizingMaskedHashableStateFactory(boolean identifierIndependent, double defaultMultiple) Initializes with non hash code caching and object class or attribute masks
DiscretizingMaskedHashableStateFactory(double defaultMultiple) Initializes with object identifier independence, no hash code caching and object class or attribute masks.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFloorDiscretizingMultipleFor(java.lang.String attributeName, double nearestMultipleValue) Sets the multiple to use for discretization for the attribute with the specified name.
protected void	appendHashcodeForValue(org.apache.commons.lang3.builder.HashCodeBuilder hashCodeBuilder, Value v) Appends the hash code for the given Value to the HashCodeBuilder
protected static int	intMultiples(double mult, double num) Returns int result of num / mult; that is, (int)(num / mult).
void	setDefaultFloorDiscretizingMultiple(double defaultMultiple) Sets the default multiple to use for continuous attributes that do not have specific multiples set for them.
protected boolean	valuesEqual(Value v1, Value v2) Returns whether two values are equal.

Methods inherited from class burlap.oomdp.statehashing.MaskedHashableStateFactory

addAttributeMasks, addObjectClassMasks, clearAllAttributeMasks, clearAllObjectClassMasks, computeHashCode, computeHashCode, getMaskedAttributes, getMaskedObjectClasses, identifierDependentEquals, identifierIndependentEquals, objectValuesEqual, removeAttributeMasks, removeObjectClassMasks

Methods inherited from class burlap.oomdp.statehashing.SimpleHashableStateFactory

getAttClass, hashState, objectIdentifierIndependent, statesEqual

Methods inherited from class java.lang.Object

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

Field Detail

attributeWiseMultiples

protected java.util.Map<java.lang.String,java.lang.Double> attributeWiseMultiples

The multiples to use for specific attributes

defaultMultiple

protected double defaultMultiple

The default multiple to use for any continuous attributes that have not been specifically set.

Constructor Detail

DiscretizingMaskedHashableStateFactory

public DiscretizingMaskedHashableStateFactory(double defaultMultiple)

Initializes with object identifier independence, no hash code caching and object class or attribute masks.

Parameters:

defaultMultiple - The default multiple to use for any continuous attributes that have not been specifically set. The default is 1.0, which corresponds to integer floor discretization.

DiscretizingMaskedHashableStateFactory

public DiscretizingMaskedHashableStateFactory(boolean identifierIndependent,
                                      double defaultMultiple)

Initializes with non hash code caching and object class or attribute masks

Parameters:

identifierIndependent - if true then state evaluations are object identifier independent; if false then dependent.

defaultMultiple - The default multiple to use for any continuous attributes that have not been specifically set. The default is 1.0, which corresponds to integer floor discretization.

DiscretizingMaskedHashableStateFactory

public DiscretizingMaskedHashableStateFactory(boolean identifierIndependent,
                                      boolean useCached,
                                      double defaultMultiple)

Initializes.

Parameters:

identifierIndependent - if true then state evaluations are object identifier independent; if false then dependent.

useCached - if true then the hash code for each produced HashableState will be cached; if false then they will not be cached.

defaultMultiple - The default multiple to use for any continuous attributes that have not been specifically set. corresponds to integer floor discretization.

DiscretizingMaskedHashableStateFactory

public DiscretizingMaskedHashableStateFactory(boolean identifierIndependent,
                                      boolean useCached,
                                      double defaultMultiple,
                                      boolean maskNamesAreForAttributes,
                                      java.lang.String... masks)

Initializes with a specified attribute or object class mask.

Parameters:

identifierIndependent - if true then state evaluations are object identifier independent; if false then dependent.

useCached - if true then the hash code for each produced HashableState will be cached; if false then they will not be cached.

defaultMultiple - The default multiple to use for any continuous attributes that have not been specifically set.

maskNamesAreForAttributes - whether the specified masks are masks for attributes or object classes. True for attributes, false for object classes.

masks - the names of the Attributes or ObjectClass that will be masks (ignored from state hashing and equality checks)

Method Detail

addFloorDiscretizingMultipleFor

public void addFloorDiscretizingMultipleFor(java.lang.String attributeName,
                                   double nearestMultipleValue)

Sets the multiple to use for discretization for the attribute with the specified name. See the documentation of this class for more information on how the multiple works. In short, continuous values will be floored to the greatest value that is a multiple of the multiple given and less than or equal to the true value.

Parameters:

attributeName - the name of the attribute whose discretization multiple is being set.

nearestMultipleValue - the multiple to which values are floored.

setDefaultFloorDiscretizingMultiple

public void setDefaultFloorDiscretizingMultiple(double defaultMultiple)

Sets the default multiple to use for continuous attributes that do not have specific multiples set for them. See the documentation of this class for more information on how the multiple works. In short, continuous values will be floored to the greatest value that is a multiple of the multiple given and less than or equal to the true value.

Parameters:

defaultMultiple - the default multiple to which values are floored

appendHashcodeForValue

protected void appendHashcodeForValue(org.apache.commons.lang3.builder.HashCodeBuilder hashCodeBuilder,
                          Value v)

Description copied from class: SimpleHashableStateFactory

Appends the hash code for the given Value to the HashCodeBuilder

Overrides:

appendHashcodeForValue in class SimpleHashableStateFactory

Parameters:

hashCodeBuilder - the HashCodeBuilder to which the value's hash code will be appended

v - the Value whose hash code should be appended.

valuesEqual

protected boolean valuesEqual(Value v1,
                  Value v2)

Returns whether two values are equal. If the values are real-valued, they are discretized before comparison.

Overrides:

valuesEqual in class SimpleHashableStateFactory

Parameters:

v1 - the first value to compare

v2 - the second value to compare

Returns:

true if v1 = v2 after accounting for discretization; false otherwise.

intMultiples

protected static int intMultiples(double mult,
               double num)

Returns int result of num / mult; that is, (int)(num / mult).

Parameters:

mult - the multiple

num - the number

Returns:

the int result of num / mult