MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_NLPAlgo.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 // #define RELEASE_TRACE
43 
44 #include <iostream> // for debugging Release version.
45 #include <typeinfo>
46 
47 #include "MoochoPack_NLPAlgo.hpp"
48 
49 namespace MoochoPack {
50 
52  : algo_cntr_(NULL), nlp_(NULL), first_step_poss_(1)
53 {}
54 
55 // Overridden form rSQPAlgoInteface
56 
58 {
59  return dynamic_cast<const NLPAlgoState&>(state());
60 }
61 
64  switch( do_algorithm(first_step_poss_) ) {
65  case IterationPack::TERMINATE_TRUE:
66  return NLPSolverClientInterface::SOLUTION_FOUND;
67  case IterationPack::TERMINATE_FALSE:
68  return NLPSolverClientInterface::ALGORITHMIC_ERROR;
69  case IterationPack::MAX_ITER_EXCEEDED:
70  return NLPSolverClientInterface::MAX_ITER_EXCEEDED;
71  case IterationPack::MAX_RUN_TIME_EXCEEDED:
72  return NLPSolverClientInterface::MAX_RUN_TIME_EXCEEDED;
73  case IterationPack::INTERRUPTED_TERMINATE_TRUE:
74  return NLPSolverClientInterface::SOLUTION_FOUND;
75  case IterationPack::INTERRUPTED_TERMINATE_FALSE:
76  return NLPSolverClientInterface::ALGORITHMIC_ERROR;
77  default:
79  }
80  return NLPSolverClientInterface::SOLUTION_FOUND; // will never be called.
81 }
82 
83 void NLPAlgo::interface_print_algorithm(std::ostream& out) const {
84  print_steps(out);
85  print_algorithm(out);
86 }
87 
88 void NLPAlgo::interface_set_algo_timing( bool algo_timing ) {
89  set_algo_timing(algo_timing);
90 }
91 
93  return algo_timing();
94 }
95 
96 void NLPAlgo::interface_print_algorithm_times( std::ostream& out ) const {
98 }
99 
100 // Overridden from Algorithm.
101 
102 void NLPAlgo::print_algorithm(std::ostream& out) const {
103  out
104  << "\n*** NLP ***\n"
105  << typeName(*get_nlp()) << "\n";
106 
108 }
109 
110 } // end namespace MoochoPack
virtual EAlgoReturn do_algorithm(poss_type step_poss=1)
void interface_print_algorithm(std::ostream &out) const
virtual void print_steps(std::ostream &out) const
virtual bool algo_timing() const
NLPAlgo()
Constructs with no step, added_step, pre_step, post_step, state, or decomp_sys objects added...
void print_algorithm(std::ostream &out) const
overridden from Algorihth.
virtual void print_algorithm(std::ostream &out) const
void interface_set_algo_timing(bool algo_timing)
Reduced space SQP state encapsulation interface.
NLPSolverClientInterface::EFindMinReturn dispatch()
This is the main control function for the rSQP algorithm.
AlgorithmState & state()
bool interface_algo_timing() const
virtual void print_algorithm_times(std::ostream &out) const
void interface_print_algorithm_times(std::ostream &out) const
virtual void set_algo_timing(bool algo_timing)
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
std::string typeName(const T &t)
const NLPAlgoState & retrieve_state() const