ObjectiveFunction (HM Gears 0.10.7 API)

All Known Implementing Classes:

AbsoluteDifference, AbsoluteDifferenceLog, NashSutcliffe, NormalizedRMSE, PearsonsCorrelation
```
public interface ObjectiveFunction
```
Objective Function. Interface for providing a objective function implementation.

Author:

makiko, od

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`double`	`calculate(double[] obs, double[] sim, double missingValue)`	Calculates the objective function value based on the given simulated and observed values.
`boolean`	`positiveDirection()`	This method tells you if it is good for the objective function value to be large.

- Method Detail
  - calculate
```
double calculate(double[] obs,
                 double[] sim,
                 double missingValue)
```
    Calculates the objective function value based on the given simulated and observed values. If measuredValue[i] <= missingValue (where 0<=i
    
    Parameters:
    
    obs - the observed values
    
    sim - the simulated values
    
    missingValue - the missing value that indicates a observed or/and simulated value is missing
    
    Returns:
    
    the objective function value.
  - positiveDirection
```
boolean positiveDirection()
```
    This method tells you if it is good for the objective function value to be large.
    
    Returns:
    
    true if a greater objective function value is considered better. false is returned otherwise.