kwargs-to-struct.hpp

Go to the documentation of this file.

/**
 * @file
 * This file defines mappings from Python dicts (kwargs) to simple parameter
 * structs.
 */
 
#pragma once
 
#include <functional>
#include <map>
#include <variant>
 
#include <pybind11/detail/typeid.h>
#include <pybind11/pybind11.h>
namespace py = pybind11;
 
struct cast_error_with_types : py::cast_error {
    cast_error_with_types(const py::cast_error &e, std::string from,
                          std::string to)
        : py::cast_error(e), from(std::move(from)), to(std::move(to)) {}
    std::string from;
    std::string to;
};
 
template <class T, class A>
auto attr_setter(A T::*attr) {
    return [attr](T &t, const py::handle &h) {
        try {
            t.*attr = h.cast<A>();
        } catch (const py::cast_error &e) {
            throw cast_error_with_types(e, py::str(py::type::handle_of(h)),
                                        py::type_id<A>());
        }
    };
}
template <class T, class A>
auto attr_getter(A T::*attr) {
    return [attr](const T &t) { return py::cast(t.*attr); };
}
 
template <class T>
class attr_setter_fun_t {
  public:
    template <class A>
    attr_setter_fun_t(A T::*attr)
        : set(attr_setter(attr)), get(attr_getter(attr)) {}
 
    std::function<void(T &, const py::handle &)> set;
    std::function<py::object(const T &)> get;
};
 
template <class T>
using kwargs_to_struct_table_t = std::map<std::string, attr_setter_fun_t<T>>;
 
template <class T>
kwargs_to_struct_table_t<T> kwargs_to_struct_table;
 
template <class T>
void kwargs_to_struct_helper(T &t, const py::kwargs &kwargs) {
    const auto &m = kwargs_to_struct_table<T>;
    for (auto &&[key, val] : kwargs) {
        auto skey = key.template cast<std::string>();
        auto it   = m.find(skey);
        if (it == m.end())
            throw py::key_error("Unknown parameter " + skey);
        try {
            it->second.set(t, val);
        } catch (const cast_error_with_types &e) {
            throw std::runtime_error("Error converting parameter '" + skey +
                                     "' from " + e.from + " to '" + e.to +
                                     "': " + e.what());
        } catch (const std::runtime_error &e) {
            throw std::runtime_error("Error setting parameter '" + skey +
                                     "': " + e.what());
        }
    }
}
 
template <class T>
py::dict struct_to_dict_helper(const T &t) {
    const auto &m = kwargs_to_struct_table<T>;
    py::dict d;
    for (auto &&[key, val] : m) {
        py::object o = val.get(t);
        if (py::hasattr(o, "to_dict"))
            o = o.attr("to_dict")();
        d[key.c_str()] = std::move(o);
    }
    return d;
}
 
template <class T>
T kwargs_to_struct(const py::kwargs &kwargs) {
    T t{};
    kwargs_to_struct_helper(t, kwargs);
    return t;
}
 
template <class T>
py::dict struct_to_dict(const T &t) {
    return struct_to_dict_helper<T>(t);
}
 
template <class T>
T var_kwargs_to_struct(const std::variant<T, py::dict> &p) {
    return std::holds_alternative<T>(p)
               ? std::get<T>(p)
               : kwargs_to_struct<T>(std::get<py::dict>(p));
}
 
