de.jstacs.algorithms.optimization
Class NegativeFunction

java.lang.Object
  extended by de.jstacs.algorithms.optimization.NegativeFunction
All Implemented Interfaces:
Function

public class NegativeFunction
extends Object
implements Function

The negative function -f for a given Function f.

Author:
Jens Keilwagen

Constructor Summary
NegativeFunction(Function f)
          Creates the Function f for which -f should be calculated.
 
Method Summary
 double evaluateFunction(double[] x)
          Evaluates the function at a certain vector (in mathematical sense) x.
 int getDimensionOfScope()
          Returns the dimension of the scope of the Function.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NegativeFunction

public NegativeFunction(Function f)
Creates the Function f for which -f should be calculated.

Parameters:
f - the Function
Method Detail

evaluateFunction

public double evaluateFunction(double[] x)
                        throws DimensionException,
                               EvaluationException
Description copied from interface: Function
Evaluates the function at a certain vector (in mathematical sense) x.

Specified by:
evaluateFunction in interface Function
Parameters:
x - the current vector
Returns:
the evaluation of the function
Throws:
DimensionException - if dim(x) != n, with $f: \mathbb{R}^n \to \mathbb{R}$
EvaluationException - if there was something wrong during the evaluation of the function

getDimensionOfScope

public int getDimensionOfScope()
Description copied from interface: Function
Returns the dimension of the scope of the Function.

Specified by:
getDimensionOfScope in interface Function
Returns:
the dimension of the scope: n with $f: \mathbb{R}^n \to \mathbb{R}$