burlap.oomdp.core

Class Attribute

java.lang.Object

burlap.oomdp.core.Attribute

public class Attribute
extends java.lang.Object

The attribute class defines attributes that define OO-MDP object classes. There are different types of attributes to support different types of value. Currently, there are attributes to support discrete values, real values, string values, and relational values. There are two different kinds of discrete values, int and disc. While both are internally stored as integers, the int value may be unbounded in range, whereas disc values have a finite domain and also refer to specific categorical values represented as string. Discrete attributes require a finite domain (that is, it must be specified how many different discrete values there are). There are two different kinds of real attributes; bounded and unbounded. A a bounded real attribute should have a lower limit value and an upper limit value. Unbounded real attributes may span any range. Both attributes' values are represented by double data types. There are also two kinds of relational attributes: single target and multi-target. A single target relational attribute can only be linked to one other object, whereas a multi-target relational attribute can be linked to a set of other objects. In both cases, the relational attribute can be unset to any target. The single-target relational attribute values are represented by strings that specify the name reference of the object to which they are connected. Multi-target relational attribute values are represented by an ordered set of string values indicating the targets to which the attribute is connected.

Author:

James MacGlashan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attribute.AttributeType And enumeration type to indicate the various types of attributes supported.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.String>	discValues The possible categorical values for a discrete or boolean attribute.
java.util.Map<java.lang.String,java.lang.Integer>	discValuesHash maps categorical names of discrete values to int values
Domain	domain domain that holds this attribute
double	lowerLim lowest value for a non-relational attribute
java.lang.String	name name of the attribute
Attribute.AttributeType	type type of values attribute holds
double	upperLim highest value for a non-relational attribute

Constructor Summary

Constructors

Constructor and Description
Attribute(Domain domain, java.lang.String name) Constructs an attribute with an unspecified type that will need to be specified later.
Attribute(Domain domain, java.lang.String name, Attribute.AttributeType type) Constructs with a given attribute type.

Method Summary

Methods

Modifier and Type	Method and Description
Attribute	copy(Domain newDomain) Will create a new Attribute object with the same configuration and name as this one.
boolean	equals(java.lang.Object obj)
int	hashCode()
void	setDiscValues(java.util.List<java.lang.String> vals) Sets a discrete attribute's categorical values
void	setDiscValues(java.lang.String[] vals) Sets a discrete attribute's categorical values.
void	setDiscValuesForRange(int low, int high, int step) Sets the possible range of discrete (@link Attribute.AttributeType.DISC) values for the attribute.
void	setLims(double lower, double upper) Sets the upper and lower bound limits for a bounded real attribute.
void	setType(Attribute.AttributeType type) Sets the type for this attribute.
Value	valueConstructor() Returns a Value object compatible with this Attributes type (i.e., discrete or real).

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

name of the attribute

type

public Attribute.AttributeType type

type of values attribute holds

domain

public Domain domain

domain that holds this attribute

lowerLim

public double lowerLim

lowest value for a non-relational attribute

upperLim

public double upperLim

highest value for a non-relational attribute

discValuesHash

public java.util.Map<java.lang.String,java.lang.Integer> discValuesHash

maps categorical names of discrete values to int values

discValues

public java.util.List<java.lang.String> discValues

The possible categorical values for a discrete or boolean attribute.

Constructor Detail

Attribute

public Attribute(Domain domain,
         java.lang.String name)

Constructs an attribute with an unspecified type that will need to be specified later.

Parameters:

domain - the domain that the attribute exists in

name - the name of the attribute

Attribute

public Attribute(Domain domain,
         java.lang.String name,
         Attribute.AttributeType type)

Constructs with a given attribute type. If the attribute type is set to boolean, the categorical values will automatically be initialized to "false" and "true" with a range from 0 to 1. If the attribute type is relational, then the domain is automatically set to object identifier dependent.

Parameters:

domain - the domain that the attribute exists in

name - the name of the attribute

type - the type of the attribute (discrete or real)

Method Detail

copy

public Attribute copy(Domain newDomain)

Will create a new Attribute object with the same configuration and name as this one.

Parameters:

newDomain - the domain to which the new attribute should be attached

Returns:

the new attribute object

setLims

public void setLims(double lower,
           double upper)

Sets the upper and lower bound limits for a bounded real attribute.

Parameters:

lower - the lower limit

upper - the upper limit

setType

public void setType(Attribute.AttributeType type)

Sets the type for this attribute. If the attribute type is set to boolean, the categorical values will automatically be initialized to "false" and "true" with a range from 0 to 1. If the attribute type is relational, then the domain is automatically set to object identifier dependent.

Parameters:

type - the attribute type to which this attribute should be set

setDiscValues

public void setDiscValues(java.util.List<java.lang.String> vals)

Sets a discrete attribute's categorical values

Parameters:

vals - the list of categorical values for this discrete attribute

setDiscValues

public void setDiscValues(java.lang.String[] vals)

Sets a discrete attribute's categorical values.

Parameters:

vals - an array of categorical values for this discerte attribute

setDiscValuesForRange

public void setDiscValuesForRange(int low,
                         int high,
                         int step)

Sets the possible range of discrete (@link Attribute.AttributeType.DISC) values for the attribute. The categorical values will be set to the the string representation of each integer number.

Parameters:

low - the minimum int value for the attribute

high - the maximum int value for the attribute

step - the amount by which the int value will increase

valueConstructor

public Value valueConstructor()

Returns a Value object compatible with this Attributes type (i.e., discrete or real). This method will not work for NOTYPE attributes.

Returns:

a Value object compatible with this Attributes type (i.e., discrete or real)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object