MoochoPack_NLPAlgoClientInterface.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_CLIENT_INTERFACE_H
00030 #define RSQP_ALGO_CLIENT_INTERFACE_H
00031 
00032 #include "MoochoPack_NLPSolverClientInterface.hpp"
00033 
00034 namespace MoochoPack {
00035 
00041 class NLPAlgoClientInterface : public NLPSolverClientInterface {
00042 public:
00043 
00046 
00048   typedef Teuchos::RCP<NLPAlgoConfig> config_ptr_t;
00049 
00051 
00054 
00056   virtual void set_config(const config_ptr_t& config) = 0;
00058   virtual config_ptr_t& get_config() = 0;
00060   virtual const config_ptr_t& get_config() const = 0;
00062   virtual NLPAlgoConfig& config() = 0;
00064   virtual const NLPAlgoConfig& config() const = 0;
00065 
00067   
00078   virtual void configure_algorithm(std::ostream* trase_out = 0) = 0;
00079 
00081   virtual void print_algorithm(std::ostream& out) const = 0;
00082 
00083 private:
00084 
00085 #ifdef DOXYGEN_COMPILE // Strictly for doxygen diagrams
00086 
00087   NLPAlgoConfig    *config;
00088 #endif
00089 
00090 };  // end class NLPAlgoClientInterface
00091 
00092 } // end namespace MoochoPack
00093 
00094 #endif  // RSQP_ALGO_CLIENT_INTERFACE_H

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