org.jenetics.tool.trial

Class Data

java.lang.Object

org.jenetics.tool.trial.Data

All Implemented Interfaces:

Serializable

public final class Data
extends Object
implements Serializable

This class collects a list of Sample result objects into on Data object.

Since:

3.4

Version:

3.4

Author:

Franz Wilhelmstötter

See Also:

Sample, Serialized Form

Method Summary

Modifier and Type	Method and Description
Sample	currentSample() Return the current Sample object.
int	dataSize() The number of Sample objects this Data class contains.
boolean	equals(Object obj)
String	getName() Return the name of the sample Data collections.
int	hashCode()
int	nextParamIndex() Return the index of the next parameter index to calculate.
static Data	of(String name, int parameterCount) Return a new Data object with the given name and the given number of parameters.
static Data	of(String name, List<Sample> samples) Create a new Data object with the given parameters.
int	sampleSize() The number of values of an Sample object.
SampleSummary	summary() Calculate the sample summary of this data object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Return the name of the sample Data collections.

Returns:

the name of the sample Data collections

dataSize

public int dataSize()

The number of Sample objects this Data class contains.

Returns:

the size of the data object

sampleSize

public int sampleSize()

The number of values of an Sample object.

Returns:

number of values of an Sample object

See Also:

Sample.size()

currentSample

public Sample currentSample()

Return the current Sample object. A newly created object is returned on demand.

Returns:

the current Sample object

nextParamIndex

public int nextParamIndex()

Return the index of the next parameter index to calculate.

Returns:

the index of the next parameter index to calculate

summary

public SampleSummary summary()

Calculate the sample summary of this data object.

Returns:

the sample summary of this data object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static Data of(String name,
                      List<Sample> samples)

Create a new Data object with the given parameters.

Parameters:

name - the name of the data object

samples - the sample list of the data object

Returns:

a new Data object with the given parameters

Throws:

NullPointerException - if one of the parameters is null

of

public static Data of(String name,
                      int parameterCount)

Return a new Data object with the given name and the given number of parameters.

Parameters:

name - the name of the data object

parameterCount - the parameter count of the created samples

Returns:

a new Data object with the given parameters

Throws:

NullPointerException - if the data name is null

IllegalArgumentException - if the given parameterCount is smaller then one