de.javagl.viewer.glyphs

Class BoxPlots

java.lang.Object

de.javagl.viewer.glyphs.BoxPlots

public class BoxPlots
extends java.lang.Object

Methods to create BoxPlot instances

Method Summary

Modifier and Type	Method and Description
static double	computeMax(java.lang.Iterable<? extends BoxPlot> boxPlots) Compute the maximum of the given BoxPlots.
static double	computeMin(java.lang.Iterable<? extends BoxPlot> boxPlots) Compute the minimum of the given BoxPlots.
static BoxPlot	create(double minimum, double lowerQuantile, double median, double upperQuantile, double maximum) Creates a new BoxPlot
static BoxPlot	create(double minimum, double lowerQuantile, double median, double upperQuantile, double maximum, double mean) Creates a new BoxPlot
static BoxPlot	create(java.util.stream.DoubleStream stream) Creates a new BoxPlot from the given stream of double values
static double	getMax(double optionalMax, java.util.Collection<? extends BoxPlot> boxPlots) If the given optional value is not NaN, then it will be returned.
static double	getMin(double optionalMin, java.util.Collection<? extends BoxPlot> boxPlots) If the given optional value is not NaN, then it will be returned.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BoxPlot create(java.util.stream.DoubleStream stream)

Creates a new BoxPlot from the given stream of double values

Parameters:

stream - The stream of values

Returns:

The BoxPlot

create

public static BoxPlot create(double minimum,
                             double lowerQuantile,
                             double median,
                             double upperQuantile,
                             double maximum)

Creates a new BoxPlot

Parameters:

minimum - The minimum

lowerQuantile - The lower quantile

median - The median

upperQuantile - The upper quantile

maximum - The maximum

Returns:

The BoxPlot

create

public static BoxPlot create(double minimum,
                             double lowerQuantile,
                             double median,
                             double upperQuantile,
                             double maximum,
                             double mean)

Creates a new BoxPlot

Parameters:

minimum - The minimum

lowerQuantile - The lower quantile

median - The median

upperQuantile - The upper quantile

maximum - The maximum

mean - The mean

Returns:

The BoxPlot

computeMin

public static double computeMin(java.lang.Iterable<? extends BoxPlot> boxPlots)

Compute the minimum of the given BoxPlots. If the given sequence is empty, then POSITIVE_INFINITY will be returned.

Parameters:

boxPlots - The BoxPlots

Returns:

The minimum value

computeMax

public static double computeMax(java.lang.Iterable<? extends BoxPlot> boxPlots)

Compute the maximum of the given BoxPlots. If the given sequence is empty, then NEGATIVE_INFINITY will be returned.

Parameters:

boxPlots - The BoxPlots

Returns:

The maximum value

getMin

public static double getMin(double optionalMin,
                            java.util.Collection<? extends BoxPlot> boxPlots)

If the given optional value is not NaN, then it will be returned. Otherwise, the minimum of the given BoxPlots will be returned. If the given collection is empty, or none of its elements has a finite minimum, then 0.0 will be returned.

Parameters:

optionalMin - The optional minimum value

boxPlots - The BoxPlots

Returns:

The minimum value

getMax

public static double getMax(double optionalMax,
                            java.util.Collection<? extends BoxPlot> boxPlots)

If the given optional value is not NaN, then it will be returned. Otherwise, the maximum of the given BoxPlots will be returned. If the given collection is empty, or none of its elements has a finite maximum, then 1.0 will be returned.

Parameters:

optionalMax - The optional maximum value

boxPlots - The BoxPlots

Returns:

The maximum value