GlobiPack Version of the Day
GlobiPack_LineSearchBase.hpp
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //    GlobiPack: Collection of Scalar 1D globalizaton utilities
00006 //                 Copyright (2009) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 // 
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 // 
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA
00025 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00026 // 
00027 // ***********************************************************************
00028 // @HEADER
00029 */
00030 
00031 #ifndef GLOBIPACK_LINE_SEARCH_BASE_HPP
00032 #define GLOBIPACK_LINE_SEARCH_BASE_HPP
00033 
00034 
00035 #include "GlobiPack_MeritFunc1DBase.hpp"
00036 #include "Teuchos_Describable.hpp"
00037 #include "Teuchos_VerboseObject.hpp"
00038 #include "Teuchos_ParameterListAcceptor.hpp"
00039 
00040 
00041 namespace GlobiPack {
00042 
00043 
00048 template<typename Scalar>
00049 class LineSearchBase
00050   : virtual public Teuchos::Describable,
00051     virtual public Teuchos::VerboseObject<LineSearchBase<Scalar> >,
00052     virtual public Teuchos::ParameterListAcceptor
00053 {
00054 public:
00055 
00059   virtual bool requiresBaseDeriv() const = 0;
00060 
00064   virtual bool requiresDerivEvals() const = 0;
00065 
00133   virtual bool doLineSearch(
00134     const MeritFunc1DBase<Scalar> &phi,
00135     const PointEval1D<Scalar> &point_k,
00136     const Ptr<PointEval1D<Scalar> > &point_kp1,
00137     const Ptr<int> &numIters
00138     ) const = 0;
00139 
00140 };
00141 
00142 
00143 } // namespace GlobiPack
00144 
00145 
00146 #endif // GLOBIPACK_LINE_SEARCH_BASE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends