Package net.simplace.sim.util.statistics

Klasse ErrorCalculationMethod

java.lang.Object
net.simplace.sim.util.statistics.ErrorCalculationMethod
Bekannte direkte Unterklassen:
AgreementIndex, Bias, ConcordanceCorrelationCoefficient, CorrelationCoefficient, EF, MAE, MRE, MSE, RMAE, RMSE, RRMSE, SMAPE, VoidErrorCalculator
public abstract class ErrorCalculationMethod extends Object
Defines the abstract functions/procedures that a class needs to implement in order to be usable as an error calculation method by the LeastDifferenceSelector
Autor:
Gunther Krauss

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    protected int
    count
     
    protected double
    sum
     

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    ErrorCalculationMethod()
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    abstract void
    addDataPair(double observed, double calculated)
    Adds a pair of observed and calculated data to the list
    String
    getDescription()
    Gets the full name or a short description of the error method
    abstract String
    getLabel()
    Gets the label of the calculation method
    abstract double
    getValue()
    Calculates the (error)value from the list of pairs
    double
    getWorstValue()
    Returns the value that is considered worst by the error calculation method
    void
    init()
    Initializes the calculation method
    abstract boolean
    isBetter(double better, double worse)
    Checks if the first value is better than the second value with respect to the calcualtion method.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Felddetails

    • count

      protected int count

    • sum

      protected double sum

  • Konstruktordetails

    • ErrorCalculationMethod

      public ErrorCalculationMethod()

  • Methodendetails

    • init

      public void init()
      Initializes the calculation method

    • getWorstValue

      public double getWorstValue()
      Returns the value that is considered worst by the error calculation method
      Gibt zurück:
      worstValue

    • addDataPair

      public abstract void addDataPair(double observed, double calculated)
      Adds a pair of observed and calculated data to the list
      Parameter:
      observed -
      calculated -

    • getValue

      public abstract double getValue()
      Calculates the (error)value from the list of pairs
      Gibt zurück:
      errorvalue

    • isBetter

      public abstract boolean isBetter(double better, double worse)
      Checks if the first value is better than the second value with respect to the calcualtion method.
      Parameter:
      better -
      worse -
      Gibt zurück:
      true if first value is better than second

    • getLabel

      public abstract String getLabel()
      Gets the label of the calculation method
      Gibt zurück:
      label

    • getDescription

      public String getDescription()
      Gets the full name or a short description of the error method
      Gibt zurück:
      description or full name