MoochoPack_NLPAlgoInterface.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 // 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_INTERFACE_H
00030 #define RSQP_ALGO_INTERFACE_H
00031 
00032 #include "MoochoPack_Types.hpp"
00033 #include "MoochoPack_NLPSolverClientInterface.hpp"
00034 
00035 namespace MoochoPack {
00036 
00041 class NLPAlgoInterface {
00042 public:
00043 
00045   virtual ~NLPAlgoInterface() {}
00046 
00049   virtual void interface_print_algorithm(std::ostream& out) const = 0;
00050 
00057   virtual NLPSolverClientInterface::EFindMinReturn dispatch() = 0;
00058 
00061   virtual const NLPAlgoState& retrieve_state() const = 0;
00062 
00065 
00067   virtual void interface_set_algo_timing( bool algo_timing ) = 0;
00069   virtual bool interface_algo_timing() const = 0;
00071   virtual void interface_print_algorithm_times( std::ostream& out ) const = 0;
00072 
00074 
00075 };  // end class NLPAlgoInterface
00076 
00077 } // end namespace MoochoPack
00078 
00079 #endif  // RSQP_ALGO_INTERFACE_H

Generated on Thu Sep 18 12:34:28 2008 for MoochoPack : Framework for Large-Scale Optimization Algorithms by doxygen 1.3.9.1