iterative_regularized_solver_base.h

Go to the documentation of this file.

/*
 * Copyright 2021 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include "num_collect/base/concepts/dense_matrix.h"
#include "num_collect/logging/iterations/iteration_logger_mixin.h"
#include "num_collect/logging/log_tag_view.h"
#include "num_collect/regularization/implicit_regularized_solver_base.h"
 
namespace num_collect::regularization {
 
template <typename Derived, base::concepts::dense_matrix Data>
class iterative_regularized_solver_base
    : public implicit_regularized_solver_base<Derived, Data>,
      public logging::iterations::iteration_logger_mixin<Derived> {
public:
    using typename implicit_regularized_solver_base<Derived, Data>::data_type;
 
    using typename implicit_regularized_solver_base<Derived, Data>::scalar_type;
 
    using implicit_regularized_solver_base<Derived, Data>::logger;
 
    void init(const scalar_type& param, data_type& solution) {
        derived().init(param, solution);
    }
 
    void iterate(const scalar_type& param, data_type& solution) {
        derived().iterate(param, solution);
    }
 
    [[nodiscard]] auto is_stop_criteria_satisfied(
        const data_type& solution) const -> bool {
        return derived().is_stop_criteria_satisfied(solution);
    }
 
    void solve(const scalar_type& param, data_type& solution) {
        init(param, solution);
 
        auto& iter_logger = this->initialize_iteration_logger();
        iter_logger.write_iteration(&derived());
 
        while (!is_stop_criteria_satisfied(solution)) {
            iterate(param, solution);
            iter_logger.write_iteration(&derived());
        }
 
        iter_logger.write_summary(&derived());
    }
 
protected:
    using implicit_regularized_solver_base<Derived, Data>::derived;
 
    explicit iterative_regularized_solver_base(logging::log_tag_view tag)
        : implicit_regularized_solver_base<Derived, Data>(tag) {
        this->logger().set_iterative();
    }
};
 
}  // namespace num_collect::regularization