#include <alpaqa/inner/decl/panoc.hpp>
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::PANOCParams>
    kwargs_to_struct_table<alpaqa::PANOCParams>{
        {"Lipschitz", &alpaqa::PANOCParams::Lipschitz},
        {"max_iter", &alpaqa::PANOCParams::max_iter},
        {"max_time", &alpaqa::PANOCParams::max_time},
        {"τ_min", &alpaqa::PANOCParams::τ_min},
        {"L_min", &alpaqa::PANOCParams::L_min},
        {"L_max", &alpaqa::PANOCParams::L_max},
        {"stop_crit", &alpaqa::PANOCParams::stop_crit},
        {"max_no_progress", &alpaqa::PANOCParams::max_no_progress},
        {"print_interval", &alpaqa::PANOCParams::print_interval},
        {"quadratic_upperbound_tolerance_factor",
         &alpaqa::PANOCParams::quadratic_upperbound_tolerance_factor},
        {"update_lipschitz_in_linesearch",
         &alpaqa::PANOCParams::update_lipschitz_in_linesearch},
        {"alternative_linesearch_cond",
         &alpaqa::PANOCParams::alternative_linesearch_cond},
        {"lbfgs_stepsize", &alpaqa::PANOCParams::lbfgs_stepsize},
    };
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::LipschitzEstimateParams>
    kwargs_to_struct_table<alpaqa::LipschitzEstimateParams>{
        {"L_0", &alpaqa::LipschitzEstimateParams::L₀},
        {"δ", &alpaqa::LipschitzEstimateParams::δ},
        {"ε", &alpaqa::LipschitzEstimateParams::ε},
        {"Lγ_factor", &alpaqa::LipschitzEstimateParams::Lγ_factor},
    };
 
#include <alpaqa/inner/pga.hpp>
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::PGAParams>
    kwargs_to_struct_table<alpaqa::PGAParams>{
        {"Lipschitz", &alpaqa::PGAParams::Lipschitz},
        {"max_iter", &alpaqa::PGAParams::max_iter},
        {"max_time", &alpaqa::PGAParams::max_time},
        {"L_min", &alpaqa::PGAParams::L_min},
        {"L_max", &alpaqa::PGAParams::L_max},
        {"stop_crit", &alpaqa::PGAParams::stop_crit},
        {"print_interval", &alpaqa::PGAParams::print_interval},
        {"quadratic_upperbound_tolerance_factor",
         &alpaqa::PGAParams::quadratic_upperbound_tolerance_factor},
    };
 
#include <alpaqa/inner/guarded-aa-pga.hpp>
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::GAAPGAParams>
    kwargs_to_struct_table<alpaqa::GAAPGAParams>{
        {"Lipschitz", &alpaqa::GAAPGAParams::Lipschitz},
        {"limitedqr_mem", &alpaqa::GAAPGAParams::limitedqr_mem},
        {"max_iter", &alpaqa::GAAPGAParams::max_iter},
        {"max_time", &alpaqa::GAAPGAParams::max_time},
        {"L_min", &alpaqa::GAAPGAParams::L_min},
        {"L_max", &alpaqa::GAAPGAParams::L_max},
        {"stop_crit", &alpaqa::GAAPGAParams::stop_crit},
        {"print_interval", &alpaqa::GAAPGAParams::print_interval},
        {"quadratic_upperbound_tolerance_factor",
         &alpaqa::GAAPGAParams::quadratic_upperbound_tolerance_factor},
        {"max_no_progress", &alpaqa::GAAPGAParams::max_no_progress},
        {"full_flush_on_γ_change", &alpaqa::GAAPGAParams::full_flush_on_γ_change},
    };
 
