A dataset that can be used for creating histograms. More...

Inheritance diagram for umontreal.ssj.charts.CustomHistogramDataset:

Public Member Functions
	CustomHistogramDataset ()
	Creates a new (empty) dataset with a default type of HistogramType.FREQUENCY.
HistogramType	getType ()
	Returns the histogram type.
void	setType (HistogramType type)
	Sets the histogram type and sends a DatasetChangeEvent to all registered listeners.
void	addSeries (Comparable key, double values[], int bins)
	Adds a series to the dataset, using the specified number of bins.
void	addSeries (Comparable key, double values[], int numPoints, int bins)
	Adds a series to the dataset, using the specified number of bins.
void	addSeries (Comparable key, double values[], int bins, double minimum, double maximum)
	Adds a series to the dataset.
void	addSeries (Comparable key, double values[], int numPoints, int bins, double minimum, double maximum)
	Adds a series to the dataset.
void	addSeries (Comparable key, double values[], HistogramBin bins[])
	Adds a series to the dataset.
void	addSeries (Comparable key, double values[], int numPoints, HistogramBin bins[])
	Adds a series to the dataset.
List	getBins (int series)
	Returns the bins for a series.
void	setBins (int series, int bins)
	Sets the bins for a series.
void	setBins (int series, int bins, double minimum, double maximum)
	Sets the bins for a series.
void	setBins (int series, HistogramBin bins[])
	Sets the bins for a series.
List	getValuesList (int series)
	Returns the values for a series.
double[]	getValues (int series)
	Returns the values for a series.
void	setValues (int series, List valuesList)
	Sets the values for a series.
void	setValues (int series, double values[])
	Sets the values for a series.
int	getTotal (int series)
	Returns the total number of observations for a series.
double	getBinWidth (int series)
	Returns the bin width for a series.
int	getSeriesCount ()
	Returns the number of series in the dataset.
Comparable	getSeriesKey (int series)
	Returns the key for a series.
int	getItemCount (int series)
	Returns the number of data items for a series.
Number	getX (int series, int item)
	Returns the X value for a bin.
Number	getY (int series, int item)
	Returns the y-value for a bin (calculated to take into account the histogram type).
Number	getStartX (int series, int item)
	Returns the start value for a bin.
Number	getEndX (int series, int item)
	Returns the end value for a bin.
Number	getStartY (int series, int item)
	Returns the start y-value for a bin (which is the same as the y-value).
Number	getEndY (int series, int item)
	Returns the end y-value for a bin (which is the same as the y-value).
boolean	equals (Object obj)
	Tests this dataset for equality with an arbitrary object.
Object	clone () throws CloneNotSupportedException
	Returns a clone of the dataset.

Public Attributes
HistogramType	type
	The histogram type.

Detailed Description

A dataset that can be used for creating histograms.

This class is inspired from JFreeChart HistogramDataset class, and provides tools to customize histogram bins.

Definition at line 44 of file CustomHistogramDataset.java.

Constructor & Destructor Documentation

◆ CustomHistogramDataset()

umontreal.ssj.charts.CustomHistogramDataset.CustomHistogramDataset ( )

Creates a new (empty) dataset with a default type of HistogramType.FREQUENCY.

Definition at line 57 of file CustomHistogramDataset.java.

Member Function Documentation

◆ addSeries() [1/6]

void umontreal.ssj.charts.CustomHistogramDataset.addSeries	(	Comparable	key,
		double	values[],
		HistogramBin	bins[] )

Adds a series to the dataset.

Values falling on the boundary of adjacent bins will be assigned to the higher indexed bin.

Parameters

key	the series key (`null` not permitted).
values	the raw observations.
bins	new bins (size must be at least 1).

Definition at line 187 of file CustomHistogramDataset.java.

◆ addSeries() [2/6]

void umontreal.ssj.charts.CustomHistogramDataset.addSeries	(	Comparable	key,
		double	values[],
		int	bins )

Adds a series to the dataset, using the specified number of bins.

Parameters

key	the series key (`null` not permitted).
values	the values (`null` not permitted).
bins	the number of bins (must be at least 1).

Definition at line 92 of file CustomHistogramDataset.java.

◆ addSeries() [3/6]

void umontreal.ssj.charts.CustomHistogramDataset.addSeries	(	Comparable	key,
		double	values[],
		int	bins,
		double	minimum,
		double	maximum )

Adds a series to the dataset.

Any data value less than minimum will be assigned to the first bin, and any data value greater than maximum will be assigned to the last bin. Values falling on the boundary of adjacent bins will be assigned to the higher indexed bin.

Parameters

key	the series key (`null` not permitted).
values	the raw observations.
bins	the number of bins (must be at least 1).
minimum	the lower bound of the bin range.
maximum	the upper bound of the bin range.

Definition at line 124 of file CustomHistogramDataset.java.

◆ addSeries() [4/6]

