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

#include <newton_raphson_method.hpp>

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

Public Types

typedef data__ data_type
 
- 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
 

Public Member Functions

 newton_raphson_method ()
 
 newton_raphson_method (const newton_raphson_method< data_type > &nrm)
 
 ~newton_raphson_method ()
 
void set_initial_guess (const data_type &xg)
 
const data_typeget_initial_guess () const
 
template<typename f__ , typename g__ >
int find_root (data_type &root, const f__ &fun, const g__ &fprime, const data_type &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
 

Static Public Attributes

static const int hit_constraint = 101
 
- 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
 

Private Member Functions

virtual data_type calculate_delta_factor (const data_type &, const data_type &dx) const
 

Private Attributes

data_type x0
 

Additional Inherited Members

- 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
 

Member Typedef Documentation

template<typename data__>
typedef data__ eli::mutil::nls::newton_raphson_method< data__ >::data_type

Constructor & Destructor Documentation

template<typename data__>
eli::mutil::nls::newton_raphson_method< data__ >::newton_raphson_method ( )
inline
template<typename data__>
eli::mutil::nls::newton_raphson_method< data__ >::newton_raphson_method ( const newton_raphson_method< data_type > &  nrm)
inline
template<typename data__>
eli::mutil::nls::newton_raphson_method< data__ >::~newton_raphson_method ( )
inline

Member Function Documentation

template<typename data__>
virtual data_type eli::mutil::nls::newton_raphson_method< data__ >::calculate_delta_factor ( const data_type ,
const data_type dx 
) const
inlineprivatevirtual
template<typename data__>
template<typename f__ , typename g__ >
int eli::mutil::nls::newton_raphson_method< data__ >::find_root ( data_type root,
const f__ &  fun,
const g__ &  fprime,
const data_type f0 
) const
inline

Here is the call graph for this function:

template<typename data__>
const data_type& eli::mutil::nls::newton_raphson_method< data__ >::get_initial_guess ( ) const
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_method< data__ >::set_initial_guess ( const data_type xg)
inline

Member Data Documentation

template<typename data__>
const int eli::mutil::nls::newton_raphson_method< data__ >::hit_constraint = 101
static
template<typename data__>
data_type eli::mutil::nls::newton_raphson_method< data__ >::x0
private

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