Package nz.org.riskscape.defaults.curves

Class DefaultFitCurve<T>

java.lang.Object

nz.org.riskscape.defaults.curves.DefaultFitCurve<T>

All Implemented Interfaces:

FitCurve<T>

public class DefaultFitCurve<T>
extends Object
implements FitCurve<T>

Constructor Summary

Constructors

Constructor	Description
DefaultFitCurve(CurveFitter<T> fitter, nz.org.riskscape.engine.function.UntypedFunction function, T fitParameters, ObservedPoints observedPoints, Function<DefaultFitCurve<T>,Double> scoringFunction)

Method Summary

Modifier and Type	Method	Description
T	getFitParameters()
double	getFitScore()
CurveFitter<T>	getFitter()
nz.org.riskscape.engine.function.UntypedFunction	getFunction()
ObservedPoints	getObservedPoints()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFitCurve

public DefaultFitCurve(CurveFitter<T> fitter,
 nz.org.riskscape.engine.function.UntypedFunction function,
 T fitParameters,
 ObservedPoints observedPoints,
 Function<DefaultFitCurve<T>,Double> scoringFunction)

Method Details

getFitScore

public double getFitScore()

Specified by:

getFitScore in interface FitCurve<T>

Returns:

an r² value for this curve against the original data points

getFitter

public CurveFitter<T> getFitter()

Specified by:

getFitter in interface FitCurve<T>

Returns:

the thing that produced this fit

getFunction

public nz.org.riskscape.engine.function.UntypedFunction getFunction()

Specified by:

getFunction in interface FitCurve<T>

Returns:

the untyped part of a RiskscapeFunction that can be used to compute f(x) = y, should accept and return doubles.

getFitParameters

public T getFitParameters()

Specified by:

getFitParameters in interface FitCurve<T>

Returns:

the parameters, specific to each type of function, that were produced when this function was fit

getObservedPoints

public ObservedPoints getObservedPoints()

Specified by:

getObservedPoints in interface FitCurve<T>

Returns:

that dataset that was used to fit this curve