ConstrainedOptPack_MeritFuncNLESqrResid.hpp

Go to the documentation of this file.
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef MERIT_FUNC_NLE_SQR_RESID_H
00030 #define MERIT_FUNC_NLE_SQR_RESID_H
00031 
00032 #include "ConstrainedOptPack_MeritFuncNLE.hpp"
00033 
00034 namespace ConstrainedOptPack {
00035 
00050 class MeritFuncNLESqrResid : public MeritFuncNLE {
00051 public:
00052 
00054   MeritFuncNLESqrResid();
00055 
00057   value_type calc_deriv( const Vector& c_k );
00058 
00059   // ////////////////////////////////
00060   // Overridden from MeritFuncNLE
00061 
00063   value_type value(const Vector& c) const;
00064 
00066   value_type deriv() const;
00067 
00069   void print_merit_func(std::ostream& out
00070     , const std::string& leading_str) const;
00071 
00072 private:
00073   value_type deriv_;
00074 
00075 };  // end class MeritFuncNLESqrResid
00076 
00077 } // end namespace ConstrainedOptPack
00078 
00079 #endif  // MERIT_FUNC_NLE_SQR_RESID_H

Generated on Thu Sep 18 12:35:14 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1