MoochoPack_NLPAlgo.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 RSQP_ALGO_H
00030 #define RSQP_ALGO_H
00031 
00032 #include "MoochoPack_NLPAlgoInterface.hpp"
00033 #include "MoochoPack_NLPAlgoContainer.hpp"
00034 #include "MoochoPack_NLPAlgoState.hpp"
00035 #include "IterationPack_Algorithm.hpp"
00036 #include "StandardAggregationMacros.hpp"
00037 
00038 namespace MoochoPack {
00039 
00042 class NLPAlgo
00043   : public NLPAlgoInterface
00044   , public IterationPack::Algorithm
00045 {
00046 public:
00047 
00050 
00052 
00054   NLPAlgo();
00055 
00057   STANDARD_AGGREGATION_MEMBERS( NLPAlgoContainer, algo_cntr )
00058 
00059   
00060   STANDARD_AGGREGATION_MEMBERS( NLP, nlp )
00061 
00062   
00063   NLPAlgoState& rsqp_state()
00064   { return dynamic_cast<NLPAlgoState&>(state()); }
00065 
00067   const NLPAlgoState& rsqp_state() const
00068   { return dynamic_cast<const NLPAlgoState&>(state()); }
00069 
00071   void do_step_first(Algorithm::poss_type first_step_poss)
00072   { first_step_poss_ = first_step_poss; }
00073 
00076   
00078   const NLPAlgoState& retrieve_state() const;
00079 
00084   NLPSolverClientInterface::EFindMinReturn dispatch();
00085 
00087   void interface_print_algorithm(std::ostream& out) const;
00089   void interface_set_algo_timing( bool algo_timing );
00091   bool interface_algo_timing() const;
00093   void interface_print_algorithm_times( std::ostream& out ) const;
00094 
00096 
00098 
00100   void print_algorithm(std::ostream& out) const;
00101 
00102 protected:
00103 
00104   // First step to execute
00105   Algorithm::poss_type first_step_poss_;
00106 
00107 };  // end class NLPAlgo
00108 
00109 } // end namespace MoochoPack
00110 
00111 #endif  // RSQP_ALGO_H

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