linesearch.3.man

来自「COOOL：CWP面向对象最优化库（CWP Object Oriented Op」· MAN 代码 · 共 85 行

LINESEARCH(virtual)       OPTIMA        LINESEARCH(virtual)

                                                     Jun  1 15:18
NAME
    LineSearch

SYNOPSIS
    #include <LineSearch.hh>

    class LineSearch

        \fIPublic members\fP
            LineSearch(ObjectiveFunction*);
            LineSearch(ObjectiveFunction*, double);
            virtual ~LineSearch();
            virtual Model<double> search(Model<double>&,
            Vector<double>&, double, double);
            Vector<double> gradient(Model<double>&);
            double evaluate(Model<double>&);
            virtual Model<long> search(Model<long>&,
            Vector<double>&, double, double);
            Vector<double> gradient(Model<long>&);
            double evaluate(Model<long>&);
            List<int> allSearchIterations();
            int searchIterations();
            double currentValue();
            const char* objName();

        \fIProtected members\fP
            int iterMax;	
            int iterNum;	
            List<int>* iterHistory;	
            double	value;		
            double	step;
            ObjectiveFunction* fp;		
            void appendSearchNumber();

        \fIPrivate members\fP
            Vector<double>*	numericalGradient(Model<double>&);
            Vector<double>*	numericalGradient(Model<long>&);

DESCRIPTION
    LineSearch
     This is the base class for one dimensional
     line search algorithms. Some optimization
     algorithms need to find the optimimal point
     on one searching directions.
     Classes derived from this class inherit features of 
     LineSearch. This class cannot be used directly.
     See also LSearchOptima, CG, Powell.
    

DESCRIPTION
     Vector<double> gradient(m): compute the gradient Vector 
        for Model m;
     double evaluate(m): evaluate the objective function for 
        Model m;
     List<int> allSearchIterations(): number of iterations 
        for all line searches.
     int searchIterations(): number of iterations in the current 
        line search;
     double currentValue(): value of the objective function for
        the current Model;
     char* objName(): returns the class name of the objective
        function;
    

CAVEATS
     LineSearch currently only takes Models either double 
     or long integer. It is mostly because I tried to avoid using
     templates, due to the guliness of template features in G++. 
     Hopefully, this could be changed soon.

DEFINED MACROS
    LINE_SEARCH_HH

INCLUDED FILES
    <C++.hh>
    <ObjFcn.hh>

SOURCE FILES
    LineSearch.cc