csip.cosu

Class ObjFunc

java.lang.Object

csip.cosu.ObjFunc

public abstract class ObjFunc
extends java.lang.Object

Objective Functions.

Author:

od

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABSDIFF Absolute Difference
static java.lang.String	ABSDIFFLOG Log of Absolute Difference
static java.lang.String	AVE Average Volume Error
static java.lang.String	BIAS Bias
static java.lang.String	FHF
static java.lang.String	FLF
static java.lang.String	IOA Index of Agreement
static java.lang.String	IOA2
static java.lang.String	KGE Klinge-Gupta Efficiency; 2012
static java.lang.String	KGE09 Klinge-Gupta Efficiency; 2009
static java.lang.String	MNS Modified Nash-Sutcliffe Efficiency
static java.lang.String	MSE Mean Square Error
static java.lang.String	NS Nash-Sutcliffe Efficiency
static java.lang.String	NS2LOG
static java.lang.String	NSLOG1P
static java.lang.String	NSLOG2
static java.lang.String	PBIAS Percent Bias
static java.lang.String	PMCC
static java.lang.String	RMSE Root Mean Square Error
static java.lang.String	TRMSE Transformed RMSE

Constructor Summary

Constructors

Constructor and Description
ObjFunc()

Method Summary

Modifier and Type	Method and Description
abstract int	direction() In which direction is the OF progressing (1 positive, -1 negative direction)
abstract double	eval(double[] obs, double[] sim, double missing) evaluate the OF
static java.util.List<java.lang.String>	list() List available OFs.
abstract java.lang.String	name() The name of the OF.
static ObjFunc	of(java.lang.String name) Get an OF instance.
static ObjFunc	of(java.lang.String name, ObjFunc f) Fetch an OF instance or supply your own OF
abstract int	optimum() What is the optimal OF optimum value.

Methods inherited from class java.lang.Object

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

Field Detail

NS

public static final java.lang.String NS

Nash-Sutcliffe Efficiency

See Also:

Constant Field Values

MNS

public static final java.lang.String MNS

Modified Nash-Sutcliffe Efficiency

See Also:

Constant Field Values

KGE

public static final java.lang.String KGE

Klinge-Gupta Efficiency; 2012

See Also:

Constant Field Values

KGE09

public static final java.lang.String KGE09

Klinge-Gupta Efficiency; 2009

See Also:

Constant Field Values

NSLOG1P

public static final java.lang.String NSLOG1P

See Also:

Constant Field Values

NSLOG2

public static final java.lang.String NSLOG2

See Also:

Constant Field Values

NS2LOG

public static final java.lang.String NS2LOG

See Also:

Constant Field Values

TRMSE

public static final java.lang.String TRMSE

Transformed RMSE

See Also:

Constant Field Values

FHF

public static final java.lang.String FHF

See Also:

Constant Field Values

FLF

public static final java.lang.String FLF

See Also:

Constant Field Values

PBIAS

public static final java.lang.String PBIAS

Percent Bias

See Also:

Constant Field Values

BIAS

public static final java.lang.String BIAS

Bias

See Also:

Constant Field Values

RMSE

public static final java.lang.String RMSE

Root Mean Square Error

See Also:

Constant Field Values

MSE

public static final java.lang.String MSE

Mean Square Error

See Also:

Constant Field Values

PMCC

public static final java.lang.String PMCC

See Also:

Constant Field Values

IOA

public static final java.lang.String IOA

Index of Agreement

See Also:

Constant Field Values

IOA2

public static final java.lang.String IOA2

See Also:

Constant Field Values

AVE

public static final java.lang.String AVE

Average Volume Error

See Also:

Constant Field Values

ABSDIFF

public static final java.lang.String ABSDIFF

Absolute Difference

See Also:

Constant Field Values

ABSDIFFLOG

public static final java.lang.String ABSDIFFLOG

Log of Absolute Difference

See Also:

Constant Field Values

Constructor Detail

ObjFunc

public ObjFunc()

Method Detail

name

public abstract java.lang.String name()

The name of the OF.

Returns:

the OF name

eval

public abstract double eval(double[] obs,
                            double[] sim,
                            double missing)

evaluate the OF

Parameters:

obs - observed values

sim - simulated values

missing - missing value

Returns:

the of value

direction

public abstract int direction()

In which direction is the OF progressing (1 positive, -1 negative direction)

Returns:

the direction of improvement

optimum

public abstract int optimum()

What is the optimal OF optimum value.

Returns:

the target value

of

public static ObjFunc of(java.lang.String name)

Get an OF instance.

Parameters:

name - the OF name to get .

Returns:

The OF instance

of

public static ObjFunc of(java.lang.String name,
                         ObjFunc f)

Fetch an OF instance or supply your own OF

Parameters:

name - the OF name to get .

f - a custom OF if the name fails to resolve

Returns:

the OF instance.

list

public static java.util.List<java.lang.String> list()

List available OFs.

Returns:

the list of registered OF names