o2scl::min_de_base< func_t, dfunc_t > Class Template Referenceabstract

One-dimensional minimization using derivatives [abstract base]. More...

`#include <min.h>`

Inheritance diagram for o2scl::min_de_base< func_t, dfunc_t >:

## Public Member Functions

virtual int min (double &x, double &fmin, func_t &func)=0
Calculate the minimum `min` of `func` w.r.t 'x'. More...

virtual int min_bkt (double &x2, double x1, double x3, double &fmin, func_t &func)=0
Calculate the minimum `min` of `func` with x2 bracketed between x1 and x3. More...

virtual int min_de (double &x, double &fmin, func_t &func, dfunc_t &df)=0
Calculate the minimum `min` of `func` with derivative `dfunc` w.r.t 'x'. More...

virtual const char * type ()
Return string denoting type ("min_de")

Public Member Functions inherited from o2scl::min_base< func_t, dfunc_t >
virtual int print_iter (double x, double y, int iter, double value=0.0, double limit=0.0, std::string comment="")
Print out iteration information. More...

virtual int bracket (double &ax, double &bx, double &cx, double &fa, double &fb, double &fc, func_t &func)
Given interval `(ax,bx)`, attempt to bracket a minimum for function `func`. More...

Public Attributes inherited from o2scl::min_base< func_t, dfunc_t >
int verbose
Output control.

int ntrial
Maximum number of iterations.

double tol_rel
The tolerance for the minimum function value.

double tol_abs
The tolerance for the location of the minimum.

int last_ntrial
The number of iterations used in the most recent minimization.

int bracket_iter
The number of iterations for automatically bracketing a minimum (default 20)

bool err_nonconv
If true, call the error handler if the routine does not "converge".

## Detailed Description

### template<class func_t, class dfunc_t = func_t> class o2scl::min_de_base< func_t, dfunc_t >

At the moment there are no minimizers of this type implemented in O2scl .

Idea for Future:
Create a version of o2scl::mmin_conf which implements a minimizer with this interface.

Definition at line 302 of file min.h.

## ◆ min()

template<class func_t , class dfunc_t = func_t>
 virtual int o2scl::min_de_base< func_t, dfunc_t >::min ( double & x, double & fmin, func_t & func )
pure virtual

If this is not overloaded, it attempts to bracket the minimum using bracket() and then calls min_bkt() with the newly bracketed minimum.

Implements o2scl::min_base< func_t, dfunc_t >.

## ◆ min_bkt()

template<class func_t , class dfunc_t = func_t>
 virtual int o2scl::min_de_base< func_t, dfunc_t >::min_bkt ( double & x2, double x1, double x3, double & fmin, func_t & func )
pure virtual

If this is not overloaded, it ignores the bracket and calls min().

Implements o2scl::min_base< func_t, dfunc_t >.

## ◆ min_de()

template<class func_t , class dfunc_t = func_t>
 virtual int o2scl::min_de_base< func_t, dfunc_t >::min_de ( double & x, double & fmin, func_t & func, dfunc_t & df )
pure virtual

If this is not overloaded, it attempts to bracket the minimum using bracket() and then calls min_bkt_de() with the newly bracketed minimum.

Implements o2scl::min_base< func_t, dfunc_t >.

The documentation for this class was generated from the following file:
• /home/awsteiner/wcs/o2scl/src/min/min.h

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).