Package com.irurueta.numerical.fitting

Class Fitter

java.lang.Object
com.irurueta.numerical.fitting.Fitter
Direct Known Subclasses:
MultiDimensionFitter, MultiVariateFitter, SingleDimensionFitter, StraightLineFitter
public abstract class Fitter extends Object
Base class for function fitters used to estimate function parameters along with their covariance matrix and chi square value

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    resultAvailable
    Indicates whether result has been estimated and is available for retrieval

  • Constructor Summary

    Constructors
    Constructor
    Description
    Fitter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    fit()
    Fits a function to provided data so that parameters associated to that function can be estimated along with their covariance matrix and chi square value
    abstract boolean
    isReady()
    Indicates whether this instance is ready because enough input data has been provided to start the fitting process
    boolean
    isResultAvailable()
    Returns boolean indicating whether result has been estimated and is available for retrieval

    Methods inherited from class java.lang.Object

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

  • Field Details

    • resultAvailable

      protected boolean resultAvailable
      Indicates whether result has been estimated and is available for retrieval

  • Constructor Details

    • Fitter

      public Fitter()

  • Method Details

    • isResultAvailable

      public boolean isResultAvailable()
      Returns boolean indicating whether result has been estimated and is available for retrieval
      Returns:
      true if result has been estimated and is available for retrieval

    • isReady

      public abstract boolean isReady()
      Indicates whether this instance is ready because enough input data has been provided to start the fitting process
      Returns:
      true if this fitter is ready, false otherwise

    • fit

      public abstract void fit() throws FittingException, NotReadyException
      Fits a function to provided data so that parameters associated to that function can be estimated along with their covariance matrix and chi square value
      Throws:
      FittingException - if fitting fails
      NotReadyException - if enough input data has not yet been provided