Loading...
Searching...
No Matches
eonc::SteepestDescent Class Referencefinal

#include <SteepestDescent.h>

Inheritance diagram for eonc::SteepestDescent:

Public Member Functions

 SteepestDescent (std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
 ~SteepestDescent ()=default
int step (double a_maxMove) override
int run (size_t a_maxIterations, double a_maxMove) override
Public Member Functions inherited from eonc::Optimizer
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, OptType a_optype, const OptimizerConfig &a_config)
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, const Parameters &a_params)
 Optimizer (std::shared_ptr< ObjectiveFunction > a_objf, OptType a_optype, const Parameters &a_params)
virtual ~Optimizer ()=default
virtual void onTranslationPulledBack ()

Private Member Functions

Eigen::VectorXd getStep (const Eigen::VectorXd &a_f)

Private Attributes

eonc::log::FileScoped m_log {"sd", "_sd.log"}
size_t iteration {0}
Eigen::VectorXd m_rPrev
Eigen::VectorXd m_fPrev

Additional Inherited Members

Protected Attributes inherited from eonc::Optimizer
const OptimizerConfig m_optConfig
std::shared_ptr< ObjectiveFunction > m_objf

Detailed Description

Definition at line 24 of file SteepestDescent.h.

Constructor & Destructor Documentation

◆ SteepestDescent()

eonc::SteepestDescent::SteepestDescent ( std::shared_ptr< ObjectiveFunction > a_objf,
const Parameters & a_params )
inline

Definition at line 26 of file SteepestDescent.h.

29 m_rPrev{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())},
30 m_fPrev{Eigen::VectorXd::Zero(a_objf->degreesOfFreedom())} {}
Optimizer(std::shared_ptr< ObjectiveFunction > a_objf, const OptimizerConfig &a_config)
Definition Optimizer.h:77
Eigen::VectorXd m_fPrev
Eigen::VectorXd m_rPrev
static OptimizerConfig fromParams(const Parameters &p)
Definition Optimizer.h:60

◆ ~SteepestDescent()

eonc::SteepestDescent::~SteepestDescent ( )
default

Member Function Documentation

◆ getStep()

Eigen::VectorXd eonc::SteepestDescent::getStep ( const Eigen::VectorXd & a_f)
private

◆ run()

int eonc::SteepestDescent::run ( size_t a_maxIterations,
double a_maxMove )
overridevirtual

Implements eonc::Optimizer.

Definition at line 51 of file SteepestDescent.cpp.

51 {
52 while (!m_objf->isConverged() && iteration < a_maxIteration) {
53 step(a_maxMove);
54 }
55 return m_objf->isConverged() ? 1 : 0;
56}
std::shared_ptr< ObjectiveFunction > m_objf
Definition Optimizer.h:74
int step(double a_maxMove) override

◆ step()

int eonc::SteepestDescent::step ( double a_maxMove)
overridevirtual

Implements eonc::Optimizer.

Definition at line 21 of file SteepestDescent.cpp.

21 {
22 Eigen::VectorXd r = m_objf->getPositions();
23 Eigen::VectorXd f = -m_objf->getGradient();
24
25 Eigen::VectorXd dr;
26 double alpha = m_optConfig.opts.sd.alpha;
27 if (m_optConfig.opts.sd.two_point && iteration > 0) {
28 Eigen::VectorXd dx = m_objf->difference(r, m_rPrev);
29 Eigen::VectorXd dg = -f + m_fPrev;
31 eonc::exact::dot(dx, dg), 0.0);
32 if (alpha < 0) {
33 alpha = m_optConfig.opts.sd.alpha;
34 }
35 QUILL_LOG_DEBUG(m_log, "[SD] alpha: {:.4e}", alpha);
36 }
37
38 dr = alpha * f;
39 dr = eonc::geometry::maxAtomMotionAppliedV(dr, a_maxMove);
40
41 m_objf->setPositions(r + dr);
42
43 m_rPrev = r;
44 m_fPrev = f;
45
46 iteration++;
47
48 return m_objf->isConverged() ? 1 : 0;
49}
const OptimizerConfig m_optConfig
Definition Optimizer.h:73
eonc::log::FileScoped m_log
double squaredNorm(const Eigen::MatrixBase< A > &x)
double dot(const double *x, const double *y, std::size_t n)
Round-to-nearest-even value of the exact sum of x[i] * y[i].
VectorXd maxAtomMotionAppliedV(const VectorXd v1, double maxMotion)
constexpr double safe_div(double num, double denom, double fallback=0.0)
Definition SafeMath.h:21

Member Data Documentation

◆ iteration

size_t eonc::SteepestDescent::iteration {0}
private

Definition at line 39 of file SteepestDescent.h.

39{0};

◆ m_fPrev

Eigen::VectorXd eonc::SteepestDescent::m_fPrev
private

Definition at line 41 of file SteepestDescent.h.

◆ m_log

eonc::log::FileScoped eonc::SteepestDescent::m_log {"sd", "_sd.log"}
private

Definition at line 37 of file SteepestDescent.h.

37{"sd", "_sd.log"};

◆ m_rPrev

Eigen::VectorXd eonc::SteepestDescent::m_rPrev
private

Definition at line 40 of file SteepestDescent.h.


The documentation for this class was generated from the following files: