OptiPack Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
OptiPack_DefaultPolyLineSearchPointEvaluator.hpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // OptiPack: Collection of simple Thyra-based Optimization ANAs
6 // Copyright (2009) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #ifndef OPTIPACK_DEFAULT_POLY_LINE_SEARCH_POINT_EVALUATOR_HPP
45 #define OPTIPACK_DEFAULT_POLY_LINE_SEARCH_POINT_EVALUATOR_HPP
46 
47 
49 #include "Thyra_VectorStdOps.hpp"
50 
51 
52 namespace OptiPack {
53 
54 
68 template<typename Scalar>
70 {
71 public:
72 
75 
78 
81 
83  void initialize(const ArrayView<const RCP<const Thyra::VectorBase<Scalar> > > &vecs);
84 
86 
89 
91  virtual void computePoint( const ScalarMag &alpha,
92  const Ptr<Thyra::VectorBase<Scalar> > &p
93  ) const;
94 
96 
97 private:
98 
100 
101 };
102 
103 
108 template<typename Scalar>
111 {
113 }
114 
115 
116 //
117 // Implementations
118 //
119 
120 
121 // Constructors/intializers/accessors
122 
123 
124 template<typename Scalar>
126 {}
127 
128 
129 template<typename Scalar>
131  const ArrayView<const RCP<const Thyra::VectorBase<Scalar> > > &vecs
132  )
133 {
134 #ifdef TEUCHOS_DEBUG
135  TEUCHOS_ASSERT(vecs.size());
136 #endif
137  vecs_ = vecs;
138 }
139 
140 
141 // Overridden from LineSearchPointEvaluatorBase
142 
143 
144 template<typename Scalar>
146  const Ptr<Thyra::VectorBase<Scalar> > &p
147  ) const
148 {
149  typedef ScalarTraits<Scalar> ST;
150  using Teuchos::as;
151  using Thyra::V_V;
152  using Thyra::Vp_StV;
153  V_V( p, *vecs_[0] );
154  if (alpha != ST::zero()) {
155  ScalarMag alpha_i = alpha;
156  const int n = vecs_.size();
157  for (int i = 1; i < n; ++i, alpha_i *= alpha) {
158  Vp_StV(p, alpha_i, *vecs_[i]);
159  }
160  }
161 }
162 
163 
164 } // namespace OptiPack
165 
166 
167 #endif // OPTIPACK_DEFAULT_POLY_LINE_SEARCH_POINT_EVALUATOR_HPP
Default line search point evaluator using a polynomial linear combination of vectors.
virtual void computePoint(const ScalarMag &alpha, const Ptr< Thyra::VectorBase< Scalar > > &p) const
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
TypeTo as(const TypeFrom &t)
void initialize(const ArrayView< const RCP< const Thyra::VectorBase< Scalar > > > &vecs)
Base class interface for line search point updates.
const RCP< DefaultPolyLineSearchPointEvaluator< Scalar > > defaultPolyLineSearchPointEvaluator()
Nonmember constructor.
#define TEUCHOS_ASSERT(assertion_test)
int n