Public Member Functions | List of all members
o2scl::root_de< func_t, dfunc_t, fp_t > Class Template Referenceabstract

One-dimensional with solver with derivatives [abstract base]. More...

#include <root.h>

Inheritance diagram for o2scl::root_de< func_t, dfunc_t, fp_t >:
o2scl::root< funct, funct, double >

Detailed Description

template<class func_t = funct, class dfunc_t = func_t, class fp_t = double>
class o2scl::root_de< func_t, dfunc_t, fp_t >

Note
At the moment, the functions solve() and solve_bkt() are not implemented for derivative solvers.
Idea for Future:
Implement the functions solve() and solve_bkt() for derivative solvers.

Definition at line 394 of file root.h.

Public Member Functions

virtual const char * type ()
 Return the type, "root_de".
 
virtual int solve_bkt (fp_t &x1, fp_t x2, func_t &func)
 Solve func in region $ x_1<x<x_2 $
returning $ x_1 $ .
 
virtual int solve (fp_t &x, func_t &func)
 Solve func using x as an initial guess.
 
virtual int solve_de (fp_t &x, func_t &func, dfunc_t &df)=0
 Solve func using x as an initial guess using derivatives df.
 
- Public Member Functions inherited from o2scl::root< funct, funct, double >
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 solve (double &x, funct &func)=0
 Solve func using x as an initial guess.
 
virtual int solve_bkt (double &x1, double x2, funct &func)
 Solve func in region $ x_1<x<x_2 $
returning $ x_1 $ .
 
virtual int solve_de (double &x, funct &func, funct &df)
 Solve func using x as an initial guess using derivatives df.
 

Additional Inherited Members

- Public Attributes inherited from o2scl::root< funct, funct, double >
double tol_rel
 The maximum value of the functions for success (default $ 10^{-8} $ )
 
double tol_abs
 The minimum allowable stepsize (default $ 10^{-12} $ )
 
int verbose
 Output control (default 0)
 
int ntrial
 Maximum number of iterations (default 100)
 
bool err_nonconv
 If true, call the error handler if the solver does not converge (default true)
 
int last_ntrial
 The number of iterations used in the most recent solve.
 

The documentation for this class was generated from the following file:

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