#include <alpaqa/inner/decl/structured-panoc-lbfgs.hpp>
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::StructuredPANOCLBFGSParams>
    kwargs_to_struct_table<alpaqa::StructuredPANOCLBFGSParams>{
        {"Lipschitz", &alpaqa::StructuredPANOCLBFGSParams::Lipschitz},
        {"max_iter", &alpaqa::StructuredPANOCLBFGSParams::max_iter},
        {"max_time", &alpaqa::StructuredPANOCLBFGSParams::max_time},
        {"τ_min", &alpaqa::StructuredPANOCLBFGSParams::τ_min},
        {"L_min", &alpaqa::StructuredPANOCLBFGSParams::L_min},
        {"L_max", &alpaqa::StructuredPANOCLBFGSParams::L_max},
        {"nonmonotone_linesearch",
         &alpaqa::StructuredPANOCLBFGSParams::nonmonotone_linesearch},
        {"stop_crit", &alpaqa::StructuredPANOCLBFGSParams::stop_crit},
        {"max_no_progress", &alpaqa::StructuredPANOCLBFGSParams::max_no_progress},
        {"print_interval", &alpaqa::StructuredPANOCLBFGSParams::print_interval},
        {"quadratic_upperbound_tolerance_factor",
         &alpaqa::StructuredPANOCLBFGSParams::
             quadratic_upperbound_tolerance_factor},
        {"update_lipschitz_in_linesearch",
         &alpaqa::StructuredPANOCLBFGSParams::update_lipschitz_in_linesearch},
        {"alternative_linesearch_cond",
         &alpaqa::StructuredPANOCLBFGSParams::alternative_linesearch_cond},
        {"hessian_vec", &alpaqa::StructuredPANOCLBFGSParams::hessian_vec},
        {"hessian_vec_finite_differences",
         &alpaqa::StructuredPANOCLBFGSParams::hessian_vec_finite_differences},
        {"full_augmented_hessian",
         &alpaqa::StructuredPANOCLBFGSParams::full_augmented_hessian},
        {"hessian_step_size_heuristic",
         &alpaqa::StructuredPANOCLBFGSParams::hessian_step_size_heuristic},
        {"lbfgs_stepsize", &alpaqa::StructuredPANOCLBFGSParams::lbfgs_stepsize},
    };
 
#include <alpaqa/inner/directions/decl/lbfgs.hpp>
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::LBFGSParams>
    kwargs_to_struct_table<alpaqa::LBFGSParams>{
        {"memory", &alpaqa::LBFGSParams::memory},
        {"cbfgs", &alpaqa::LBFGSParams::cbfgs},
        {"rescale_when_γ_changes", &alpaqa::LBFGSParams::rescale_when_γ_changes},
    };
 
template <>
inline const kwargs_to_struct_table_t<decltype(alpaqa::LBFGSParams::cbfgs)>
    kwargs_to_struct_table<decltype(alpaqa::LBFGSParams::cbfgs)>{
        {"α", &decltype(alpaqa::LBFGSParams::cbfgs)::α},
        {"ϵ", &decltype(alpaqa::LBFGSParams::cbfgs)::ϵ},
    };
 
#include <alpaqa/decl/alm.hpp>
 
template <>
inline const kwargs_to_struct_table_t<alpaqa::ALMParams>
    kwargs_to_struct_table<alpaqa::ALMParams>{
        {"ε", &alpaqa::ALMParams::ε},
        {"δ", &alpaqa::ALMParams::δ},
        {"Δ", &alpaqa::ALMParams::Δ},
        {"Δ_lower", &alpaqa::ALMParams::Δ_lower},
        {"Σ_0", &alpaqa::ALMParams::Σ₀},
        {"σ_0", &alpaqa::ALMParams::σ₀},
        {"Σ_0_lower", &alpaqa::ALMParams::Σ₀_lower},
        {"ε_0", &alpaqa::ALMParams::ε₀},
        {"ε_0_increase", &alpaqa::ALMParams::ε₀_increase},
        {"ρ", &alpaqa::ALMParams::ρ},
        {"ρ_increase", &alpaqa::ALMParams::ρ_increase},
        {"θ", &alpaqa::ALMParams::θ},
        {"M", &alpaqa::ALMParams::M},
        {"Σ_max", &alpaqa::ALMParams::Σ_max},
        {"Σ_min", &alpaqa::ALMParams::Σ_min},
        {"max_iter", &alpaqa::ALMParams::max_iter},
        {"max_time", &alpaqa::ALMParams::max_time},
        {"max_num_initial_retries", &alpaqa::ALMParams::max_num_initial_retries},
        {"max_num_retries", &alpaqa::ALMParams::max_num_retries},
        {"max_total_num_retries", &alpaqa::ALMParams::max_total_num_retries},
        {"print_interval", &alpaqa::ALMParams::print_interval},
        {"preconditioning", &alpaqa::ALMParams::preconditioning},
        {"single_penalty_factor", &alpaqa::ALMParams::single_penalty_factor},
    };