void umontreal.ssj.charts.CustomHistogramDataset.addSeries	(	Comparable	key,
		double	values[],
		int	numPoints,
		HistogramBin	bins[] )

Adds a series to the dataset.

Values falling on the boundary of adjacent bins will be assigned to the higher indexed bin.

Parameters

key	the series key (`null` not permitted).
values	the raw observations.
numPoints	only the first numPoints values are used.
bins	new bins (size must be at least 1).

Definition at line 200 of file CustomHistogramDataset.java.

◆ addSeries() [5/6]

void umontreal.ssj.charts.CustomHistogramDataset.addSeries	(	Comparable	key,
		double	values[],
		int	numPoints,
		int	bins )

Adds a series to the dataset, using the specified number of bins.

Parameters

key	the series key (`null` not permitted).
values	the values (`null` not permitted).
numPoints	only the first numPoints values are used.
bins	the number of bins (must be at least 1).

Definition at line 106 of file CustomHistogramDataset.java.

◆ addSeries() [6/6]

void umontreal.ssj.charts.CustomHistogramDataset.addSeries	(	Comparable	key,
		double	values[],
		int	numPoints,
		int	bins,
		double	minimum,
		double	maximum )

Adds a series to the dataset.

Any data value less than minimum will be assigned to the first bin, and any data value greater than maximum will be assigned to the last bin. Values falling on the boundary of adjacent bins will be assigned to the higher indexed bin. Only the first numPoints values are used.

Parameters

key	the series key (`null` not permitted).
values	the raw observations.
numPoints	only the first numPoints values are used.
bins	the number of bins (must be at least 1).
minimum	the lower bound of the bin range.
maximum	the upper bound of the bin range.

Definition at line 142 of file CustomHistogramDataset.java.

◆ clone()

Object umontreal.ssj.charts.CustomHistogramDataset.clone ( ) throws CloneNotSupportedException

Returns a clone of the dataset.

Returns: A clone of the dataset.

Exceptions

CloneNotSupportedException if the object cannot be cloned.

Definition at line 665 of file CustomHistogramDataset.java.

◆ equals()

boolean umontreal.ssj.charts.CustomHistogramDataset.equals ( Object obj )

Tests this dataset for equality with an arbitrary object.

Parameters

obj	the object to test against (`null` permitted).

Returns: A boolean.

Definition at line 647 of file CustomHistogramDataset.java.

◆ getBins()

List umontreal.ssj.charts.CustomHistogramDataset.getBins ( int series )

Returns the bins for a series.

Parameters

series the series index (in the range 0 to getSeriesCount() - 1).

Returns: A list of bins.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 275 of file CustomHistogramDataset.java.

◆ getBinWidth()

double umontreal.ssj.charts.CustomHistogramDataset.getBinWidth ( int series )

Returns the bin width for a series.

Parameters

series the series index (zero based).

Returns: The bin width.

Definition at line 474 of file CustomHistogramDataset.java.

◆ getEndX()

Number umontreal.ssj.charts.CustomHistogramDataset.getEndX	(	int	series,
		int	item )

Returns the end value for a bin.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
item	the item index (zero based).

Returns: The end value.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 598 of file CustomHistogramDataset.java.

◆ getEndY()

Number umontreal.ssj.charts.CustomHistogramDataset.getEndY	(	int	series,
		int	item )

Returns the end y-value for a bin (which is the same as the y-value).

This method exists only to support the general form of the IntervalXYDataset} interface.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
item	the item index (zero based).

Returns: The Y value.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 636 of file CustomHistogramDataset.java.

◆ getItemCount()

int umontreal.ssj.charts.CustomHistogramDataset.getItemCount ( int series )

Returns the number of data items for a series.

Parameters

series the series index (in the range 0 to getSeriesCount() - 1).

Returns: The item count.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 515 of file CustomHistogramDataset.java.

◆ getSeriesCount()

int umontreal.ssj.charts.CustomHistogramDataset.getSeriesCount ( )

Returns the number of series in the dataset.

Returns: The series count.

Definition at line 484 of file CustomHistogramDataset.java.

◆ getSeriesKey()

Comparable umontreal.ssj.charts.CustomHistogramDataset.getSeriesKey ( int series )

Returns the key for a series.

Parameters

series the series index (in the range 0 to getSeriesCount() - 1).

Returns: The series key.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 499 of file CustomHistogramDataset.java.

◆ getStartX()

Number umontreal.ssj.charts.CustomHistogramDataset.getStartX	(	int	series,
		int	item )

Returns the start value for a bin.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
item	the item index (zero based).

Returns: The start value.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 580 of file CustomHistogramDataset.java.

◆ getStartY()

Number umontreal.ssj.charts.CustomHistogramDataset.getStartY	(	int	series,
		int	item )

Returns the start y-value for a bin (which is the same as the y-value).

This method exists only to support the general form of the {IntervalXYDataset} interface.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
item	the item index (zero based).

Returns: The y-value.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 618 of file CustomHistogramDataset.java.

◆ getTotal()

int umontreal.ssj.charts.CustomHistogramDataset.getTotal ( int series )

Returns the total number of observations for a series.

Parameters

series the series index.

Returns: The total.

Definition at line 462 of file CustomHistogramDataset.java.

◆ getType()

HistogramType umontreal.ssj.charts.CustomHistogramDataset.getType ( )

Returns the histogram type.

Definition at line 65 of file CustomHistogramDataset.java.

◆ getValues()

double[] umontreal.ssj.charts.CustomHistogramDataset.getValues ( int series )

Returns the values for a series.

Parameters

series the series index (in the range 0 to getSeriesCount() - 1).

Returns: A table of values.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 381 of file CustomHistogramDataset.java.

◆ getValuesList()

List umontreal.ssj.charts.CustomHistogramDataset.getValuesList ( int series )

Returns the values for a series.

Parameters

series the series index (in the range 0 to getSeriesCount() - 1).

Returns: A list of values.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 365 of file CustomHistogramDataset.java.

◆ getX()

Number umontreal.ssj.charts.CustomHistogramDataset.getX	(	int	series,
		int	item )

Returns the X value for a bin.

This value won't be used for plotting histograms, since the renderer will ignore it. But other renderers can use it (for example, you could use the dataset to create a line chart).

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
item	the item index (zero based).

Returns: The start value.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 533 of file CustomHistogramDataset.java.

◆ getY()

Number umontreal.ssj.charts.CustomHistogramDataset.getY	(	int	series,
		int	item )

Returns the y-value for a bin (calculated to take into account the histogram type).

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
item	the item index (zero based).

Returns: The y-value.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 553 of file CustomHistogramDataset.java.

◆ setBins() [1/3]

void umontreal.ssj.charts.CustomHistogramDataset.setBins	(	int	series,
		HistogramBin	bins[] )

Sets the bins for a series.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
bins	the number of bins (must be at least 1).

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 342 of file CustomHistogramDataset.java.

◆ setBins() [2/3]

void umontreal.ssj.charts.CustomHistogramDataset.setBins	(	int	series,
		int	bins )

Sets the bins for a series.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
bins	the number of bins (must be at least 1).

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 290 of file CustomHistogramDataset.java.

◆ setBins() [3/3]

void umontreal.ssj.charts.CustomHistogramDataset.setBins	(	int	series,
		int	bins,
		double	minimum,
		double	maximum )

Sets the bins for a series.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
bins	the number of bins (must be at least 1).
minimum	the lower bound of the bin range.
maximum	the upper bound of the bin range.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 308 of file CustomHistogramDataset.java.

◆ setType()

void umontreal.ssj.charts.CustomHistogramDataset.setType ( HistogramType type )

Sets the histogram type and sends a DatasetChangeEvent to all registered listeners.

Parameters

type	the type (`null` not permitted).

Definition at line 75 of file CustomHistogramDataset.java.

◆ setValues() [1/2]

void umontreal.ssj.charts.CustomHistogramDataset.setValues	(	int	series,
		double	values[] )

Sets the values for a series.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
values	Table of new values.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 419 of file CustomHistogramDataset.java.

◆ setValues() [2/2]

void umontreal.ssj.charts.CustomHistogramDataset.setValues	(	int	series,
		List	valuesList )

Sets the values for a series.

Parameters

series	the series index (in the range `0` to `getSeriesCount() - 1`).
valuesList	List of new values.

Exceptions

IndexOutOfBoundsException if series is outside the specified range.

Definition at line 401 of file CustomHistogramDataset.java.

Member Data Documentation

◆ type

HistogramType umontreal.ssj.charts.CustomHistogramDataset.type

The histogram type.

Definition at line 51 of file CustomHistogramDataset.java.

The documentation for this class was generated from the following file:

src/main/java/umontreal/ssj/charts/CustomHistogramDataset.java

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CustomHistogramDataset()

Member Function Documentation

◆ addSeries() [1/6]

◆ addSeries() [2/6]

◆ addSeries() [3/6]

◆ addSeries() [4/6]

◆ addSeries() [5/6]

◆ addSeries() [6/6]

◆ clone()

◆ equals()

◆ getBins()

◆ getBinWidth()

◆ getEndX()

◆ getEndY()

◆ getItemCount()

◆ getSeriesCount()

◆ getSeriesKey()

◆ getStartX()

◆ getStartY()

◆ getTotal()

◆ getType()

◆ getValues()

◆ getValuesList()

◆ getX()

◆ getY()

◆ setBins() [1/3]

◆ setBins() [2/3]

◆ setBins() [3/3]

◆ setType()

◆ setValues() [1/2]

◆ setValues() [2/2]

Member Data Documentation

◆ type