org.dmilne.weka.wrapper

Class BinaryDecider<A extends Enum<A>>

java.lang.Object

org.dmilne.weka.wrapper.Decider<A,Boolean>

org.dmilne.weka.wrapper.BinaryDecider<A>

Type Parameters:

A - An enumeration of attributes (features) used to inform the decider

public class BinaryDecider<A extends Enum<A>>
extends Decider<A,Boolean>

Author:

David Milne A Decider that chooses between two classes (true and false).

Field Summary

Fields inherited from class org.dmilne.weka.wrapper.Decider

_attributes, _classAttribute, _classifier, _datasetHeader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BinaryDecider(String name, TypedAttribute[] attributes, TypedAttribute classAttribute, Vector<weka.filters.Filter> filters)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getDecision(weka.core.Instance instance) Makes a decision for the given instance.
HashMap<Boolean,Double>	getDecisionDistribution(weka.core.Instance instance) Returns a HashMap associating possible decision outputs with a confidence value in that decision.
InstanceBuilder<A,Boolean>	getInstanceBuilder() Returns a builder for constructing an instance that this decider can make a decision for.

Methods inherited from class org.dmilne.weka.wrapper.Decider

createDatasetHeader, createNewDataset, getName, getRawClassification, getRawDistributionForInstance, isReady, load, save, test, throwIfCannotClassify, train

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryDecider

protected BinaryDecider(String name,
             TypedAttribute[] attributes,
             TypedAttribute classAttribute,
             Vector<weka.filters.Filter> filters)
                 throws Exception

Throws:

Exception

Method Detail

getDecision

public Boolean getDecision(weka.core.Instance instance)
                    throws Exception

Description copied from class: Decider

Makes a decision for the given instance.

This function is not available until isReady returns true.

You should typically use an instance builder to generate the instance that is passed into this method.

Specified by:

getDecision in class Decider<A extends Enum<A>,Boolean>

Parameters:

instance - a set of attribute values

Returns:

the decision

Throws:

Exception

getDecisionDistribution

public HashMap<Boolean,Double> getDecisionDistribution(weka.core.Instance instance)
                                                throws Exception

Description copied from class: Decider

Returns a HashMap associating possible decision outputs with a confidence value in that decision. This information can be used, for example, to identify cases when the result of Decider.getDecision(Instance) is clear-cut, or a close tie with other possible decisions.

The method by which these values are calculated and their usefulness depends on the classifier.

This function is not available until isReady returns true.

You should typically use an instance builder to generate the instance that is passed into this method.

Specified by:

getDecisionDistribution in class Decider<A extends Enum<A>,Boolean>

Returns:

A HashMap associating possible decisions with confidence values.

Throws:

Exception

getInstanceBuilder

public InstanceBuilder<A,Boolean> getInstanceBuilder()

Description copied from class: Decider

Returns a builder for constructing an instance that this decider can make a decision for.

Specified by:

getInstanceBuilder in class Decider<A extends Enum<A>,Boolean>

Returns:

a builder for constructing an instance for this decider can make a decision for.