magpie.data.utilities.splitters

Class MultipleElementGroupsSplitter

java.lang.Object

magpie.data.utilities.splitters.BaseDatasetSplitter

magpie.data.utilities.splitters.SingleElementGroupSplitter

magpie.data.utilities.splitters.MultipleElementGroupsSplitter

All Implemented Interfaces:

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

public class MultipleElementGroupsSplitter
extends SingleElementGroupSplitter

Splits entries into multiple groups depending on which elements they contain. All entries containing the first set of elements are assigned into the first group. Remaining entries that contain elements in the second set are assigned into the second group. This process proceeds until all entries have been assigned, or all element groups have been treated.

Usage: "<Element set 1...>" ["<Element set 2...>"] [...]
Element set N: Any compound containing elements from this list (and none from any previous set) will be assigned to this set

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultipleElementGroupsSplitter()

Method Summary

Modifier and Type	Method and Description
void	addElementGroup(java.util.Collection<java.lang.String> elems) Add a list of elements to be treated as a single group.
void	addElementGroup(java.lang.String elems) Add a list of elements to be defined as the same group.
void	clearElementGroups() Clear the current list of element groups
MultipleElementGroupsSplitter	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	setOptions(java.util.List OptionsObj) Set any options for this object.

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

getElementIndices, setElements, train

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

MultipleElementGroupsSplitter

public MultipleElementGroupsSplitter()

Method Detail

clone

public MultipleElementGroupsSplitter clone()

Overrides:

clone in class SingleElementGroupSplitter

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.

Specified by:

setOptions in interface Options

Overrides:

setOptions in class SingleElementGroupSplitter

Parameters:

OptionsObj - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

clearElementGroups

public void clearElementGroups()

Clear the current list of element groups

addElementGroup

public void addElementGroup(java.lang.String elems)

Add a list of elements to be defined as the same group.

Parameters:

elems - Element symbols separated by spaces

addElementGroup

public void addElementGroup(java.util.Collection<java.lang.String> elems)

Add a list of elements to be treated as a single group.

Parameters:

elems - List of elements to define as a group

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

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

Specified by:

printUsage in interface Options

Overrides:

printUsage in class SingleElementGroupSplitter

Returns:

Usage for this 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)

Overrides:

label in class SingleElementGroupSplitter

Parameters:

D - Dataset to be labeled

Returns:

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

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).

Overrides:

getSplitterDetails in class SingleElementGroupSplitter

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

Overrides:

getSplitNames in class SingleElementGroupSplitter

Returns:

Names of each group