de.jstacs.algorithms.optimization
Interface Function

All Known Implementing Classes:
DifferentiableFunction, DoesNothingLogPrior, LogPrior, NegativeDifferentiableFunction, NegativeFunction, NegativeOneDimensionalFunction, NormConditionalLogLikelihood, NumericalDifferentiableFunction, OneDimensionalFunction, OneDimensionalSubFunction, OptimizableFunction, QuadraticFunction, SeparateGaussianLogPrior, SeparateLaplaceLogPrior, SeparateLogPrior, SimpleGaussianSumLogPrior

public interface Function

This interface is the framework for any mathematical function f: R^n -> R.

Author:
Jens Keilwagen

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.
 

Method Detail

evaluateFunction

double evaluateFunction(double[] x)
                        throws DimensionException,
                               EvaluationException
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

int getDimensionOfScope()
Returns the dimension of the scope of the function.

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