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

#include <iterative_root_base.hpp>

Inheritance diagram for eli::mutil::nls::convergence_tester< data__ >:

Public Types

enum  activity_state {
  inactive = 0, equal = 1, less = 2, less_equal = 3,
  greater = 4, greater_equal = 5
}
 
typedef data__ data_type
 

Public Member Functions

 convergence_tester ()
 
 convergence_tester (const convergence_tester< data__ > &ct)
 
virtual ~convergence_tester ()
 
void satisfy_both (bool sb)
 
bool satisfy_both () const
 
void set_relative_tolerance_info (const data__ &rt, const activity_state &as=less)
 
data__ get_relative_tolerance () const
 
const activity_stateget_relative_tolerance_state () const
 
void set_absolute_tolerance_info (const data__ &at, const activity_state &as=less)
 
data__ get_absolute_tolerance () const
 
const activity_stateget_absolute_tolerance_state () const
 
bool converged (const data__ &rel_val, const data__ &abs_val) const
 

Private Member Functions

bool compare (const data__ &val, const std::pair< data__, activity_state > &ref) const
 

Private Attributes

bool satisfy_both_flag
 
std::pair< data__, activity_staterel_tol_info
 
std::pair< data__, activity_stateabs_tol_info
 

Member Typedef Documentation

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

Member Enumeration Documentation

Enumerator
inactive 
equal 
less 
less_equal 
greater 
greater_equal 

Constructor & Destructor Documentation

template<typename data__>
eli::mutil::nls::convergence_tester< data__ >::convergence_tester ( )
inline
template<typename data__>
eli::mutil::nls::convergence_tester< data__ >::convergence_tester ( const convergence_tester< data__ > &  ct)
inline
template<typename data__>
virtual eli::mutil::nls::convergence_tester< data__ >::~convergence_tester ( )
inlinevirtual

Member Function Documentation

template<typename data__>
bool eli::mutil::nls::convergence_tester< data__ >::compare ( const data__ &  val,
const std::pair< data__, activity_state > &  ref 
) const
inlineprivate
template<typename data__>
bool eli::mutil::nls::convergence_tester< data__ >::converged ( const data__ &  rel_val,
const data__ &  abs_val 
) const
inline
template<typename data__>
data__ eli::mutil::nls::convergence_tester< data__ >::get_absolute_tolerance ( ) const
inline
template<typename data__>
const activity_state& eli::mutil::nls::convergence_tester< data__ >::get_absolute_tolerance_state ( ) const
inline
template<typename data__>
data__ eli::mutil::nls::convergence_tester< data__ >::get_relative_tolerance ( ) const
inline
template<typename data__>
const activity_state& eli::mutil::nls::convergence_tester< data__ >::get_relative_tolerance_state ( ) const
inline
template<typename data__>
void eli::mutil::nls::convergence_tester< data__ >::satisfy_both ( bool  sb)
inline
template<typename data__>
bool eli::mutil::nls::convergence_tester< data__ >::satisfy_both ( ) const
inline
template<typename data__>
void eli::mutil::nls::convergence_tester< data__ >::set_absolute_tolerance_info ( const data__ &  at,
const activity_state as = less 
)
inline
template<typename data__>
void eli::mutil::nls::convergence_tester< data__ >::set_relative_tolerance_info ( const data__ &  rt,
const activity_state as = less 
)
inline

Member Data Documentation

template<typename data__>
std::pair<data__, activity_state> eli::mutil::nls::convergence_tester< data__ >::abs_tol_info
private
template<typename data__>
std::pair<data__, activity_state> eli::mutil::nls::convergence_tester< data__ >::rel_tol_info
private
template<typename data__>
bool eli::mutil::nls::convergence_tester< data__ >::satisfy_both_flag
private

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