ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization Version of the Day
ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef MERIT_FUNC_CALC_1D_QUADRATIC_H
00043 #define MERIT_FUNC_CALC_1D_QUADRATIC_H
00044 
00045 #include "ConstrainedOptPack_MeritFuncCalc1D.hpp"
00046 #include "ConstrainedOptPack_MeritFuncCalc.hpp"
00047 
00048 namespace ConstrainedOptPack {
00049 
00055 class MeritFuncCalc1DQuadratic : public MeritFuncCalc1D {
00056 public:
00057 
00059   typedef const Vector*   const_VectorWithOp_ptr;
00060 
00063 
00081   MeritFuncCalc1DQuadratic(
00082     const MeritFuncCalc&      phi
00083     ,size_type                p
00084     ,const_VectorWithOp_ptr   d[]
00085     ,VectorMutable*     x
00086     );
00087 
00089 
00092 
00094   value_type operator()(value_type alpha) const;
00095 
00097   value_type deriv() const;
00098 
00100   void print_merit_func(
00101     std::ostream& out, const std::string& leading_str ) const;
00102 
00104 
00105 private:
00106   const MeritFuncCalc&        phi_;
00107   size_type                   p_;
00108   const_VectorWithOp_ptr      d_[3];
00109   VectorMutable         *x_;
00110 
00111   // not defined and not to be called
00112   MeritFuncCalc1DQuadratic();
00113   MeritFuncCalc1DQuadratic& operator=( const MeritFuncCalc1DQuadratic& );
00114 
00115 };  // end class MeritFuncCalc1DQuadratic
00116 
00117 } // end namespace ConstrainedOptPack
00118 
00119 #endif  // MERIT_FUNC_CALC_1D_QUADRATIC_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends