gov.usgs.earthquake.nshmp.function

Class AbstractDiscretizedFunc

java.lang.Object

gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

gov.usgs.earthquake.nshmp.function.AbstractDiscretizedFunc

All Implemented Interfaces:

DiscretizedFunc, XY_DataSet, Named, Iterable<Point2D>

Direct Known Subclasses:

ArbitrarilyDiscretizedFunc, EvenlyDiscretizedFunc

public abstract class AbstractDiscretizedFunc
extends AbstractXY_DataSet
implements DiscretizedFunc

Title: DiscretizedFunc

Description: Abstract implementation of the DiscretizedFuncAPI. Performs standard simple or default functions so that subclasses don't have to keep reimplementing the same function bodies.

A Discretized Function is a collection of x and y values grouped together as the points that describe a function. A discretized form of a function is the only ways computers can represent functions. Instead of having y=x^2, you would have a sample of possible x and y values.

The basic functions this abstract class implements are:

• get, set Name()
• get, set, Info()
• get, set, Tolerance()
• equals() - returns true if all three fields have the same values.

See the interface documentation for further explanation of this framework

Version:

1.0

Author:

Steven W. Rock

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	C Class name used for debbuging
protected static boolean	D if true print out debugging statements
protected double	tolerance The tolerance allowed in specifying a x-value near a real x-value, so that the real x-value is used.

Fields inherited from class gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

info, name, xAxisName, yAxisName

Constructor Summary

Constructors

Constructor and Description
AbstractDiscretizedFunc()

Method Summary

Modifier and Type	Method and Description
double	calcSumOfY_Vals()
boolean	equals(Object obj) Default equals for all Discretized Functions.
double	getTolerance() Returns the tolerance of this function.
void	scale(double val) Scales (multiplies) the y-values of this function by the esupplied value.
void	setTolerance(double newTolerance) Sets the tolerance of this function.

Methods inherited from class gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

areAllXValuesInteger, getClosestX, getClosestY, getInfo, getXAxisName, getXValuesIterator, getYAxisName, getYValuesIterator, iterator, name, setInfo, setName, setXAxisName, setYAxisName, xValues, yValues

Methods inherited from class java.lang.Object

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

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

deepClone, getFirstInterpolatedX_inLogXLogYDomain, getFirstInterpolatedX, getIndex, getInterpolatedY_inLogXLogYDomain, getInterpolatedY_inLogYDomain, getInterpolatedY, getXIndex, getY

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

areAllXValuesInteger, get, getClosestX, getClosestY, getInfo, getMaxX, getMaxY, getMetadataString, getMinX, getMinY, getNum, getX, getXAxisName, getXValuesIterator, getY, getYAxisName, getYValuesIterator, hasPoint, hasPoint, set, set, set, setInfo, setName, setXAxisName, setYAxisName, toString, xValues, yValues

Methods inherited from interface gov.usgs.earthquake.nshmp.util.Named

name

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

C

protected static final String C

Class name used for debbuging

See Also:

Constant Field Values

D

protected static final boolean D

if true print out debugging statements

See Also:

Constant Field Values

tolerance

protected double tolerance

The tolerance allowed in specifying a x-value near a real x-value, so that the real x-value is used. Note that the tolerance must be smaller than 1/2 the delta between data points for evenly discretized function, no restriction for arb discretized function, no standard delta.

Constructor Detail

AbstractDiscretizedFunc

public AbstractDiscretizedFunc()

Method Detail

getTolerance

public double getTolerance()

Returns the tolerance of this function.

Specified by:

getTolerance in interface DiscretizedFunc

setTolerance

public void setTolerance(double newTolerance)

Sets the tolerance of this function.

Specified by:

setTolerance in interface DiscretizedFunc

Throws:

IllegalArgumentException - if tolerance is less than zero

equals

public boolean equals(Object obj)

Default equals for all Discretized Functions. Determines if two functions are the same by comparing that the name, info, and values are the same.

Overrides:

equals in class Object

calcSumOfY_Vals

public double calcSumOfY_Vals()

scale

public void scale(double val)

Description copied from interface: DiscretizedFunc

Scales (multiplies) the y-values of this function by the esupplied value.

Specified by:

scale in interface DiscretizedFunc