Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template checked_stepper<DenseOutStepper, Checker, dense_output_stepper_tag>

boost::numeric::odeint::checked_stepper<DenseOutStepper, Checker, dense_output_stepper_tag> — Adapter to combine dense out stepper and checker.

Synopsis

// In header: <boost/numeric/odeint/integrate/check_adapter.hpp>

template<typename DenseOutStepper, typename Checker> 
class checked_stepper<DenseOutStepper, Checker, dense_output_stepper_tag> {
public:
  // types
  typedef DenseOutStepper          stepper_type;
  typedef Checker                  checker_type;
  typedef stepper_type::state_type state_type;  
  typedef stepper_type::value_type value_type;  
  typedef stepper_type::deriv_type deriv_type;  
  typedef stepper_type::time_type  time_type;   

  // construct/copy/destruct
  checked_stepper(stepper_type &, checker_type &);

  // public member functions
  template<typename System> std::pair< time_type, time_type > do_step(System);
  template<typename StateType> 
    void initialize(const StateType &, time_type, time_type);
  template<typename StateOut> void calc_state(time_type, StateOut &) const;
  template<typename StateOut> 
    void calc_state(time_type, const StateOut &) const;
  const state_type & current_state(void) const;
  time_type current_time(void) const;
  const state_type & previous_state(void) const;
  time_type previous_time(void) const;
  time_type current_time_step(void) const;
};

Description

checked_stepper public construct/copy/destruct

  1. checked_stepper(stepper_type & stepper, checker_type & checker);
    Construct the checked_stepper.

checked_stepper public member functions

  1. template<typename System> 
      std::pair< time_type, time_type > do_step(System system);
  2. template<typename StateType> 
      void initialize(const StateType & x0, time_type t0, time_type dt0);
  3. template<typename StateOut> void calc_state(time_type t, StateOut & x) const;
  4. template<typename StateOut> 
      void calc_state(time_type t, const StateOut & x) const;
  5. const state_type & current_state(void) const;
  6. time_type current_time(void) const;
  7. const state_type & previous_state(void) const;
  8. time_type previous_time(void) const;
  9. time_type current_time_step(void) const;

PrevUpHomeNext