doc/ref/gsl_2ConjugateGradients_8h_source.html

 /**

  *  \file IMP/gsl/ConjugateGradients.h

  *  \brief A conjugate gradients optimizer from GSL

  *

  *  Copyright 2007-2020 IMP Inventors. All rights reserved.

  */


 #ifndef IMPGSL_CONJUGATE_GRADIENTS_H

 #define IMPGSL_CONJUGATE_GRADIENTS_H


 #include <IMP/gsl/gsl_config.h>


 #include "GSLOptimizer.h"


 IMPGSL_BEGIN_NAMESPACE


 //! A conjugate gradients optimizer taken from GSL

 /** \see IMP::core::ConjugateGradients

  */

 class IMPGSLEXPORT ConjugateGradients : public GSLOptimizer {

   double initial_step_, line_step_, min_gradient_;


  public:

   //!

   ConjugateGradients(Model *m);


   //! Set the gradient threshold

   void set_threshold(double mg) { min_gradient_ = mg; }

   virtual Float do_optimize(unsigned int max_steps) IMP_OVERRIDE;

   IMP_OBJECT_METHODS(ConjugateGradients);

 };


 IMPGSL_END_NAMESPACE


 #endif /* IMPGSL_CONJUGATE_GRADIENTS_H */

IMP::gsl::GSLOptimizer
A base class for GSL-based optimizers.
Definition: GSLOptimizer.h:22

IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25

IMP::gsl::ConjugateGradients
A conjugate gradients optimizer taken from GSL.
Definition: gsl/ConjugateGradients.h:20

IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72

IMP::Optimizer::do_optimize
virtual double do_optimize(unsigned int ns)=0
override this function to do actual optimization

IMP::gsl::ConjugateGradients::set_threshold
void set_threshold(double mg)
Set the gradient threshold.
Definition: gsl/ConjugateGradients.h:28

IMP::Float
double Float
Basic floating-point value (could be float, double...)
Definition: types.h:20

GSLOptimizer.h
A base class for GSL-based optimizers.

IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78