magpie.data.utilities.splitters

Class SingleElementGroupSplitter

java.lang.Object

magpie.data.utilities.splitters.BaseDatasetSplitter

magpie.data.utilities.splitters.SingleElementGroupSplitter

All Implemented Interfaces:

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

Direct Known Subclasses:

MultipleElementGroupsSplitter

public class SingleElementGroupSplitter
extends BaseDatasetSplitter

Split dataset into two groups based on whether it contains certain elements. Any compound that contains a listed element is placed in set 0, all others in set 1.

Usage: <Element names...>
Element names...: Entries containing these elements will be split into a distinct set

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleElementGroupSplitter()

Method Summary

Modifier and Type	Method and Description
SingleElementGroupSplitter	clone()
protected static java.util.List<java.lang.Integer>	getElementIndices(java.util.List<java.lang.String> ElementNames, CompositionDataset Data) Given a CompositionDataset, return the index corresponding to each element in a list of element names
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	setElements(java.util.List<java.lang.String> elems) Define list of elements to define the split.
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

Constructor Detail

SingleElementGroupSplitter

public SingleElementGroupSplitter()

Method Detail

clone

public SingleElementGroupSplitter clone()

Overrides:

clone in class BaseDatasetSplitter

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

setElements

public void setElements(java.util.List<java.lang.String> elems)

Define list of elements to define the split.

Parameters:

elems - List of element symbols

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

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

getElementIndices

protected static java.util.List<java.lang.Integer> getElementIndices(java.util.List<java.lang.String> ElementNames,
                                                                     CompositionDataset Data)

Given a CompositionDataset, return the index corresponding to each element in a list of element names

Parameters:

Data -

Returns:

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