SampleSummary (Jenetics 3.8.0)

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

All Implemented Interfaces:

Serializable
```
public final class SampleSummary
extends Object
implements Serializable
```
Summary of a given set of Sample objects.

Since:

3.4

Version:

3.4

Author:

Franz Wilhelmstötter

See Also:

Data, Sample, SampleSummaryPoint, SampleSummaryStatistics, Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`ISeq<SampleSummaryPoint>`	`getPoints()` Return the summary points.
`int`	`hashCode()`
`static SampleSummary`	`of(ISeq<SampleSummaryPoint> points)` Create a new `SampleSummary` object from the given sample points.
`static SampleSummary`	`of(SampleSummaryStatistics statistics)` Return a new `SampleSummary` for the given `SampleSummaryStatistics`.
`int`	`parameterCount()` Return the number of `SampleSummaryPoint` this summary, one for every parameter.
`Stream<SampleSummaryPoint>`	`stream()` Return the summary points as `Stream`.
`static Collector<Sample,?,SampleSummary>`	`toSampleSummary(int parameterCount)` Return a `Collector` for creating a `SampleSummary` object.

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

- Method Detail
  - parameterCount
```
public int parameterCount()
```
    Return the number of SampleSummaryPoint this summary, one for every parameter.
    
    Returns:
    
    the number of parameters
  - getPoints
```
public ISeq<SampleSummaryPoint> getPoints()
```
    Return the summary points.
    
    Returns:
    
    the summary points
  - stream
```
public Stream<SampleSummaryPoint> stream()
```
    Return the summary points as Stream.
    
    Returns:
    
    the summary points as Stream
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - of
```
public static SampleSummary of(ISeq<SampleSummaryPoint> points)
```
    Create a new SampleSummary object from the given sample points.
    
    Parameters:
    
    points - the summary points
    
    Returns:
    
    a new SampleSummary instance
    
    Throws:
    
    NullPointerException - if the argument is null
  - of
```
public static SampleSummary of(SampleSummaryStatistics statistics)
```
    Return a new SampleSummary for the given SampleSummaryStatistics.
    
    Parameters:
    
    statistics - the summary statistics object
    
    Returns:
    
    a new SampleSummary instance
    
    Throws:
    
    NullPointerException - if the argument is null
  - toSampleSummary
```
public static Collector<Sample,?,SampleSummary> toSampleSummary(int parameterCount)
```
    Return a Collector for creating a SampleSummary object.
    
    Parameters:
    
    parameterCount - the number of parameters of the samples
    
    Returns:
    
    a SampleSummary Collector
    
    Throws:
    
    IllegalArgumentException - if the given parameterCount is smaller than one

Class SampleSummary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parameterCount

getPoints

stream

hashCode

equals

of

of

toSampleSummary