OptiPack Version of the Day
OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //    OptiPack: Collection of simple Thyra-based Optimization ANAs
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 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #ifndef OPTIPACK_UNCONSTRAINED_OPT_MERIT_FUNC_1D_DECL_HPP
00045 #define OPTIPACK_UNCONSTRAINED_OPT_MERIT_FUNC_1D_DECL_HPP
00046 
00047 
00048 #include "OptiPack_Types.hpp"
00049 #include "GlobiPack_MeritFunc1DBase.hpp"
00050 #include "OptiPack_LineSearchPointEvaluatorBase.hpp"
00051 #include "Thyra_OperatorVectorTypes.hpp"
00052 
00053 
00054 namespace OptiPack {
00055 
00056 
00065 template<typename Scalar>
00066 class UnconstrainedOptMeritFunc1D
00067   : public GlobiPack::MeritFunc1DBase<typename ScalarTraits<Scalar>::magnitudeType>
00068 {
00069 public:
00070 
00072   typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;
00073 
00076 
00078   UnconstrainedOptMeritFunc1D();
00079 
00081   void setModel(
00082     const RCP<const Thyra::ModelEvaluator<Scalar> > &model,
00083     const int paramIndex,
00084     const int responseIndex
00085     );
00086 
00113   void setEvaluationQuantities(
00114     const RCP<const LineSearchPointEvaluatorBase<Scalar> > &pointEvaluator,
00115     const RCP<Thyra::VectorBase<Scalar> > &p,
00116     const RCP<Thyra::VectorBase<Scalar> > &g_vec,
00117     const RCP<Thyra::VectorBase<Scalar> > &g_grad_vec
00118     );
00119 
00121 
00124   
00126   virtual bool supportsDerivEvals() const;
00128   virtual void eval( const ScalarMag &alpha, const Ptr<ScalarMag> &phi,
00129     const Ptr<ScalarMag> &Dphi ) const;
00130 
00132 
00133 private:
00134 
00135   // //////////////////////
00136   // Private data members
00137 
00138   RCP<const Thyra::ModelEvaluator<Scalar> > model_;
00139   int paramIndex_;
00140   int responseIndex_;
00141 
00142   RCP<const LineSearchPointEvaluatorBase<Scalar> > pointEvaluator_;
00143   RCP<Thyra::VectorBase<Scalar> > p_;
00144   RCP<Thyra::VectorBase<Scalar> > g_vec_;
00145   RCP<Thyra::VectorBase<Scalar> > g_grad_vec_;
00146 
00147 };
00148 
00149 
00154 template<typename Scalar>
00155 const RCP<UnconstrainedOptMeritFunc1D<Scalar> >
00156 unconstrainedOptMeritFunc1D(
00157   const RCP<const Thyra::ModelEvaluator<Scalar> > &model,
00158   const int paramIndex,
00159   const int responseIndex
00160   )
00161 {
00162   const RCP<UnconstrainedOptMeritFunc1D<Scalar> > meritFunc = 
00163     Teuchos::rcp(new UnconstrainedOptMeritFunc1D<Scalar>);
00164   meritFunc->setModel(model, paramIndex, responseIndex);
00165   return meritFunc;
00166 }
00167 
00168 
00169 } // namespace OptiPack
00170 
00171 
00172 #endif // OPTIPACK_UNCONSTRAINED_OPT_MERIT_FUNC_1D_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends