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

#include <newton_raphson_constrained_method.hpp>

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

Public Types

enum  end_condition_usage { NRC_NOT_USED = -1, NRC_EXCLUSIVE = 0, NRC_INCLUSIVE = 1, NRC_PERIODIC = 2 }
 
typedef data__ data_type
 
- Public Types inherited from eli::mutil::nls::newton_raphson_method< data__ >
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_constrained_method ()
 
 newton_raphson_constrained_method (const newton_raphson_constrained_method< data_type > &nrm)
 
 ~newton_raphson_constrained_method ()
 
void set_periodic_condition (const data_type &dmin, const data_type &dmax)
 
void unset_conditions ()
 
void unset_lower_condition ()
 
void set_lower_condition (const data_type &d, end_condition_usage ec)
 
void get_lower_condition (data_type &d, end_condition_usage &ec)
 
void unset_upper_condition ()
 
void set_upper_condition (const data_type &d, end_condition_usage ec)
 
void get_upper_condition (data_type &d, end_condition_usage &ec)
 
- Public Member Functions inherited from eli::mutil::nls::newton_raphson_method< data__ >
 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
 

Private Member Functions

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

Private Attributes

data_type xmin
 
data_type xmax
 
end_condition_usage xmin_cond
 
end_condition_usage xmax_cond
 

Additional Inherited Members

- Static Public Attributes inherited from eli::mutil::nls::newton_raphson_method< data__ >
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
 
- 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_constrained_method< data__ >::data_type

Member Enumeration Documentation

Enumerator
NRC_NOT_USED 
NRC_EXCLUSIVE 
NRC_INCLUSIVE 
NRC_PERIODIC 

Constructor & Destructor Documentation

Member Function Documentation

template<typename data__>
virtual data_type eli::mutil::nls::newton_raphson_constrained_method< data__ >::calculate_delta_factor ( const data_type x,
const data_type dx 
) const
inlineprivatevirtual
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::get_lower_condition ( data_type d,
end_condition_usage ec 
)
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::get_upper_condition ( data_type d,
end_condition_usage ec 
)
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::set_lower_condition ( const data_type d,
end_condition_usage  ec 
)
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::set_periodic_condition ( const data_type dmin,
const data_type dmax 
)
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::set_upper_condition ( const data_type d,
end_condition_usage  ec 
)
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::unset_conditions ( )
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::unset_lower_condition ( )
inline
template<typename data__>
void eli::mutil::nls::newton_raphson_constrained_method< data__ >::unset_upper_condition ( )
inline

Member Data Documentation

template<typename data__>
data_type eli::mutil::nls::newton_raphson_constrained_method< data__ >::xmax
private
template<typename data__>
end_condition_usage eli::mutil::nls::newton_raphson_constrained_method< data__ >::xmax_cond
private
template<typename data__>
data_type eli::mutil::nls::newton_raphson_constrained_method< data__ >::xmin
private
template<typename data__>
end_condition_usage eli::mutil::nls::newton_raphson_constrained_method< data__ >::xmin_cond
private

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