MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_NLPAlgoConfig.hpp
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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef RSQP_ALGO_CONFIG_H
00043 #define RSQP_ALGO_CONFIG_H
00044 
00045 #include "MoochoPack_Types.hpp"
00046 
00047 namespace OptionsFromStreamPack {
00048   class OptionsFromStream;
00049 }
00050 
00051 namespace MoochoPack {
00052 
00053 class NLPAlgoContainer;
00054 class NLPAlgoInterface;
00055 
00062 class NLPAlgoConfig {
00063 public:
00064 
00067 
00069   class InvalidNLPType : public std::logic_error
00070   {public: InvalidNLPType(const std::string& what_arg) : std::logic_error(what_arg) {}};
00072   typedef Teuchos::RCP<
00073     const OptionsFromStreamPack::OptionsFromStream>             options_ptr_t;
00074 
00076 
00079 
00081   virtual ~NLPAlgoConfig() {}
00082 
00084 
00087 
00105   virtual void set_options( const options_ptr_t& options ) = 0;
00106 
00109   virtual const options_ptr_t& get_options() const = 0;
00110 
00112 
00115 
00144   virtual void config_algo_cntr(
00145     NLPAlgoContainer*       algo_cntr
00146     ,std::ostream*           trase_out = 0
00147     ) = 0;
00148 
00168   virtual void init_algo(
00169     NLPAlgoInterface* algo
00170     ) = 0;
00171 
00173 
00174 private:
00175 
00176 #ifdef DOXYGEN_COMPILE // Strictly for doxygen diagrams
00177 
00178   OptionsFromStreamPack::OptionsFromStream    *options;
00179 #endif
00180 
00181 };  // end class NLPAlgoConfig
00182 
00183 } // end namespace MoochoPack
00184 
00185 #endif  // RSQP_ALGO_CONFIG_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends