Package de.gsi.dataset.spi

Class FloatDataSet

java.lang.Object

de.gsi.dataset.spi.AbstractStylable<D>

de.gsi.dataset.spi.AbstractDataSet<FloatDataSet>

de.gsi.dataset.spi.FloatDataSet

All Implemented Interfaces:

DataSet, DataSet2D, DataSetMetaData, EditableDataSet, EventSource, java.io.Serializable

public class FloatDataSet
extends AbstractDataSet<FloatDataSet>
implements DataSet2D, EditableDataSet

Implementation of the DataSet interface which stores x,y values in two separate arrays. It provides methods allowing easily manipulate of data points.
User provides X and Y coordinates or only Y coordinates. In the former case X coordinates have value of data point index. This version being optimised for native float arrays.

Author:

rstein

See Also:

for an equivalent implementation with asymmetric errors in Y, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected it.unimi.dsi.fastutil.floats.FloatArrayList	xValues
protected it.unimi.dsi.fastutil.floats.FloatArrayList	yValues

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet

axisListener, dimension

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor	Description
FloatDataSet(DataSet another)	Creates a new instance of FloatDataSet as copy of another (deep-copy).
FloatDataSet(java.lang.String name)	Creates a new instance of FloatDataSet.
FloatDataSet(java.lang.String name, float[] xValues, float[] yValues, int initalSize, boolean deepCopy)	Creates a new instance of FloatDataSet.
FloatDataSet(java.lang.String name, int initalSize)	Creates a new instance of FloatDataSet.

Method Summary

Modifier and Type	Method	Description
FloatDataSet	add(float[] xValuesNew, float[] yValuesNew)	Initialises the data set with specified data.
FloatDataSet	add(float x, float y)	Add point to the end of the data set
FloatDataSet	add(float x, float y, java.lang.String label)	Add point to the DoublePoints object
FloatDataSet	add(int index, double... newValue)	add point to the data set
FloatDataSet	add(int index, double x, double y)	add point to the data set
FloatDataSet	add(int index, float[] x, float[] y)	add point to the data set
FloatDataSet	add(int index, float x, float y, java.lang.String label)	add point to the data set
FloatDataSet	clearData()	clear all data points
double	get(int dimIndex, int index)	Gets the x value of the data point with the index i
int	getCapacity()
int	getDataCount()	Get the number of data points in the data set.
float[]	getFloatValues(int dimIndex)
double[]	getValues(int dimIndex)
float[]	getXFloatValues()
float[]	getYFloatValues()
FloatDataSet	increaseCapacity(int amount)
EditableDataSet	remove(int index)	remove point from data set
FloatDataSet	remove(int fromIndex, int toIndex)	removes sub-range of data points
FloatDataSet	resize(int size)	ensures minimum size, enlarges if necessary
FloatDataSet	set(float[] xValues, float[] yValues)	Initialises the data set with specified data.
FloatDataSet	set(float[] xValues, float[] yValues, boolean copy)	Initialises the data set with specified data.
FloatDataSet	set(float[] xValues, float[] yValues, int nSamples, boolean copy)	Initialises the data set with specified data.
FloatDataSet	set(int index, double... newValue)	replaces point coordinate of existing data point
FloatDataSet	set(int index, double[] x, double[] y)
FloatDataSet	set(int index, double x, double y)
FloatDataSet	set(DataSet other, boolean copy)	clear old data and overwrite with data from 'other' data set (deep copy)
FloatDataSet	trim()	Trims the arrays list so that the capacity is equal to the size.

Methods inherited from class de.gsi.dataset.spi.AbstractDataSet

addDataLabel, addDataStyle, autoNotification, binarySearch, binarySearch, clearMetaInfo, copyAxisDescription, copyDataLabelsAndStyles, copyMetaData, equalDataLabels, equalEditConstraints, equalErrorValues, equalMetaData, equals, equals, equalValues, fireInvalidated, getAxisDescriptions, getDataLabel, getDataLabelMap, getDataStyleMap, getDimension, getEditConstraints, getErrorList, getIndex, getInfoList, getMetaInfo, getName, getStyle, getThis, getValue, getWarningList, hashCode, lock, recomputeLimits, removeDataLabel, removeStyle, setEditConstraints, setName, toString, updateEventListener

Methods inherited from class de.gsi.dataset.spi.AbstractStylable

getStyle, setStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.dataset.DataSet

getAxisDescription, getAxisDescriptions, getDataLabel, getIndex, getName, getStyle, getStyle, getValue, lock, recomputeLimits, set, setStyle

Methods inherited from interface de.gsi.dataset.DataSet2D

getDimension, getValue, getX, getXIndex, getXValues, getY, getYIndex, getYValues

Methods inherited from interface de.gsi.dataset.EditableDataSet

getEditConstraints, setEditConstraints, setName

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, autoNotification, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListener

Field Detail

xValues

protected it.unimi.dsi.fastutil.floats.FloatArrayList xValues

yValues

protected it.unimi.dsi.fastutil.floats.FloatArrayList yValues

Constructor Detail

FloatDataSet

public FloatDataSet(DataSet another)

Creates a new instance of FloatDataSet as copy of another (deep-copy).

Parameters:

another - name of this DataSet.

FloatDataSet

public FloatDataSet(java.lang.String name)

Creates a new instance of FloatDataSet.

Parameters:

name - name of this DataSet.

Throws:

java.lang.IllegalArgumentException - if name is null

FloatDataSet

public FloatDataSet(java.lang.String name,
                    float[] xValues,
                    float[] yValues,
                    int initalSize,
                    boolean deepCopy)

