de.jstacs.algorithms.optimization

Interface Function

All Known Subinterfaces:

MultiThreadedFunction

All Known Implementing Classes:

AbstractMultiThreadedOptimizableFunction, AbstractOptimizableFunction, CompositeLogPrior, DifferentiableFunction, DiffSSBasedOptimizableFunction, DoesNothingLogPrior, LogGenDisMixFunction, LogPrior, MEMTools.DualFunction, NegativeDifferentiableFunction, NegativeFunction, NegativeOneDimensionalFunction, NumericalDifferentiableFunction, OneDataSetLogGenDisMixFunction, OneDimensionalFunction, OneDimensionalSubFunction, OptimizableFunction, QuadraticFunction, SeparateGaussianLogPrior, SeparateLaplaceLogPrior, SeparateLogPrior, SimpleGaussianSumLogPrior

public interface Function

This interface is the framework for any mathematical function .

Author:

Jens Keilwagen

Method Summary

Modifier and Type	Method and Description
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 evaluation of the function

Throws:

DimensionException - if dim(x) != n, with

EvaluationException - if there was something wrong during the evaluation of the function

getDimensionOfScope

int getDimensionOfScope()

Returns the dimension of the scope of the Function.

Returns:

the dimension of the scope: n with