ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_MeritFuncCalc1DQuadratic.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include "ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp"
43 #include "ConstrainedOptPack_MeritFuncCalc.hpp"
44 #include "AbstractLinAlgPack_VectorMutable.hpp"
45 #include "AbstractLinAlgPack_VectorStdOps.hpp"
46 #include "Teuchos_Assert.hpp"
47 
48 namespace ConstrainedOptPack {
49 
50 MeritFuncCalc1DQuadratic::MeritFuncCalc1DQuadratic(
51  const MeritFuncCalc& phi
52  ,size_type p
54  ,VectorMutable* x
55  )
56  : phi_(phi), p_(p), x_(x)
57 {
59  !(1 <= p && p <= 2 ), std::invalid_argument
60  ,"MeritFuncCalc1DQuadratic::MeritFuncCalc1DQuadratic(...) : Error! "
61  "p = " << p << " must be in the range 1 <= p <= 2"
62  );
63  for( size_type i = 0; i <= p; ++i )
64  d_[i] = d[i];
65 }
66 
67 value_type MeritFuncCalc1DQuadratic::operator()(value_type alpha) const
68 {
70  *x_ = *d_[0];
71  value_type alpha_i = alpha;
72  for( size_type i = 1; i <= p_; ++i, alpha_i *= alpha ) {
73  Vp_StV( x_, alpha_i, *d_[i] );
74  }
75  return phi_( *x_ );
76 }
77 
79 {
80  return phi_.deriv();
81 }
82 
84  std::ostream& out, const std::string& L
85  ) const
86 {
87  out << L << "*** MeritFuncCalc1DQuadratic\n"
88  << L << "x = xo + alpha*d[1] + alpha^2*d[2]\n";
89  phi_.print_merit_func( out, L );
90 }
91 
92 } // end namespace ConstrainedOptPack
value_type operator()(value_type alpha) const
Returns phi( x = sum( alpha^k * d[k], k = 0...p-1 ) ).
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
void Vp_StV(VectorMutable *v_lhs, const value_type &alpha, const Vector &v_rhs)
size_t size_type
void print_merit_func(std::ostream &out, const std::string &leading_str) const
Calls phi->print_merit_func().
Abstract iterface for n-D merit functions {abstract}.
virtual value_type deriv() const =0
Calls value(d_k) on aggregate merit_func.
virtual void print_merit_func(std::ostream &out, const std::string &leading_str) const =0
Print what this merit function is.