Loading...
Searching...
No Matches
Optimizer.h
Go to the documentation of this file.
1/*
2** This file is part of eOn.
3**
4** SPDX-License-Identifier: BSD-3-Clause
5**
6** Copyright (c) 2010--present, eOn Development Team
7** All rights reserved.
8**
9** Repo:
10** https://github.com/TheochemUI/eOn
11*/
12#pragma once
13
14#include "Eigen.h"
15#include "ObjectiveFunction.h"
16#include "Parameters.h"
17
18#include "EonLogger.h"
19
20#include <optional>
21#include <string>
22
23namespace eonc {
24
33
48
52
66
68class Optimizer {
69private:
71
72protected:
74 std::shared_ptr<ObjectiveFunction> m_objf;
75
76public:
77 Optimizer(std::shared_ptr<ObjectiveFunction> a_objf,
78 const OptimizerConfig &a_config)
79 : m_otype{a_config.opts.method}, m_optConfig{a_config}, m_objf{a_objf} {
81 "You should explicitly set an optimizer while constructing the "
82 "optimizer!!\n Defaulting to opt_method from the parameters");
83 }
84 Optimizer(std::shared_ptr<ObjectiveFunction> a_objf, OptType a_optype,
85 const OptimizerConfig &a_config)
86 : m_otype{a_optype}, m_optConfig{a_config}, m_objf{a_objf} {}
87
88 // Backward-compat constructors
89 [[deprecated("Pass OptimizerConfig directly")]]
90 Optimizer(std::shared_ptr<ObjectiveFunction> a_objf,
91 const Parameters &a_params)
92 : Optimizer(a_objf, OptimizerConfig::fromParams(a_params)) {}
93 [[deprecated("Pass OptimizerConfig directly")]]
94 Optimizer(std::shared_ptr<ObjectiveFunction> a_objf, OptType a_optype,
95 const Parameters &a_params)
96 : Optimizer(a_objf, a_optype, OptimizerConfig::fromParams(a_params)) {}
97
98 virtual ~Optimizer() = default;
99 virtual int step(double a_maxMove) = 0;
100 virtual int run(size_t a_maxIterations, double a_maxMove) = 0;
101 // A min-mode search calls this after it shortens or restores a
102 // translation that crossed max_energy. CG and FIRE drop the memory
103 // that pointed along that step. L-BFGS stored the step's start, so
104 // the next secant pair stays consistent and the default keeps it.
105 virtual void onTranslationPulledBack() {}
106};
107
108namespace helpers::create {
114[[nodiscard]] std::optional<std::string>
115rgminMethodFor(const ObjectiveFunction &a_objf, OptType a_otype,
116 const Parameters &a_params);
117
120[[nodiscard]] std::optional<std::string>
121rgminBackendMethod(OptType a_otype, const Parameters &a_params);
122
123[[nodiscard]] std::unique_ptr<Optimizer>
124mkOptim(std::shared_ptr<ObjectiveFunction> a_objf, OptType a_otype,
125 const Parameters &a_params);
126}
127
128} // namespace eonc
#define EONC_LOG_WARNING(...)
Definition EonLogger.h:322
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, OptType a_optype, const Parameters &a_params)
Definition Optimizer.h:94
const OptType m_otype
Definition Optimizer.h:70
const OptimizerConfig m_optConfig
Definition Optimizer.h:73
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
Definition Optimizer.h:77
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
Definition Optimizer.h:90
virtual int run(size_t a_maxIterations, double a_maxMove)=0
virtual ~Optimizer()=default
virtual int step(double a_maxMove)=0
std::shared_ptr< ObjectiveFunction > m_objf
Definition Optimizer.h:74
virtual void onTranslationPulledBack()
Definition Optimizer.h:105
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, OptType a_optype, const OptimizerConfig &a_config)
Definition Optimizer.h:84
const potential_options_t & potential_options() const
const main_options_t & main_options() const
const saddle_search_options_t & saddle_search_options() const
eonc::optimizer_options_t optimizer_options_t
Definition Parameters.h:70
const optimizer_options_t & optimizer_options() const
std::optional< std::string > rgminBackendMethod(OptType a_otype, const Parameters &a_params)
rgminMethodFor without the objective test: what a minimization of a potential energy runs under opt_b...
Definition Optimizer.cpp:34
std::unique_ptr< Optimizer > mkOptim(std::shared_ptr< ObjectiveFunction > a_objf, OptType a_otype, const Parameters &a_params)
Definition Optimizer.cpp:55
std::optional< std::string > rgminMethodFor(const ObjectiveFunction &a_objf, OptType a_otype, const Parameters &a_params)
The rgmin method token mkOptim runs for a_otype when [Optimizer] opt_backend = rgmin.
Definition Optimizer.cpp:25
RAII resource manager for the ARTn C library with global synchronization.
Declaration of the optimizer class.
Definition Optimizer.h:54
Parameters::optimizer_options_t opts
Definition Optimizer.h:55
static OptimizerConfig fromParams(const Parameters &p)
Definition Optimizer.h:60
struct eonc::saddle_search_options_t::confine_positive_t confine_positive