Commit 9a6305af authored by Davis King's avatar Davis King

made spec more clear

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403779
parent 6ce7fd74
......@@ -232,15 +232,18 @@ namespace dlib
// ----------------------------------------------------------------------------------------
template <typename hessian_funct>
template <
typename hessian_funct
>
class newton_search_strategy_obj
{
/*!
REQUIREMENTS ON hessian_funct
Lets denote the function being optimized as f(x). Then the
hessian_funct must be a function object that takes in an x
and returns the hessian matrix at x. hessian_funct must also
be copy constructable.
Objects of hessian_funct type must be function objects which
take a single argument and return a dlib::matrix of doubles. The
single argument must be a dlib::matrix capable of representing
column vectors of doubles. hessian_funct must also be copy
constructable.
WHAT THIS OBJECT REPRESENTS
This object represents a strategy for determining which direction
......@@ -258,6 +261,8 @@ namespace dlib
ensures
- This object is properly initialized and ready to generate
search directions.
- hess will be used by this object to generate the needed hessian
matrices every time get_next_direction() is called.
!*/
double get_wolfe_rho (
......@@ -300,6 +305,8 @@ namespace dlib
- Assuming that a line search is going to be conducted starting from the
point x, this function returns the direction in which the search should
proceed.
- In particular, the search direction will be given by:
- search_direction = -inv(hessian(x))*funct_derivative
!*/
};
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment