MoochoPack_QuasiNewtonStats.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 QUASI_NEWTON_STATS_H
00030 #define QUASI_NEWTON_STATS_H
00031 
00032 #include "MoochoPack_Types.hpp"
00033 
00034 namespace MoochoPack {
00035 
00038 class QuasiNewtonStats {
00039 public:
00040 
00041   // Public types
00042 
00044   enum EUpdate { UNKNOWN, REINITIALIZED, UPDATED, DAMPENED_UPDATED
00045     , SKIPED, INDEF_SKIPED };
00046 
00047   // Public interface
00048 
00050   QuasiNewtonStats()
00051     : update_(UNKNOWN)
00052   {}
00053 
00055   void set_updated_stats( EUpdate update )
00056   {
00057     update_ = update;
00058   }
00059 
00061   EUpdate updated() const
00062   {
00063     return update_;
00064   }
00065 
00066 private:
00067   EUpdate update_;
00068 
00069 };  // end class QuasiNewtonStats
00070 
00071 } // end namespace MoochoPack
00072 
00073 #endif  // QUASI_NEWTON_STATS_H

Generated on Tue Jul 13 09:30:53 2010 for MOOCHO (Single Doxygen Collection) by  doxygen 1.4.7