MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_NLPAlgo.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_H
00043 #define RSQP_ALGO_H
00044 
00045 #include "MoochoPack_NLPAlgoInterface.hpp"
00046 #include "MoochoPack_NLPAlgoContainer.hpp"
00047 #include "MoochoPack_NLPAlgoState.hpp"
00048 #include "IterationPack_Algorithm.hpp"
00049 #include "StandardAggregationMacros.hpp"
00050 
00051 namespace MoochoPack {
00052 
00055 class NLPAlgo
00056   : public NLPAlgoInterface
00057   , public IterationPack::Algorithm
00058 {
00059 public:
00060 
00063 
00065 
00067   NLPAlgo();
00068 
00070   STANDARD_AGGREGATION_MEMBERS( NLPAlgoContainer, algo_cntr )
00071 
00072   
00073   STANDARD_AGGREGATION_MEMBERS( NLP, nlp )
00074 
00075   
00076   NLPAlgoState& rsqp_state()
00077   { return dynamic_cast<NLPAlgoState&>(state()); }
00078 
00080   const NLPAlgoState& rsqp_state() const
00081   { return dynamic_cast<const NLPAlgoState&>(state()); }
00082 
00084   void do_step_first(Algorithm::poss_type first_step_poss)
00085   { first_step_poss_ = first_step_poss; }
00086 
00089   
00091   const NLPAlgoState& retrieve_state() const;
00092 
00097   NLPSolverClientInterface::EFindMinReturn dispatch();
00098 
00100   void interface_print_algorithm(std::ostream& out) const;
00102   void interface_set_algo_timing( bool algo_timing );
00104   bool interface_algo_timing() const;
00106   void interface_print_algorithm_times( std::ostream& out ) const;
00107 
00109 
00111 
00113   void print_algorithm(std::ostream& out) const;
00114 
00115 protected:
00116 
00117   // First step to execute
00118   Algorithm::poss_type first_step_poss_;
00119 
00120 };  // end class NLPAlgo
00121 
00122 } // end namespace MoochoPack
00123 
00124 #endif  // RSQP_ALGO_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends