MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_DecompositionSystemHandler_Strategy.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 DECOMPOSITION_SYSTEM_HANDLER_STRATEGY_H
00043 #define DECOMPOSITION_SYSTEM_HANDLER_STRATEGY_H
00044 
00045 #include "MoochoPack_Types.hpp"
00046 #include "IterationPack_Algorithm.hpp"
00047 
00048 namespace MoochoPack {
00049 
00054 class DecompositionSystemHandler_Strategy {
00055 public:
00056   
00059 
00061   enum EDecompSysTesting { DST_DEFAULT, DST_TEST, DST_NO_TEST };
00063   enum EDecompSysPrintLevel { DSPL_USE_GLOBAL, DSPL_LEAVE_DEFAULT };
00064 
00066 
00068   virtual ~DecompositionSystemHandler_Strategy() {}
00069 
00075   virtual bool update_decomposition(
00076     NLPAlgo                                &algo
00077     ,NLPAlgoState                          &s
00078     ,NLPFirstOrder                         &nlp
00079     ,EDecompSysTesting                     decomp_sys_testing
00080     ,EDecompSysPrintLevel                  decomp_sys_testing_print_level
00081     ,bool                                  *new_decomp_selected
00082     ) = 0;
00083 
00086   virtual void print_update_decomposition(
00087     const NLPAlgo                          &algo
00088     ,const NLPAlgoState                    &s
00089     ,std::ostream                          &out
00090     ,const std::string                     &leading_spaces
00091     ) const = 0;
00092 
00093 }; // end class DecompositionSystemHandler_Strategy
00094 
00095 } // end namespace MoochoPack
00096 
00097 #endif // DECOMPOSITION_SYSTEM_HANDLER_STRATEGY_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends