Code-Eli  0.3.6
eli::mutil::nls::secant_method< data__ > Class Template Reference

#include <secant_method.hpp>

Inheritance diagram for eli::mutil::nls::secant_method< data__ >:
Collaboration diagram for eli::mutil::nls::secant_method< data__ >:

Public Member Functions

 secant_method ()
 
 secant_method (const secant_method< data__ > &sm)
 
 ~secant_method ()
 
void set_initial_guesses (const data__ &xg1, const data__ &xg2)
 
void get_initial_guesses (data__ &xg1, data__ &xg2) const
 
template<typename f__ >
int find_root (data__ &root, const f__ &fun, const data__ &f0) const
 
- Public Member Functions inherited from eli::mutil::nls::iterative_root_base< data__ >
 iterative_root_base ()
 
 iterative_root_base (const iterative_root_base< data__ > &irb)
 
virtual ~iterative_root_base ()
 
void set_relative_tolerance (const tolerance_type &rel_tol)
 
tolerance_type get_relative_tolerance () const
 
void set_absolute_tolerance (const tolerance_type &abs_tol)
 
tolerance_type get_absolute_tolerance () const
 
void set_max_iteration (const iteration_type &mi)
 
iteration_type get_max_iteration () const
 
void enforce_both_tolerance (bool ebt)
 
bool enforce_both_tolerance () const
 
void disable_relative_tolerance ()
 
void disable_absolute_tolerance ()
 
const error_tolerance_typeget_tolerance_tester () const
 
const max_iteration_typeget_iteration_count_tester () const
 
const iteration_typeget_iteration_count () const
 

Private Attributes

data__ x1
 
data__ x2
 

Additional Inherited Members

- Public Types inherited from eli::mutil::nls::iterative_root_base< data__ >
typedef convergence_tester< data__ > error_tolerance_type
 
typedef convergence_tester< size_t > max_iteration_type
 
typedef error_tolerance_type::data_type tolerance_type
 
typedef max_iteration_type::data_type iteration_type
 
- Static Public Attributes inherited from eli::mutil::nls::iterative_root_base< data__ >
static const int converged = 0
 
static const int max_iteration = 1
 
static const int no_root_found = 2
 
- Protected Member Functions inherited from eli::mutil::nls::iterative_root_base< data__ >
bool test_converged (const iteration_type &it, const tolerance_type &relv, const tolerance_type &absv) const
 
bool max_iteration_reached (const iteration_type &it) const
 

Constructor & Destructor Documentation

template<typename data__>
eli::mutil::nls::secant_method< data__ >::secant_method ( )
inline
template<typename data__>
eli::mutil::nls::secant_method< data__ >::secant_method ( const secant_method< data__ > &  sm)
inline
template<typename data__>
eli::mutil::nls::secant_method< data__ >::~secant_method ( )
inline

Member Function Documentation

template<typename data__>
template<typename f__ >
int eli::mutil::nls::secant_method< data__ >::find_root ( data__ &  root,
const f__ &  fun,
const data__ &  f0 
) const
inline

Here is the call graph for this function:

template<typename data__>
void eli::mutil::nls::secant_method< data__ >::get_initial_guesses ( data__ &  xg1,
data__ &  xg2 
) const
inline
template<typename data__>
void eli::mutil::nls::secant_method< data__ >::set_initial_guesses ( const data__ &  xg1,
const data__ &  xg2 
)
inline

Member Data Documentation

template<typename data__>
data__ eli::mutil::nls::secant_method< data__ >::x1
private
template<typename data__>
data__ eli::mutil::nls::secant_method< data__ >::x2
private

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