Package adams.flow.container

Class TrainTestSetContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.TrainTestSetContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class TrainTestSetContainer
extends AbstractContainer

A container for storing train and test set.

Optionally, random seed, fold number and fold count can be stored as well.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_FOLD_COUNT	the identifier for the fold count.
static String	VALUE_FOLD_NUMBER	the identifier for the fold number.
static String	VALUE_SEED	the identifier for the random seed.
static String	VALUE_TEST	the identifier for the test data.
static String	VALUE_TEST_ORIGINALINDICES	the identifier for the original indices (test).
static String	VALUE_TRAIN	the identifier for the training data.
static String	VALUE_TRAIN_ORIGINALINDICES	the identifier for the original indices (train).

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
TrainTestSetContainer()	Initializes the container.
TrainTestSetContainer(Dataset train, Dataset test)	Initializes the container.
TrainTestSetContainer(Dataset train, Dataset test, Long seed)	Initializes the container.
TrainTestSetContainer(Dataset train, Dataset test, Long seed, Integer foldNumber, Integer foldCount)	Initializes the container.
TrainTestSetContainer(Dataset train, Dataset test, Long seed, Integer foldNumber, Integer foldCount, int[] trainOriginal, int[] testOriginal)	Initializes the container.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_TRAIN

public static final String VALUE_TRAIN

the identifier for the training data.

See Also:

Constant Field Values

VALUE_TRAIN_ORIGINALINDICES

public static final String VALUE_TRAIN_ORIGINALINDICES

the identifier for the original indices (train).

See Also:

Constant Field Values

VALUE_TEST

public static final String VALUE_TEST

the identifier for the test data.

See Also:

Constant Field Values

VALUE_TEST_ORIGINALINDICES

public static final String VALUE_TEST_ORIGINALINDICES

the identifier for the original indices (test).

See Also:

Constant Field Values

VALUE_SEED

public static final String VALUE_SEED

the identifier for the random seed.

See Also:

Constant Field Values

VALUE_FOLD_NUMBER

public static final String VALUE_FOLD_NUMBER

the identifier for the fold number.

See Also:

Constant Field Values

VALUE_FOLD_COUNT

public static final String VALUE_FOLD_COUNT

the identifier for the fold count.

See Also:

Constant Field Values

Constructor Detail

TrainTestSetContainer

public TrainTestSetContainer()

Initializes the container.

Only used for generating help information.

TrainTestSetContainer

public TrainTestSetContainer(Dataset train,
                             Dataset test)

Initializes the container.

Parameters:

train - the training set

test - the test data

TrainTestSetContainer

public TrainTestSetContainer(Dataset train,
                             Dataset test,
                             Long seed)

Initializes the container.

Parameters:

train - the training set

test - the test data

seed - the seed value, can be null

TrainTestSetContainer

public TrainTestSetContainer(Dataset train,
                             Dataset test,
                             Long seed,
                             Integer foldNumber,
                             Integer foldCount)

Initializes the container.

Parameters:

train - the training set

test - the test data

seed - the seed value, can be null

foldNumber - the fold number

foldCount - the fold count

TrainTestSetContainer

public TrainTestSetContainer(Dataset train,
                             Dataset test,
                             Long seed,
                             Integer foldNumber,
                             Integer foldCount,
                             int[] trainOriginal,
                             int[] testOriginal)

Initializes the container.

Parameters:

train - the training set

test - the test data

seed - the seed value, can be null

foldNumber - the fold number

foldCount - the fold count

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

enumeration over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available