function_iteration_parameter_value.h

Go to the documentation of this file.

/*
 * Copyright 2022 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
 
// IWYU pragma: no_include <functional>
 
#include <type_traits>  // IWYU pragma: keep
 
#include "num_collect/logging/concepts/formattable_iteration_parameter_value.h"
#include "num_collect/logging/concepts/getter_of.h"
 
namespace num_collect::logging::iterations {
 
template <typename Algorithm,
    concepts::formattable_iteration_parameter_value Value,
    concepts::getter_of<Value> Function>
class function_iteration_parameter_value {
public:
    using return_type = std::invoke_result_t<Function>;
 
    explicit function_iteration_parameter_value(Function function)
        : function_(std::move(function)) {}
 
    [[nodiscard]] auto get() const -> return_type { return function_(); }
 
    [[nodiscard]] auto get(const Algorithm* /*algorithm*/) const
        -> return_type {
        return get();
    }
 
private:
    Function function_;
};
 
}  // namespace num_collect::logging::iterations