TooN::Internal::LineSearch< Size, Precision, Func > Struct Template Reference
[Function optimization]

#include <conjugate_gradient.h>

List of all members.

Public Member Functions

 LineSearch (const Vector< Size, Precision > &s, const Vector< Size, Precision > &d, const Func &func)
Precision operator() (Precision x) const

Public Attributes

const Vector< Size, Precision > & direction
 $\Vec{d}$
const Func & f
 $f(\cdotp)$
const Vector< Size, Precision > & start
 $\Vec{s}$

Detailed Description

template<int Size, typename Precision, typename Func>
struct TooN::Internal::LineSearch< Size, Precision, Func >

Turn a multidimensional function in to a 1D function by specifying a point and direction. A nre function is defined:

\[ g(a) = \Vec{s} + a \Vec{d} \]

Definition at line 11 of file conjugate_gradient.h.


Constructor & Destructor Documentation

template<int Size, typename Precision, typename Func>
TooN::Internal::LineSearch< Size, Precision, Func >::LineSearch ( const Vector< Size, Precision > &  s,
const Vector< Size, Precision > &  d,
const Func &  func 
) [inline]

Set up the line search class.

Parameters:
s Start point, $\Vec{s}$.
d direction, $\Vec{d}$.
func Function, $f(\cdotp)$.

Definition at line 12 of file conjugate_gradient.h.


Member Function Documentation

template<int Size, typename Precision, typename Func>
Precision TooN::Internal::LineSearch< Size, Precision, Func >::operator() ( Precision  x  )  const [inline]
Parameters:
x Position to evaluate function
Returns:
$f(\vec{s} + x\vec{d})$

Definition at line 18 of file conjugate_gradient.h.


Member Data Documentation

template<int Size, typename Precision, typename Func>
const Vector<Size, Precision>& TooN::Internal::LineSearch< Size, Precision, Func >::direction

$\Vec{d}$

Definition at line 4 of file conjugate_gradient.h.

template<int Size, typename Precision, typename Func>
const Func& TooN::Internal::LineSearch< Size, Precision, Func >::f

$f(\cdotp)$

Definition at line 6 of file conjugate_gradient.h.

template<int Size, typename Precision, typename Func>
const Vector<Size, Precision>& TooN::Internal::LineSearch< Size, Precision, Func >::start

$\Vec{s}$

Definition at line 3 of file conjugate_gradient.h.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Friends Defines


libtoon
Author(s): Florian Weisshardt
autogenerated on Fri Jan 11 10:09:50 2013