MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_TangentialStepWithInequStd_Step.hpp
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 #ifndef NULL_SPACE_STEP_WITH_INEQU_STD_STEP_H
43 #define NULL_SPACE_STEP_WITH_INEQU_STD_STEP_H
44 
45 #include "MoochoPack_Types.hpp"
46 #include "IterationPack_AlgorithmStep.hpp"
47 #include "IterationPack_CastIQMember.hpp"
48 #include "MoochoPack_d_bounds_iter_quant.hpp"
49 #include "MoochoPack_qp_solver_stats.hpp"
50 #include "MoochoPack_act_set_stats.hpp"
51 #include "ConstrainedOptPack_QPSolverRelaxed.hpp"
52 #include "ConstrainedOptPack_QPSolverRelaxedTester.hpp"
55 
56 namespace MoochoPack {
57 
64  : public IterationPack::AlgorithmStep // doxygen needs full path
65 {
66 public:
67 
69  STANDARD_COMPOSITION_MEMBERS( QPSolverRelaxed, qp_solver );
70 
72  STANDARD_COMPOSITION_MEMBERS( QPSolverRelaxedTester, qp_tester );
73 
77  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warm_start_frac );
78 
80  enum EQPTesting { QP_TEST_DEFAULT, QP_TEST, QP_NO_TEST };
81 
87 
91  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, primal_feasible_point_error );
92 
96  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dual_feasible_point_error );
97 
100  const qp_solver_ptr_t &qp_solver
101  ,const qp_tester_ptr_t &qp_tester
102  ,value_type warm_start_frac = 0.8
103  ,EQPTesting qp_testing = QP_TEST_DEFAULT
104  ,bool primal_feasible_point_error = true
105  ,bool dual_feasible_point_error = true
106  );
107 
111  bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
112  , poss_type assoc_step_poss);
114  void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
115  , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
117 
118 private:
121  qp_solver_stats_iq_member qp_solver_stats_;
122  act_set_stats_iq_member act_set_stats_;
123 
124  // not defined and not to be called
126 
127 }; // end class TangentialStepWithInequStd_Step
128 
129 } // end namespace MoochoPack
130 
131 #endif // NULL_SPACE_STEP_WITH_INEQU_STD_STEP_H
STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type, warm_start_frac)
Set the ratio of the number of inequality constraints in the active-set of the last two calls before ...
void print_step(const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
Class for object that attempts to return an IterQuantityAccess<QPSolverStats> from an AlgorithmState ...
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
Class for object that attempts to return an IterQuantityAccess<ActSetStats> from an AlgorithmState ob...
Solves the reduced QP subproblem with bounds and/or general inequalities.
STANDARD_COMPOSITION_MEMBERS(QPSolverRelaxed, qp_solver)
QP solver.