burlap.oomdp.core.values

Class DiscreteValue

java.lang.Object

burlap.oomdp.core.values.OOMDPValue

burlap.oomdp.core.values.DiscreteValue

All Implemented Interfaces:

Value

public class DiscreteValue
extends OOMDPValue
implements Value

A discrete value subclass in which discrete values are stored as int values. The int values correspond to the attributes categorical list of discrete values, so the int values should always be >= 0 unless it is unset, which is specified by a value of -1.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected int	discVal The discrete value stored as an integer.
static int	UNSET

Fields inherited from class burlap.oomdp.core.values.OOMDPValue

attribute

Constructor Summary

Constructors

Constructor and Description
DiscreteValue(Attribute attribute) Initializes this value to be an assignment for Attribute attribute.
DiscreteValue(Attribute attribute, int discVal)
DiscreteValue(DiscreteValue v) Initializes this value as a copy from the source Value object v.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.StringBuilder	buildStringVal(java.lang.StringBuilder builder)
Value	copy() Creates a deep copy of this value object.
boolean	equals(java.lang.Object obj)
boolean	getBooleanValue() Returns the boolean value of this attibute.
int	getDiscVal() Returns the discrete integer value of this Value object
double	getNumericRepresentation() Returns a numeric representation
Value	setValue(boolean v) Sets the internalvalue representation using a boolean value
Value	setValue(double v) Sets the internal value representation using a double value
Value	setValue(int v) Sets the internal value representation using an int value
Value	setValue(java.lang.String v) Sets the internal value representation using a string value
boolean	valueHasBeenSet() Returns whether the value has been set to a meaningful value.

Methods inherited from class burlap.oomdp.core.values.OOMDPValue

addAllRelationalTargets, addRelationalTarget, attName, clearRelationTargets, getAllRelationalTargets, getAttribute, getDoubleArray, getIntArray, getRealVal, getStringVal, removeRelationalTarget, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface burlap.oomdp.core.values.Value

addAllRelationalTargets, addRelationalTarget, attName, clearRelationTargets, getAllRelationalTargets, getAttribute, getDoubleArray, getIntArray, getRealVal, getStringVal, removeRelationalTarget, setValue, setValue

Field Detail

UNSET

public static final int UNSET

See Also:

Constant Field Values

discVal

protected final int discVal

The discrete value stored as an integer. If the attribute defines categorical values with strings, this int value represents the index in the list of categorical values. The default value of -1 indicates an unset attribute value.

Constructor Detail

DiscreteValue

public DiscreteValue(Attribute attribute)

Initializes this value to be an assignment for Attribute attribute.

Parameters:

attribute -

DiscreteValue

public DiscreteValue(DiscreteValue v)

Initializes this value as a copy from the source Value object v.

Parameters:

v - the source Value to make this object a copy of.

DiscreteValue

public DiscreteValue(Attribute attribute,
             int discVal)

Method Detail

valueHasBeenSet

public boolean valueHasBeenSet()

Description copied from interface: Value

Returns whether the value has been set to a meaningful value. Unset values typically happen when a new object instance has been created by not had its values set. Leaving values unset will result in exceptions being thrown to prevent errors in underspecified states.

Specified by:

valueHasBeenSet in interface Value

Returns:

true if the value has been set; false if not.

copy

public Value copy()

Description copied from interface: Value

Creates a deep copy of this value object.

Specified by:

copy in interface Value

Returns:

a deep copy of this value object.

setValue

public Value setValue(int v)

Description copied from class: OOMDPValue

Sets the internal value representation using an int value

Specified by:

setValue in interface Value

Overrides:

setValue in class OOMDPValue

Parameters:

v - the int value assignment

setValue

public Value setValue(double v)

Description copied from class: OOMDPValue

Sets the internal value representation using a double value

Specified by:

setValue in interface Value

Overrides:

setValue in class OOMDPValue

Parameters:

v - the double value assignment

setValue

public Value setValue(boolean v)

Description copied from class: OOMDPValue

Sets the internalvalue representation using a boolean value

Specified by:

setValue in interface Value

Overrides:

setValue in class OOMDPValue

Parameters:

v - the boolean value

setValue

public Value setValue(java.lang.String v)

Description copied from class: OOMDPValue

Sets the internal value representation using a string value

Specified by:

setValue in interface Value

Overrides:

setValue in class OOMDPValue

Parameters:

v - the string value assignment

getDiscVal

public int getDiscVal()

Description copied from class: OOMDPValue

Returns the discrete integer value of this Value object

Specified by:

getDiscVal in interface Value

Overrides:

getDiscVal in class OOMDPValue

Returns:

the discrete integer value of this Value object

buildStringVal

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

Specified by:

buildStringVal in interface Value

getNumericRepresentation

public double getNumericRepresentation()

Description copied from class: OOMDPValue

Returns a numeric representation

Specified by:

getNumericRepresentation in interface Value

Overrides:

getNumericRepresentation in class OOMDPValue

Returns:

a double value.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBooleanValue

public boolean getBooleanValue()

Description copied from class: OOMDPValue

Returns the boolean value of this attibute. For int values, this means 0 = false and all other values = true.

Specified by:

getBooleanValue in interface Value

Overrides:

getBooleanValue in class OOMDPValue

Returns:

the boolean value of this attribute.