de.jstacs.algorithms.optimization

Class OneDimensionalSubFunction

java.lang.Object

de.jstacs.algorithms.optimization.OneDimensionalFunction

de.jstacs.algorithms.optimization.OneDimensionalSubFunction

All Implemented Interfaces:

Function

public class OneDimensionalSubFunction
extends OneDimensionalFunction

This class is used to do the line search.

Author:

Jens Keilwagen

Constructor Summary

Constructors

Constructor and Description
OneDimensionalSubFunction(Function f) Creates a new OneDimensionalSubFunction from a Function f for the line search.

Method Summary

Modifier and Type	Method and Description
double	evaluateFunction(double x) Evaluates the function at position x.
void	set(double[] current, double[] d) Sets the current values and direction.

Methods inherited from class de.jstacs.algorithms.optimization.OneDimensionalFunction

evaluateFunction, findMin, getDimensionOfScope

Methods inherited from class java.lang.Object

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

Constructor Detail

OneDimensionalSubFunction

public OneDimensionalSubFunction(Function f)

Creates a new OneDimensionalSubFunction from a Function f for the line search.

Parameters:

f - the high dimensional function

See Also:

set(double[], double[])

Method Detail

evaluateFunction

public double evaluateFunction(double x)
                        throws EvaluationException

Description copied from class: OneDimensionalFunction

Evaluates the function at position x.

Specified by:

evaluateFunction in class OneDimensionalFunction

Parameters:

x - the current position

Returns:

f(x)

Throws:

EvaluationException - if there was a mistake during evaluation of the function

set

public void set(double[] current,
                double[] d)
         throws DimensionException

Sets the current values and direction.

Parameters:

current - the current vector

d - the direction along which the line search will be performed

Throws:

DimensionException - if there is something wrong with the dimension of a vector