org.jenetics.tool.trial

Class TrialMeter<T>

java.lang.Object

org.jenetics.tool.trial.TrialMeter<T>

public final class TrialMeter<T>
extends Object

Represents an function testing measurement environment.

Since:

3.4

Version:

3.4

Author:

Franz Wilhelmstötter

Method Summary

Modifier and Type	Method and Description
int	dataSize() Return the number of test data results.
Data	getData(String name) Return the test data with the given name
DataSet	getDataSet() Return the current trail DataSet.
Optional<String>	getDescription() Return the optional description string.
Env	getEnv() The trial meter environment information.
String	getName()
Params<T>	getParams() Return the testing parameters.
static <T> TrialMeter<T>	of(String name, String description, Env env, Params<T> params, String... dataSetNames) Return a new trial measure environment.
static <T> TrialMeter<T>	of(String name, String description, Params<T> params, String... dataSetNames) Return a new trial measure environment.
static <T> TrialMeter<T>	read(InputStream in) Read existing TrialMeter (intermediate) results from the given input stream.
static <T> TrialMeter<T>	read(Path path) Read existing TrialMeter (intermediate) results from the given path.
void	sample(Function<T,double[]> function) Calculates the test values for all parameters.
String	toString()
void	write(OutputStream out) Writes the current TrialMeter object (the calculated samples + the parameters) to the given output stream.
void	write(Path path) Writes the current TrialMeter object (the calculated samples + the parameters) to the given path.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

getDescription

public Optional<String> getDescription()

Return the optional description string.

Returns:

the optional description string

getEnv

public Env getEnv()

The trial meter environment information.

Returns:

the trial meter environment information

getParams

public Params<T> getParams()

Return the testing parameters.

Returns:

the testing parameters

getDataSet

public DataSet getDataSet()

Return the current trail DataSet.

Returns:

the current trail data set

getData

public Data getData(String name)

Return the test data with the given name

Parameters:

name - the data name

Returns:

the test Data with the given name

Throws:

NullPointerException - if the given name is null

dataSize

public int dataSize()

Return the number of test data results.

Returns:

the number of test data results.

sample

public void sample(Function<T,double[]> function)

Calculates the test values for all parameters. The length of the resulting double[] array must be dataSize().

Parameters:

function - the test function

toString

public String toString()

Overrides:

toString in class Object

write

public void write(OutputStream out)

Writes the current TrialMeter object (the calculated samples + the parameters) to the given output stream.

Parameters:

out - the output stream where to write the trial meter

Throws:

UncheckedIOException - if the marshalling fails

write

public void write(Path path)

Writes the current TrialMeter object (the calculated samples + the parameters) to the given path.

Parameters:

path - the output path

Throws:

UncheckedIOException - if the marshalling fails

of

public static <T> TrialMeter<T> of(String name,
                                   String description,
                                   Params<T> params,
                                   String... dataSetNames)

Return a new trial measure environment.

Type Parameters:

T - the parameter type

Parameters:

name - the trial meter name

description - the trial meter description, maybe null

params - the parameters which are tested by this trial meter

dataSetNames - the names of the calculated data sets

Returns:

a new trial measure environment

of

public static <T> TrialMeter<T> of(String name,
                                   String description,
                                   Env env,
                                   Params<T> params,
                                   String... dataSetNames)

Return a new trial measure environment.

Type Parameters:

T - the parameter type

Parameters:

name - the trial meter name

description - the trial meter description, maybe null

env - the environment information

params - the parameters which are tested by this trial meter

dataSetNames - the names of the calculated data sets

Returns:

a new trial measure environment

read

public static <T> TrialMeter<T> read(InputStream in)

Read existing TrialMeter (intermediate) results from the given input stream.

Type Parameters:

T - the parameter type

Parameters:

in - the InputStream to read from

Returns:

the TrialMeter object read from the input stream

Throws:

UncheckedIOException - if reading the TrialMeter fails

read

public static <T> TrialMeter<T> read(Path path)

Read existing TrialMeter (intermediate) results from the given path.

Type Parameters:

T - the parameter type

Parameters:

path - the path the TrialMeter is read

Returns:

the TrialMeter object read from the input stream

Throws:

UncheckedIOException - if reading the TrialMeter fails