MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_NLPAlgoContainer.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_CONTAINER_H
00043 #define RSQP_ALGO_CONTAINER_H
00044 
00045 #include "MoochoPack_NLPAlgoClientInterface.hpp"
00046 #include "MoochoPack_NLPAlgoInterface.hpp"
00047 #include "MoochoPack_NLPAlgoConfig.hpp"
00048 #include "Teuchos_StandardCompositionMacros.hpp"
00049 
00050 namespace MoochoPack {
00051 
00057 class NLPAlgoContainer : public NLPAlgoClientInterface {
00058 public:
00059 
00062 
00064   STANDARD_COMPOSITION_MEMBERS( NLPAlgoInterface, algo );
00065 
00067   NLPAlgoContainer()
00068   {}
00069 
00071 
00074 
00076   void set_config(const config_ptr_t& config);
00078   config_ptr_t& get_config();
00080   const config_ptr_t& get_config() const;
00082   NLPAlgoConfig& config();
00084   const NLPAlgoConfig& config() const;
00085 
00087 
00090 
00092   EFindMinReturn find_min();
00094   void configure_algorithm(std::ostream* trase_out);
00096   void print_algorithm(std::ostream& out) const;
00098   void set_algo_timing( bool algo_timing );
00100   bool algo_timing() const;
00102   void print_algorithm_times( std::ostream& out ) const;
00103 
00105 
00106 private:
00107 
00108   config_ptr_t      config_;
00109 
00110   // Assert that the object has been set up properly and throw exception if it has not
00111   void assert_valid_setup() const;
00112 
00113   // Not defined and not to be called
00114   NLPAlgoContainer(const NLPAlgoContainer&);
00115   NLPAlgoContainer& operator=(const NLPAlgoContainer&);
00116 
00117 };  // end class NLPAlgoContainer
00118 
00119 } // end namespace MoochoPack
00120 
00121 #endif  // RSQP_ALGO_CONTAINER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends