MoochoPack_NLPAlgoContainer.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_CONTAINER_H
00030 #define RSQP_ALGO_CONTAINER_H
00031 
00032 #include "MoochoPack_NLPAlgoClientInterface.hpp"
00033 #include "MoochoPack_NLPAlgoInterface.hpp"
00034 #include "MoochoPack_NLPAlgoConfig.hpp"
00035 #include "Teuchos_StandardCompositionMacros.hpp"
00036 
00037 namespace MoochoPack {
00038 
00044 class NLPAlgoContainer : public NLPAlgoClientInterface {
00045 public:
00046 
00049 
00051   STANDARD_COMPOSITION_MEMBERS( NLPAlgoInterface, algo );
00052 
00054   NLPAlgoContainer()
00055   {}
00056 
00058 
00061 
00063   void set_config(const config_ptr_t& config);
00065   config_ptr_t& get_config();
00067   const config_ptr_t& get_config() const;
00069   NLPAlgoConfig& config();
00071   const NLPAlgoConfig& config() const;
00072 
00074 
00077 
00079   EFindMinReturn find_min();
00081   void configure_algorithm(std::ostream* trase_out);
00083   void print_algorithm(std::ostream& out) const;
00085   void set_algo_timing( bool algo_timing );
00087   bool algo_timing() const;
00089   void print_algorithm_times( std::ostream& out ) const;
00090 
00092 
00093 private:
00094 
00095   config_ptr_t      config_;
00096 
00097   // Assert that the object has been set up properly and throw exception if it has not
00098   void assert_valid_setup() const;
00099 
00100   // Not defined and not to be called
00101   NLPAlgoContainer(const NLPAlgoContainer&);
00102   NLPAlgoContainer& operator=(const NLPAlgoContainer&);
00103 
00104 };  // end class NLPAlgoContainer
00105 
00106 } // end namespace MoochoPack
00107 
00108 #endif  // RSQP_ALGO_CONTAINER_H

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