magpie.data.utilities.splitters

Class AttributeIntervalSplitter

java.lang.Object

magpie.data.utilities.splitters.BaseDatasetSplitter

magpie.data.utilities.splitters.AttributeIntervalSplitter

All Implemented Interfaces:

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

public class AttributeIntervalSplitter
extends BaseDatasetSplitter

This class splits data into multiple properties based on the attributes of each entry. User supplies the intervals, which are first sorting into ascending order. Then, the data is partitioned into bins with these points as edges.

Usage: <attribute> <bin edges...>
attribute: Name of attribute on which to split dataset
bin edges...: Values on which to split data (i.e. "1" to split into (-Inf, 1) and [1, Inf])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	AttributeID ID of attribute used for split
protected java.lang.String	AttributeName Name of attribute used for split
protected double[]	BinEdges Values to use as bin edges

Constructor Summary

Constructors

Constructor and Description
AttributeIntervalSplitter()

Method Summary

Modifier and Type	Method and Description
AttributeIntervalSplitter	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	setAttributeName(java.lang.String name) Define which attribute to use for splitting
void	setBinEdges(double[] binEdges) Define the edges of bins on which to split data.
void	setOptions(java.util.List OptionsObj) Set any options for this object.
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

Field Detail

AttributeName

protected java.lang.String AttributeName

Name of attribute used for split

AttributeID

protected int AttributeID

ID of attribute used for split

BinEdges

protected double[] BinEdges

Values to use as bin edges

Constructor Detail

AttributeIntervalSplitter

public AttributeIntervalSplitter()

Method Detail

clone

public AttributeIntervalSplitter clone()

Overrides:

clone in class BaseDatasetSplitter

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

setOptions

public void setOptions(java.util.List OptionsObj)
                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:

OptionsObj - 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

setAttributeName

public void setAttributeName(java.lang.String name)

Define which attribute to use for splitting

Parameters:

name - Name of desired attribute

setBinEdges

public void setBinEdges(double[] binEdges)

Define the edges of bins on which to split data.

Parameters:

binEdges - Desired bin edges

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

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

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