logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

sc::LineOpt - The LineOpt abstract class is used to perform one dimensional optimizations.

Author

       Generated automatically by Doxygen for MPQC from the source code.

Version 2.3.1                                    Sun Oct 4 2020                                   sc::LineOpt(3)

Detailed Description

       The LineOpt abstract class is used to perform one dimensional optimizations.

Member Function Documentation

virtualvoidsc::LineOpt::init(RefSCVector&direction)[virtual]
       Initializes the line search object. Argument is a search direction. Use of this method assumes the
       Optimize base class already has a function object (got it from a keyval or elsewhere).

       Reimplemented in sc::MCSearch.

   virtualvoidsc::LineOpt::init(RefSCVector&direction,Ref<Function>function)[virtual]
       Initializes the line search object. First argument is a search direction, second argument is a function
       object to optimize. Use this method when a function must be passed to the Optimize base class.

       Reimplemented in sc::MCSearch.

   voidsc::LineOpt::save_data_state(StateOut&)[virtual]
       Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR
       initializes them. This must be implemented by the derived class if the class has data.

       Reimplemented from sc::Optimize.

Name

       sc::LineOpt - The LineOpt abstract class is used to perform one dimensional optimizations.

Synopsis

       #include <opt.h>

       Inherits sc::Optimize.

       Inherited by sc::Backtrack, and sc::MCSearch.

   PublicMemberFunctionsLineOpt (StateIn &)
       LineOpt (const Ref< KeyVal > &)
       void save_data_state (StateOut &)
           Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR
           initializes them.
       virtual void init (RefSCVector &direction)
           Initializes the line search object.
       virtual void init (RefSCVector &direction, Ref< Function > function)
           Initializes the line search object.
       void apply_transform (const Ref< NonlinearTransform > &)
           Applies a nonlinear transform.
       double decrease_factor ()
           Returns factor for sufficient decrease test.
       double set_decrease_factor (double factor)
           Sets factor for sufficient decrease test.

   ProtectedMemberFunctions
       int sufficient_decrease (RefSCVector &step)

   ProtectedAttributes
       double decrease_factor_RefSCVectorinitial_x_
       double initial_value_RefSCVectorinitial_grad_RefSCVectorsearch_direction_Ref< Function > function_AdditionalInheritedMembers

See Also