Creates a new instance of FloatDataSet.

The user than specify via the copy parameter, whether the dataset operates directly on the input arrays themselves or on a copies of the input arrays. If the dataset operates directly on the input arrays, these arrays must not be modified outside of this data set.

Parameters:

name - name of this data set.

xValues - X coordinates

yValues - Y coordinates

initalSize - initial buffer size

deepCopy - if true, the input array is copied

Throws:

java.lang.IllegalArgumentException - if any of parameters is null or if arrays with coordinates have different lengths

FloatDataSet

public FloatDataSet(java.lang.String name,
                    int initalSize)

Creates a new instance of FloatDataSet.

Parameters:

name - name of this DataSet.

initalSize - initial buffer size

Throws:

java.lang.IllegalArgumentException - if name is null

Method Detail

add

public FloatDataSet add(float x,
                        float y)

Add point to the end of the data set

Parameters:

x - index

y - index

Returns:

itself

add

public FloatDataSet add(float x,
                        float y,
                        java.lang.String label)

Add point to the DoublePoints object

Parameters:

x - index

y - index

label - the data label

Returns:

itself

add

public FloatDataSet add(float[] xValuesNew,
                        float[] yValuesNew)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValuesNew - X coordinates

yValuesNew - Y coordinates

Returns:

itself

add

public FloatDataSet add(int index,
                        double... newValue)

add point to the data set

Specified by:

add in interface EditableDataSet

Parameters:

index - data point index at which the new data point should be added

newValue - new data point coordinate

Returns:

itself (fluent design)

add

public FloatDataSet add(int index,
                        double x,
                        double y)

add point to the data set

Parameters:

index - data point index at which the new data point should be added

x - horizontal coordinate of the new data point

y - vertical coordinate of the new data point

Returns:

itself (fluent design)

add

public FloatDataSet add(int index,
                        float x,
                        float y,
                        java.lang.String label)

add point to the data set

Parameters:

index - data point index at which the new data point should be added

x - horizontal coordinates of the new data point

y - vertical coordinates of the new data point

label - data point label (see CategoryAxis)

Returns:

itself (fluent design)

add

public FloatDataSet add(int index,
                        float[] x,
                        float[] y)

add point to the data set

Parameters:

index - data point index at which the new data point should be added

x - horizontal coordinate of the new data point

y - vertical coordinate of the new data point

Returns:

itself (fluent design)

clearData

public FloatDataSet clearData()

clear all data points

Returns:

itself (fluent design)

get

public double get(int dimIndex,
                  int index)

Description copied from interface: DataSet

Gets the x value of the data point with the index i

Specified by:

get in interface DataSet

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

index - data point index

Returns:

the x value

getCapacity

public int getCapacity()

Returns:

storage capacity of dataset

getDataCount

public int getDataCount()

Description copied from interface: DataSet

Get the number of data points in the data set.

Specified by:

getDataCount in interface DataSet

Returns:

the number of data points

increaseCapacity

public FloatDataSet increaseCapacity(int amount)

Parameters:

amount - storage capacity increase

Returns:

itself (fluent design)

remove

public EditableDataSet remove(int index)

remove point from data set

Specified by:

remove in interface EditableDataSet

Parameters:

index - data point which should be removed

Returns:

itself (fluent design)

remove

public FloatDataSet remove(int fromIndex,
                           int toIndex)

removes sub-range of data points

Parameters:

fromIndex - start index

toIndex - stop index

Returns:

itself (fluent design)

resize

public FloatDataSet resize(int size)

ensures minimum size, enlarges if necessary

Parameters:

size - the actually used array lengths

Returns:

itself (fluent design)

set

public FloatDataSet set(DataSet other,
                        boolean copy)

clear old data and overwrite with data from 'other' data set (deep copy)

Specified by:

set in interface DataSet

Parameters:

other - the source data set

copy - true: perform a deep copy (default), false: reuse the other dataset's internal data structures (if applicable)

Returns:

itself (fluent design)

set

public FloatDataSet set(float[] xValues,
                        float[] yValues)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

Returns:

itself

set

public FloatDataSet set(float[] xValues,
                        float[] yValues,
                        boolean copy)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

copy - true: makes an internal copy, false: use the pointer as is (saves memory allocation

Returns:

itself

set

public FloatDataSet set(float[] xValues,
                        float[] yValues,
                        int nSamples,
                        boolean copy)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

nSamples - number of samples to be copied

copy - true: makes an internal copy, false: use the pointer as is (saves memory allocation

Returns:

itself

set

public FloatDataSet set(int index,
                        double... newValue)

replaces point coordinate of existing data point

Specified by:

set in interface EditableDataSet

Parameters:

index - data point index at which the new data point should be added

newValue - new data point coordinate

Returns:

itself (fluent design)

set

public FloatDataSet set(int index,
                        double x,
                        double y)

set

public FloatDataSet set(int index,
                        double[] x,
                        double[] y)

trim

public FloatDataSet trim()

Trims the arrays list so that the capacity is equal to the size.

Returns:

itself (fluent design)

See Also:

ArrayList.trimToSize()

getFloatValues

public float[] getFloatValues(int dimIndex)

Parameters:

dimIndex - Dimension to get values for

Returns:

the float array with the values

getValues

public double[] getValues(int dimIndex)

Specified by:

getValues in interface DataSet

Overrides:

getValues in class AbstractDataSet<FloatDataSet>

Parameters:

dimIndex - Dimension to get values for

Returns:

the double array with the values

getXFloatValues

public float[] getXFloatValues()

getYFloatValues

public float[] getYFloatValues()