ilog.views.chart.data

Class IlvFunctionDataSet

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSet

ilog.views.chart.data.IlvFunctionDataSet

All Implemented Interfaces:

IlvDataSet, IlvBatchable, Serializable

public abstract class IlvFunctionDataSet
extends IlvAbstractDataSet

A data set implemented as a function call. The data points of this data set are computed according to the following criteria:

• A definition domain [xMin,xMax].
• A data count.
• A function of the type y=f(x), implemented by the callFunction(double) abstract method.

The definition domain is split into dataCount discrete values. The coordinates of the ith data point are as follows:

 x = (xMax-xMin)/(dataCount-1)*i + xMin
 y = f(x)
 

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.data.IlvAbstractDataSet

DEFAULT_UNDEF_VALUE

Constructor Summary

Constructors

Constructor and Description
IlvFunctionDataSet(double xMin, double xMax, int dataCount) Creates a new function data set with the specified definition domain.

Method Summary

Modifier and Type	Method and Description
abstract double	callFunction(double val) Calls the function for the specified value.
protected void	computeLimits(IlvDataInterval xRange, IlvDataInterval yRange) Computes the limits of the values stored in this data set.
int	getDataCount() Returns the number of data points held by this data set.
double	getMinimumXDifference() Returns the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order.
double	getXData(int idx) Returns the X-value of the data point at the specified index.
double	getYData(int idx) Returns the Y-value of the data point at the specified index.
boolean	isXValuesSorted() Indicates whether the X values of the data points managed by this data set are sorted into increasing order.
void	setDefinition(double xMin, double xMax, int dataCount) Sets the definition domain of the function.

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSet

addData, addDataSetListener, computeMinimumXDifference, dataAdded, dataChanged, endBatch, fireDataAddedEvent, fireDataChangedEvent, fireDataSetContentsEvent, fireDataSetPropertyEvent, getData, getDataBetween, getDataInside, getDataInside, getDataLabel, getName, getProperty, getUndefValue, getXRange, getXRange, getYRange, getYRange, invalidateLimits, invalidateLimits, invalidateLimits, isBatched, isEditable, isXRangeIncludingUndefinedPoints, putProperty, removeDataSetListener, setData, setLimitsValid, setName, setUndefValue, setXRangeIncludingUndefinedPoints, startBatch, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFunctionDataSet

public IlvFunctionDataSet(double xMin,
                          double xMax,
                          int dataCount)

Creates a new function data set with the specified definition domain.

See Also:

setDefinition(double, double, int)

Method Detail

getDataCount

public int getDataCount()

Returns the number of data points held by this data set.

Specified by:

getDataCount in interface IlvDataSet

Specified by:

getDataCount in class IlvAbstractDataSet

setDefinition

public void setDefinition(double xMin,
                          double xMax,
                          int dataCount)

Sets the definition domain of the function.

getXData

public double getXData(int idx)

Returns the X-value of the data point at the specified index.

Specified by:

getXData in interface IlvDataSet

Specified by:

getXData in class IlvAbstractDataSet

Parameters:

idx - a data point index, >= 0, < getDataCount()

getYData

public double getYData(int idx)

Returns the Y-value of the data point at the specified index.

Specified by:

getYData in interface IlvDataSet

Specified by:

getYData in class IlvAbstractDataSet

Parameters:

idx - a data point index, >= 0, < getDataCount()

isXValuesSorted

public boolean isXValuesSorted()

Indicates whether the X values of the data points managed by this data set are sorted into increasing order. This method always returns true.

Specified by:

isXValuesSorted in interface IlvDataSet

Overrides:

isXValuesSorted in class IlvAbstractDataSet

getMinimumXDifference

public double getMinimumXDifference()

Returns the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order. May return -1 or a positive value if this data set is not empty but all X values are the same. May return -2 or a positive value if this data set is empty.

Note: This method may be slow, depending on the other characteristics of this data set. If you want to provide this information, instead of having it computed each time it is needed, you can do so by calling IlvDataSetProperty.setCategory(IlvDataSet, Double).

Overrides:

getMinimumXDifference in class IlvAbstractDataSet

callFunction

public abstract double callFunction(double val)

Calls the function for the specified value.

computeLimits

protected void computeLimits(IlvDataInterval xRange,
                             IlvDataInterval yRange)

Computes the limits of the values stored in this data set.

Overrides:

computeLimits in class IlvAbstractDataSet

Parameters:

xRange - Returns the definition domain of the function.

yRange - Returns the Y values range.

See Also:

IlvAbstractDataSet.isXRangeIncludingUndefinedPoints()