org.opensha.commons.data.function
Interface FuncWithParams

All Known Implementing Classes:

ArbDiscrFuncWithParams, EvenlyDiscrFuncWithParams

public interface FuncWithParams

Title: FuncWithParamsAPI

Description: Any function that supports a parameter list should implement this interface. This interface is for Functions that contain parameter lists. These lists are currently used for storing the parameter name and values that went into constructing the list, such as for an IMR exceedence probability.

This interface was developed to be used by DiscretizedFuncAPI subclasses. Of course any class that constains a ParameterList can implement this.

Version:

1.0

Author:

Steven W. Rock

See Also:

ParameterList, Parameter

Method Summary

boolean	equalParameterNames(FuncWithParams function) Returns true if the second function has the same named parameters in it's list, values may be different.
boolean	equalParameterNamesAndValues(FuncWithParams function) Returns true if the second function has the same named parameter values.
ParameterList	getParameterList() This parameter list is the set of parameters that went into calculation this function.
String	getParametersString() Returns name/value pairs of all the parametes in the ParameterList stored in this DiscretizedFunc, separated with commas, as one string, usefule for legends, etc.
void	setParameterList(ParameterList list) Set the Parameter list that went into calculating this function

Method Detail

getParametersString

String getParametersString()

Returns name/value pairs of all the parametes in the ParameterList stored in this DiscretizedFunc, separated with commas, as one string, usefule for legends, etc.

equalParameterNamesAndValues

boolean equalParameterNamesAndValues(FuncWithParams function)

Returns true if the second function has the same named parameter values. One current use is to determine if two XYDiscretizedFunction2DAPIs are the same.

equalParameterNames

boolean equalParameterNames(FuncWithParams function)

Returns true if the second function has the same named parameters in it's list, values may be different. Can be used to say that two lists are different instances of the same function, i.e. same function with different input parameters.

getParameterList

ParameterList getParameterList()

This parameter list is the set of parameters that went into calculation this function. Useful for determining if two data sets are the same, i.e. have the same x/y axis and the same set of independent parameters.

Note: Another way to say that two functions are the same is if each DataPoint is the same. That is much more numerically intensive task of comparing each Point2D using equals(). It depends on your business logic how to determine if two lists are the same.

setParameterList

void setParameterList(ParameterList list)

Set the Parameter list that went into calculating this function