Sample (Jenetics 3.8.0)

java.lang.Object
- org.jenetics.tool.trial.Sample

All Implemented Interfaces:

Serializable
```
public final class Sample
extends Object
implements Serializable
```
The sample class contains the results of one test run of all parameters. This class is mutable and not thread safe.

Since:

3.4

Version:

3.4

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`double`	`get(int index)` Return the slot value at the given position.
`int`	`hashCode()`
`boolean`	`isFull()` Test whether all sample slots are occupied.
`Sample`	`newSample()` Create a new `Sample` object, with all slots available, with the same size as `this` one.
`int`	`nextIndex()` Return the index of the next free `double` slot.
`static Sample`	`of(double[] values)` Create a new `Sample` object with the `values`.
`static Sample`	`of(int length)` Create a new `Sample` object of the given `length`.
`int`	`size()` Return the number of `double` slots the `Sample` class stores.
`DoubleStream`	`stream()` Returns a sequential `DoubleStream` with the slot values of this `Sample` object.
`String`	`toString()`
`double[]`	`values()` Return the sample `double` values (slots).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - size
```
public int size()
```
    Return the number of double slots the Sample class stores.
    
    Returns:
    
    the number of double slots
  - nextIndex
```
public int nextIndex()
```
    Return the index of the next free double slot. If all slots are occupied, -1 is returned.
    
    Returns:
    
    the index of the next free double slot, or -1 if all slots are occupied
  - isFull
```
public boolean isFull()
```
    Test whether all sample slots are occupied.
    
    Returns:
    
    true if all sample slots are occupied, false otherwise
  - values
```
public double[] values()
```
    Return the sample double values (slots).
    
    Returns:
    
    the sample double values (slots).
  - stream
```
public DoubleStream stream()
```
    Returns a sequential DoubleStream with the slot values of this Sample object.
    
    Returns:
    
    a DoubleStream for the sample values
  - get
```
public double get(int index)
```
    Return the slot value at the given position.
    
    Parameters:
    
    index - the value index
    
    Returns:
    
    the sample value at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - newSample
```
public Sample newSample()
```
    Create a new Sample object, with all slots available, with the same size as this one.
    
    Returns:
    
    a new empty Sample 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 Sample of(double[] values)
```
    Create a new Sample object with the values.
    
    Parameters:
    
    values - the slot values of the created Sample object
    
    Returns:
    
    a new Sample object with the values
    
    Throws:
    
    IllegalArgumentException - if the length of the given values is zero
  - of
```
public static Sample of(int length)
```
    Create a new Sample object of the given length.
    
    Parameters:
    
    length - the length of the new Sample object
    
    Returns:
    
    a new Sample object of the given length
    
    Throws:
    
    IllegalArgumentException - if the given length is smaller then one

Class Sample

Method Summary

Methods inherited from class java.lang.Object

Method Detail

size

nextIndex

isFull

values

stream

get

newSample

hashCode

equals

toString

of

of