opendial.inference.approximate

Class Sample

java.lang.Object

opendial.datastructs.Assignment

opendial.inference.approximate.Sample

All Implemented Interfaces:

java.lang.Comparable<Sample>

public class Sample
extends Assignment
implements java.lang.Comparable<Sample>

Representation of a (possibly weighted) sample, which consists of an assignment of values together with a weight (here in logarithmic form) and utility.

Field Summary

Fields inherited from class opendial.datastructs.Assignment

map

Constructor Summary

Constructors

Constructor and Description
Sample() Creates a new, empty weighted sample
Sample(Assignment a) Creates a new sample
Sample(Assignment a, double logWeight, double utility) Creates a new sample with an existing weight and utility

Method Summary

Modifier and Type	Method and Description
void	addLogWeight(double addLogWeight) Adds a logarithmic weight to the current one
void	addUtility(double newUtil) Adds a utility to the sample
int	compareTo(Sample arg0)
double	getUtility() Returns the utility of the sample
double	getWeight() Returns the sample weight (exponentiated value, not the logarithmic one!)
int	hashcode()
void	setWeight(double weight) Sets the logarithmic weight to a given value
java.lang.String	toString() Returns a string representation of the weighted sample

Methods inherited from class opendial.datastructs.Assignment

addAssignment, addPair, addPair, addPair, addPair, addPair, addPair, addPairs, addPrimes, clear, consistentWith, consistentWith, containContinuousValues, contains, containsOneVar, containsPair, containsVar, containsVars, copy, createDefault, createDefault, createFromString, createOneValue, equals, filterValues, generateXML, getEntrySet, getPairs, getPruned, getTrimmed, getTrimmed, getValue, getValues, getValues, getVariables, hashCode, intersect, isDefault, isEmpty, removeAll, removePair, removePairs, removePrimes, removeValues, renameVar, size, trim

Methods inherited from class java.lang.Object

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

Constructor Detail

Sample

public Sample()

Creates a new, empty weighted sample

Sample

public Sample(Assignment a)

Creates a new sample

Parameters:

a - the existing assignment

Sample

public Sample(Assignment a,
              double logWeight,
              double utility)

Creates a new sample with an existing weight and utility

Parameters:

a - the assignment

logWeight - the logarithmic weight

utility - the utility

Method Detail

addLogWeight

public void addLogWeight(double addLogWeight)

Adds a logarithmic weight to the current one

Parameters:

addLogWeight - the weight to add

setWeight

public void setWeight(double weight)

Sets the logarithmic weight to a given value

Parameters:

weight - the value for the weight

getWeight

public double getWeight()

Returns the sample weight (exponentiated value, not the logarithmic one!)

Returns:

the (exponentiated) weight for the sample

addUtility

public void addUtility(double newUtil)

Adds a utility to the sample

Parameters:

newUtil - the utility to add

getUtility

public double getUtility()

Returns the utility of the sample

Returns:

the utility

toString

public java.lang.String toString()

Returns a string representation of the weighted sample

Overrides:

toString in class Assignment

compareTo

public int compareTo(Sample arg0)

Specified by:

compareTo in interface java.lang.Comparable<Sample>

hashcode

public int hashcode()