OptiPack Version of the Day
OptiPack_DefaultPolyLineSearchPointEvaluator.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_DEFAULT_POLY_LINE_SEARCH_POINT_EVALUATOR_HPP
00045 #define OPTIPACK_DEFAULT_POLY_LINE_SEARCH_POINT_EVALUATOR_HPP
00046 
00047 
00048 #include "OptiPack_LineSearchPointEvaluatorBase.hpp"
00049 #include "Thyra_VectorStdOps.hpp"
00050 
00051 
00052 namespace OptiPack {
00053 
00054 
00068 template<typename Scalar>
00069 class DefaultPolyLineSearchPointEvaluator : public LineSearchPointEvaluatorBase<Scalar>
00070 {
00071 public:
00072 
00074   typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;
00075 
00078 
00080   DefaultPolyLineSearchPointEvaluator();
00081   
00083   void initialize(const ArrayView<const RCP<const Thyra::VectorBase<Scalar> > > &vecs);
00084 
00086 
00089 
00091   virtual void computePoint( const ScalarMag &alpha,
00092     const Ptr<Thyra::VectorBase<Scalar> > &p
00093     ) const;
00094 
00096 
00097 private:
00098 
00099   Array<RCP<const Thyra::VectorBase<Scalar> > > vecs_;
00100 
00101 };
00102 
00103 
00108 template<typename Scalar>
00109 const RCP<DefaultPolyLineSearchPointEvaluator<Scalar> >
00110 defaultPolyLineSearchPointEvaluator()
00111 {
00112   return Teuchos::rcp(new DefaultPolyLineSearchPointEvaluator<Scalar>);
00113 }
00114 
00115 
00116 //
00117 // Implementations
00118 //
00119 
00120 
00121 // Constructors/intializers/accessors
00122 
00123 
00124 template<typename Scalar>
00125 DefaultPolyLineSearchPointEvaluator<Scalar>::DefaultPolyLineSearchPointEvaluator()
00126 {}
00127   
00128 
00129 template<typename Scalar>
00130 void DefaultPolyLineSearchPointEvaluator<Scalar>::initialize(
00131   const ArrayView<const RCP<const Thyra::VectorBase<Scalar> > > &vecs
00132   )
00133 {
00134 #ifdef TEUCHOS_DEBUG
00135   TEUCHOS_ASSERT(vecs.size());
00136 #endif
00137   vecs_ = vecs;
00138 }
00139 
00140 
00141 // Overridden from LineSearchPointEvaluatorBase
00142 
00143 
00144 template<typename Scalar>
00145 void DefaultPolyLineSearchPointEvaluator<Scalar>::computePoint( const ScalarMag &alpha,
00146   const Ptr<Thyra::VectorBase<Scalar> > &p
00147   ) const
00148 {
00149   typedef ScalarTraits<Scalar> ST;
00150   using Teuchos::as;
00151   using Thyra::V_V;
00152   using Thyra::Vp_StV;
00153   V_V( p, *vecs_[0] );
00154   if (alpha != ST::zero()) {
00155     ScalarMag alpha_i = alpha;
00156     const int n = vecs_.size();
00157     for (int i = 1; i < n; ++i, alpha_i *= alpha) {
00158       Vp_StV(p, alpha_i, *vecs_[i]); 
00159     }
00160   }
00161 }
00162 
00163 
00164 } // namespace OptiPack
00165 
00166 
00167 #endif // OPTIPACK_DEFAULT_POLY_LINE_SEARCH_POINT_EVALUATOR_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends