org.jenetics.tool.trial

Class Params<T>

java.lang.Object

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

All Implemented Interfaces:

Serializable, Iterable<T>

public final class Params<T>
extends Object
implements Iterable<T>, Serializable

Collection of parameters the function under test is tested with.

Since:

3.4

Version:

3.4

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	get(int index) Return the parameter with the given index.
String	getName() Return the name of the parameter collection.
int	hashCode()
Iterator<T>	iterator()
static <T> Params<T>	of(String name, ISeq<T> params) Return a new parameters object.
int	size() Return the number of parameters this collection contains.
Stream<T>	stream() Return the parameter values as stream.
String	toString()
ISeq<T>	values() Return the parameter values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getName

public String getName()

Return the name of the parameter collection.

Returns:

the name of the parameter collection

get

public T get(int index)

Return the parameter with the given index.

Parameters:

index - the parameter index

Returns:

the parameter with the given index

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

size

public int size()

Return the number of parameters this collection contains.

Returns:

the number of parameters

values

public ISeq<T> values()

Return the parameter values.

Returns:

the parameter values

stream

public Stream<T> stream()

Return the parameter values as stream.

Returns:

the parameter values as stream

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

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 <T> Params<T> of(String name,
                               ISeq<T> params)

Return a new parameters object.

Type Parameters:

T - the parameter type

Parameters:

name - the name of the parameters

params - the actual parameters

Returns:

a new parameters object

Throws:

NullPointerException - if one of the parameters is null