regularized_solver_base.h

Go to the documentation of this file.

/*
 * Copyright 2024 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 <utility>
 
#include <Eigen/Core>
 
#include "num_collect/base/concepts/dense_matrix.h"
#include "num_collect/base/index_type.h"
#include "num_collect/logging/log_tag_view.h"
#include "num_collect/logging/logging_mixin.h"
 
namespace num_collect::regularization {
 
template <typename Derived, base::concepts::dense_matrix Data>
class regularized_solver_base : public logging::logging_mixin {
public:
    using data_type = Data;
 
    using scalar_type =
        typename Eigen::NumTraits<typename data_type::Scalar>::Real;
 
    void solve(const scalar_type& param, data_type& solution) {
        return derived().solve(param, solution);
    }
 
    [[nodiscard]] auto data_size() const -> index_type {
        return derived().data_size();
    }
 
    [[nodiscard]] auto param_search_region() const
        -> std::pair<scalar_type, scalar_type> {
        return derived().param_search_region();
    }
 
protected:
    explicit regularized_solver_base(logging::log_tag_view tag)
        : logging::logging_mixin(tag) {}
 
    [[nodiscard]] auto derived() noexcept -> Derived& {
        return *static_cast<Derived*>(this);
    }
 
    [[nodiscard]] auto derived() const noexcept -> const Derived& {
        return *static_cast<const Derived*>(this);
    }
};
 
}  // namespace num_collect::regularization