MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_NLPAlgo.cpp
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 // #define RELEASE_TRACE
00043 
00044 #include <iostream> // for debugging Release version.
00045 #include <typeinfo>
00046 
00047 #include "MoochoPack_NLPAlgo.hpp"
00048 
00049 namespace MoochoPack {
00050 
00051 NLPAlgo::NLPAlgo()
00052   : algo_cntr_(NULL), nlp_(NULL), first_step_poss_(1)
00053 {}
00054 
00055 // Overridden form rSQPAlgoInteface
00056 
00057 const NLPAlgoState& NLPAlgo::retrieve_state() const
00058 {
00059   return dynamic_cast<const NLPAlgoState&>(state());
00060 }
00061 
00062 NLPSolverClientInterface::EFindMinReturn
00063 NLPAlgo::dispatch() {
00064   switch( do_algorithm(first_step_poss_) ) {
00065     case IterationPack::TERMINATE_TRUE:
00066       return NLPSolverClientInterface::SOLUTION_FOUND;
00067     case IterationPack::TERMINATE_FALSE:
00068       return NLPSolverClientInterface::ALGORITHMIC_ERROR;
00069     case IterationPack::MAX_ITER_EXCEEDED:
00070       return NLPSolverClientInterface::MAX_ITER_EXCEEDED;
00071     case IterationPack::MAX_RUN_TIME_EXCEEDED:
00072       return NLPSolverClientInterface::MAX_RUN_TIME_EXCEEDED;
00073     case IterationPack::INTERRUPTED_TERMINATE_TRUE:
00074       return NLPSolverClientInterface::SOLUTION_FOUND;
00075     case IterationPack::INTERRUPTED_TERMINATE_FALSE:
00076       return NLPSolverClientInterface::ALGORITHMIC_ERROR;
00077     default:
00078       TEUCHOS_TEST_FOR_EXCEPT(true);
00079   }
00080   return NLPSolverClientInterface::SOLUTION_FOUND;  // will never be called.
00081 }
00082 
00083 void NLPAlgo::interface_print_algorithm(std::ostream& out) const {
00084   print_steps(out);
00085   print_algorithm(out);
00086 }
00087 
00088 void NLPAlgo::interface_set_algo_timing( bool algo_timing ) {
00089   set_algo_timing(algo_timing);
00090 }
00091 
00092 bool NLPAlgo::interface_algo_timing() const {
00093   return algo_timing();
00094 }
00095 
00096 void NLPAlgo::interface_print_algorithm_times( std::ostream& out ) const {
00097   print_algorithm_times(out);
00098 }
00099 
00100 // Overridden from Algorithm.
00101 
00102 void NLPAlgo::print_algorithm(std::ostream& out) const {
00103   out
00104     << "\n*** NLP ***\n"
00105     << typeName(*get_nlp()) << "\n";
00106 
00107   Algorithm::print_algorithm(out);
00108 }
00109 
00110 } // end namespace MoochoPack
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends