de.jstacs.algorithms.optimization
Class NegativeDifferentiableFunction

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

public class NegativeDifferentiableFunction
extends DifferentiableFunction

The Function -f for a given function f.

Author:
Jens Keilwagen

Constructor Summary
NegativeDifferentiableFunction(DifferentiableFunction f)
           
 
Method Summary
 double evaluateFunction(double[] x)
          Evaluates the function at a certain vector (in mathematical sense) x
 double[] evaluateGradientOfFunction(double[] x)
          Evaluates the gradient of function at a certain vector (in mathematical sense) x
 int getDimensionOfScope()
          Returns the dimension of the scope of the function.
 
Methods inherited from class de.jstacs.algorithms.optimization.DifferentiableFunction
findOneDimensionalMin
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NegativeDifferentiableFunction

public NegativeDifferentiableFunction(DifferentiableFunction f)
Parameters:
f - the differentiable 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

Parameters:
x - the current vector
Returns:
the elvaluation of the function
Throws:
DimensionException - if dim(x) != n, with f: R^n -> R
EvaluationException - if there was a mistake in evaluating the function

getDimensionOfScope

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

Returns:
dimension of the scope; n, with f: R^n -> R

evaluateGradientOfFunction

public double[] evaluateGradientOfFunction(double[] x)
                                    throws DimensionException,
                                           EvaluationException
Description copied from class: DifferentiableFunction
Evaluates the gradient of function at a certain vector (in mathematical sense) x

Specified by:
evaluateGradientOfFunction in class DifferentiableFunction
Parameters:
x - the current vector
Returns:
the elvaluation of the gradient of a function; has dimension getDimensionOfScope()
Throws:
DimensionException - if dim(x) != n, with f: R^n -> R
EvaluationException - if there was a mistake in evaluating the gradient
See Also:
Function.getDimensionOfScope()