iterative_algorithm_controller.h

Go to the documentation of this file.

#ifndef ITERATIVE_ALGORITHM_CONTROLLER_H
#define ITERATIVE_ALGORITHM_CONTROLLER_H
 
#include "bitrl/bitrl_types.h"
#include "bitrl/utils/iterative_algorithm_result.h"
#include <limits>
 
namespace bitrl
{
namespace utils
{
 
class IterativeAlgorithmController
{
  public:
    IterativeAlgorithmController(uint_t maxIterations, real_t exitTolerance);
 
    IterativeAlgorithmController(const IterativeAlgorithmController &) = default;
 
    IterativeAlgorithmController(IterativeAlgorithmController &&) = default;
 
    IterativeAlgorithmController &operator=(const IterativeAlgorithmController &) = default;
 
    IterativeAlgorithmController &operator=(IterativeAlgorithmController &&) = default;
 
    ~IterativeAlgorithmController() = default;
 
    bool continue_iterations();
 
    bool show_iterations() const { return show_iterations_; }
 
    bool track_residuals() const { return track_residuals_; }
 
    void set_tolerance(real_t tol) { exit_tolerance_ = tol; }
 
    void set_show_iterations_flag(bool flag) { show_iterations_ = flag; }
 
    void set_track_residuals_flag(bool flag) { track_residuals_ = flag; }
 
    void set_num_threads(uint_t nthreads) { n_threads_ = nthreads; }
 
    void set_max_itrs(uint_t max_itrs) { max_iterations_ = max_itrs; }
 
    uint_t get_current_iteration() const { return current_iteration_idx_; }
 
    real_t get_exit_tolerance() const { return exit_tolerance_; }
 
    uint_t get_max_iterations() const { return max_iterations_; }
 
    uint_t get_num_threads() const { return n_threads_; }
 
    real_t get_residual() const { return current_res_; }
 
    IterativeAlgorithmResult get_state() const;
 
    void update_residual(real_t res) { current_res_ = res; }
 
    void reset(const IterativeAlgorithmController &control);
 
    void reset();
 
  private:
    uint_t max_iterations_;
    real_t exit_tolerance_;
    uint_t current_iteration_idx_;
    uint_t n_threads_;
    real_t current_res_;
    bool show_iterations_;
    bool track_residuals_;
};
 
inline IterativeAlgorithmController::IterativeAlgorithmController(uint_t max_iterations,
                                                                  real_t exit_tolerance)
    : max_iterations_(max_iterations), exit_tolerance_(exit_tolerance), current_iteration_idx_(0),
      n_threads_(1), current_res_(std::numeric_limits<real_t>::max()), show_iterations_(false),
      track_residuals_(false)
{
}
 
} // namespace utils
} // namespace bitrl
 
#endif // ITERATIVE_ALGORITHM_CONTROLLER_H