gov.usgs.earthquake.nshmp.function

Class AbstractXY_DataSet

java.lang.Object

gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

All Implemented Interfaces:

XY_DataSet, Named, Iterable<Point2D>

Direct Known Subclasses:

AbstractDiscretizedFunc

public abstract class AbstractXY_DataSet
extends Object
implements XY_DataSet

Field Summary

Fields

Modifier and Type	Field and Description
protected String	info Information about this function, will be used in making the legend from a parameter list of variables
protected String	name Name of the function, useful for differentiation different instances of a function, such as in an array of functions.
protected String	xAxisName
protected String	yAxisName

Constructor Summary

Constructors

Constructor and Description
AbstractXY_DataSet()

Method Summary

Modifier and Type	Method and Description
boolean	areAllXValuesInteger(double tolerance) It finds out whether the X values are within tolerance of an integer value
double	getClosestX(double y) Get the X value for the point with closest Y
double	getClosestY(double x) Get the Y value for the point with closest X
String	getInfo() Returns the info of this function.
String	getXAxisName() Gets the name of the X Axis
Iterator<Double>	getXValuesIterator() Returns an iterator over all x-values in the list.
String	getYAxisName() Gets the name of the Y Axis
Iterator<Double>	getYValuesIterator() Returns an iterator over all y-values in the list.
Iterator<Point2D>	iterator()
String	name() Returns an object's display name.
void	setInfo(String info) Sets the info string of this function.
void	setName(String name) Sets the name of this function.
void	setXAxisName(String xName) Sets the name of the X Axis
void	setYAxisName(String yName) Sets the name of the X Axis
List<Double>	xValues()
List<Double>	yValues()

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.usgs.earthquake.nshmp.function.XY_DataSet

deepClone, get, getMaxX, getMaxY, getMetadataString, getMinX, getMinY, getNum, getX, getY, hasPoint, hasPoint, set, set, set, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

info

protected String info

Information about this function, will be used in making the legend from a parameter list of variables

name

protected String name

Name of the function, useful for differentiation different instances of a function, such as in an array of functions.

xAxisName

protected String xAxisName

yAxisName

protected String yAxisName

Constructor Detail

AbstractXY_DataSet

public AbstractXY_DataSet()

Method Detail

name

public String name()

Description copied from interface: Named

Returns an object's display name.

Specified by:

name in interface Named

Returns:

the name

setName

public void setName(String name)

Sets the name of this function.

Specified by:

setName in interface XY_DataSet

getInfo

public String getInfo()

Returns the info of this function.

Specified by:

getInfo in interface XY_DataSet

setInfo

public void setInfo(String info)

Sets the info string of this function.

Specified by:

setInfo in interface XY_DataSet

setXAxisName

public void setXAxisName(String xName)

Description copied from interface: XY_DataSet

Sets the name of the X Axis

Specified by:

setXAxisName in interface XY_DataSet

Parameters:

xName - String

getXAxisName

public String getXAxisName()

Description copied from interface: XY_DataSet

Gets the name of the X Axis

Specified by:

getXAxisName in interface XY_DataSet

setYAxisName

public void setYAxisName(String yName)

Description copied from interface: XY_DataSet

Sets the name of the X Axis

Specified by:

setYAxisName in interface XY_DataSet

Parameters:

yName - String

getYAxisName

public String getYAxisName()

Description copied from interface: XY_DataSet

Gets the name of the Y Axis

Specified by:

getYAxisName in interface XY_DataSet

getClosestX

public double getClosestX(double y)

Description copied from interface: XY_DataSet

Get the X value for the point with closest Y

Specified by:

getClosestX in interface XY_DataSet

getClosestY

public double getClosestY(double x)

Description copied from interface: XY_DataSet

Get the Y value for the point with closest X

Specified by:

getClosestY in interface XY_DataSet

areAllXValuesInteger

public boolean areAllXValuesInteger(double tolerance)

It finds out whether the X values are within tolerance of an integer value

Specified by:

areAllXValuesInteger in interface XY_DataSet

Parameters:

tolerance - value to consider rounding errors

Returns:

true if all X values are within the tolerance of an integer value else returns false

getXValuesIterator

public Iterator<Double> getXValuesIterator()

Returns an iterator over all x-values in the list. Results returned in sorted order. Returns null if no points present.

Specified by:

getXValuesIterator in interface XY_DataSet

getYValuesIterator

public Iterator<Double> getYValuesIterator()

Returns an iterator over all y-values in the list. Results returned in sorted order along the x-axis. Returns null if no points present.

Specified by:

getYValuesIterator in interface XY_DataSet

iterator

public Iterator<Point2D> iterator()

Specified by:

iterator in interface Iterable<Point2D>

xValues

public List<Double> xValues()

Specified by:

xValues in interface XY_DataSet

yValues

public List<Double> yValues()

Specified by:

yValues in interface XY_DataSet