diff --git a/dlib/optimization/find_optimal_parameters.h b/dlib/optimization/find_optimal_parameters.h index 6419b4f7e..0884778c9 100644 --- a/dlib/optimization/find_optimal_parameters.h +++ b/dlib/optimization/find_optimal_parameters.h @@ -25,32 +25,6 @@ namespace dlib const matrix& x_upper, const funct& f ) - /*! - requires - - f(x) must be a valid expression that evaluates to a double - - x.size() == x_lower.size() == x_upper.size() - - x.size() > 0 - - 0 < eps < initial_search_radius - - max_f_evals > 1 - - min(x_upper - x_lower) > 0 - - min(x - x_lower) >= 0 && min(x_upper - x) >= 0 - (i.e. the given x should be within the bounds defined by x_lower and x_upper) - ensures - - Performs a constrained minimization of the function f() starting from - the initial point x. - - This function does not require derivatives of f(). Instead, it uses - derivative free methods to find the best setting of x. In particular, it - will begin by searching within a sphere of radius initial_search_radius - around x and will continue searching until either f() has been called - max_f_evals times or the search area has been shrunk to less than eps radius. - - #x == the value of x (within the bounds defined by x_lower and x_upper) that - was found to minimize f(). More precisely, it will always be true that: - - min(#x - x_lower) >= 0 && min(x_upper - #x) >= 0 - - returns f(#x). - throws - - No exception is thrown for executing max_f_evals iterations. This function - will simply output the best x it has seen if it runs out of iterations. - !*/ { DLIB_CASSERT(x.size() == x_lower.size() && x_lower.size() == x_upper.size() && x.size() > 0, "\t double find_optimal_parameters()"