magpie.data.utilities.splitters

Class ObjectiveFunctionSplitter

java.lang.Object

magpie.data.utilities.splitters.BaseDatasetSplitter

magpie.data.utilities.splitters.ObjectiveFunctionSplitter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Commandable, Options, Printable

public class ObjectiveFunctionSplitter
extends BaseDatasetSplitter

Split based on value of objective function. User must specify whether class 0 should consistent of entries above or below a certain threshold using a certain BaseEntryRanker method.

Usage: <above|below> <threshold> <objective function> [<o.f. options...>]
above|below: Whether class 0 consists of entries above/below a threshold
threshold: Objective function value on which to split entries
objective function: Name of BaseEntryRanker to use as objective function
o.f. options: Any options for the objective function

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectiveFunctionSplitter()

Method Summary

Modifier and Type	Method and Description
ObjectiveFunctionSplitter	clone()
java.util.List<java.lang.String>	getSplitNames() Get the names of the splits this splitter creates
protected java.util.List<java.lang.String>	getSplitterDetails(boolean htmlFormat) Get details of splitter.
int[]	label(Dataset D) Given a dataset, determine which subset each entry should belong to.
java.lang.String	printUsage() Print out required format for options.
void	setObjectiveFunction(BaseEntryRanker objFun) Define objective function by which to split entries
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setSplitAbove(boolean splitAbove) Set whether class #0 should be entries above a threshold
void	setThreshold(double Threshold) Set threshold on which to partition entries
void	train(Dataset TrainingSet) Train a dataset splitter, if necessary

Methods inherited from class magpie.data.utilities.splitters.BaseDatasetSplitter

about, printCommand, printDescription, runCommand, split, split

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectiveFunctionSplitter

public ObjectiveFunctionSplitter()

Method Detail

clone

public ObjectiveFunctionSplitter clone()

Overrides:

clone in class BaseDatasetSplitter

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

setSplitAbove

public void setSplitAbove(boolean splitAbove)

Set whether class #0 should be entries above a threshold

Parameters:

splitAbove - Whether class#0 is entries above threshold

setThreshold

public void setThreshold(double Threshold)

Set threshold on which to partition entries

Parameters:

Threshold - Desired threshold

setObjectiveFunction

public void setObjectiveFunction(BaseEntryRanker objFun)

Define objective function by which to split entries

Parameters:

objFun - Desired objective function

label

public int[] label(Dataset D)

Description copied from class: BaseDatasetSplitter

Given a dataset, determine which subset each entry should belong to. Please ensure that D remains unaltered (clone if you must)

Specified by:

label in class BaseDatasetSplitter

Parameters:

D - Dataset to be labeled

Returns:

A list of nonnegative integers marking which subset to split each entry into

train

public void train(Dataset TrainingSet)

Description copied from class: BaseDatasetSplitter

Train a dataset splitter, if necessary

Specified by:

train in class BaseDatasetSplitter

Parameters:

TrainingSet - Dataset to use for training

getSplitNames

public java.util.List<java.lang.String> getSplitNames()

Description copied from class: BaseDatasetSplitter

Get the names of the splits this splitter creates

Specified by:

getSplitNames in class BaseDatasetSplitter

Returns:

Names of each group

getSplitterDetails

protected java.util.List<java.lang.String> getSplitterDetails(boolean htmlFormat)

Description copied from class: BaseDatasetSplitter

Get details of splitter. Returns a list of options that can be set by the user. Used with BaseDatasetSplitter.printDescription(boolean).

Specified by:

getSplitterDetails in class BaseDatasetSplitter

Parameters:

htmlFormat - Whether to format results with HTML

Returns:

List of options describing the model