MoochoPack_NLPAlgoConfig.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_CONFIG_H
00030 #define RSQP_ALGO_CONFIG_H
00031 
00032 #include "MoochoPack_Types.hpp"
00033 
00034 namespace OptionsFromStreamPack {
00035   class OptionsFromStream;
00036 }
00037 
00038 namespace MoochoPack {
00039 
00040 class NLPAlgoContainer;
00041 class NLPAlgoInterface;
00042 
00049 class NLPAlgoConfig {
00050 public:
00051 
00054 
00056   class InvalidNLPType : public std::logic_error
00057   {public: InvalidNLPType(const std::string& what_arg) : std::logic_error(what_arg) {}};
00059   typedef Teuchos::RCP<
00060     const OptionsFromStreamPack::OptionsFromStream>             options_ptr_t;
00061 
00063 
00066 
00068   virtual ~NLPAlgoConfig() {}
00069 
00071 
00074 
00092   virtual void set_options( const options_ptr_t& options ) = 0;
00093 
00096   virtual const options_ptr_t& get_options() const = 0;
00097 
00099 
00102 
00131   virtual void config_algo_cntr(
00132     NLPAlgoContainer*       algo_cntr
00133     ,std::ostream*           trase_out = 0
00134     ) = 0;
00135 
00155   virtual void init_algo(
00156     NLPAlgoInterface* algo
00157     ) = 0;
00158 
00160 
00161 private:
00162 
00163 #ifdef DOXYGEN_COMPILE // Strictly for doxygen diagrams
00164 
00165   OptionsFromStreamPack::OptionsFromStream    *options;
00166 #endif
00167 
00168 };  // end class NLPAlgoConfig
00169 
00170 } // end namespace MoochoPack
00171 
00172 #endif  // RSQP_ALGO_CONFIG_H

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