MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_NLPAlgoState.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 RSQP_STATE_H
43 #define RSQP_STATE_H
44 
45 #include <deque>
46 
47 #include "MoochoPack_Types.hpp"
48 #include "IterationPack_IterQuantityAccess.hpp"
49 #include "IterationPack_AlgorithmState.hpp"
50 #include "IterationPack_cast_iq.hpp"
51 #include "IterationPack_IterQuantityAccessContiguous.hpp"
52 #include "AbstractLinAlgPack_VectorSpace.hpp"
53 #include "AbstractLinAlgPack_Permutation.hpp"
54 #include "ConstrainedOptPack_DecompositionSystem.hpp"
55 #include "AbstractLinAlgPack_MatrixOp.hpp"
56 //#include "DenseLinAlgPack_IVector.hpp"
57 #include "Teuchos_StandardCompositionMacros.hpp"
58 #include "Teuchos_StandardMemberCompositionMacros.hpp"
59 
60 namespace MoochoPack {
61 
67 
68 // Iteration Info
69 extern const std::string num_basis_name;
70 // NLP Problem Info
71 extern const std::string x_name;
72 extern const std::string f_name;
73 extern const std::string Gf_name;
74 extern const std::string HL_name;
75 extern const std::string c_name;
76 extern const std::string h_name;
77 extern const std::string Gc_name;
78 // Constraint Gradient Null Space / Range Space Decomposition Info
79 extern const std::string Y_name;
80 extern const std::string Z_name;
81 extern const std::string R_name;
82 extern const std::string Uy_name;
83 extern const std::string Uz_name;
84 // Search Direction Info
85 extern const std::string py_name;
86 extern const std::string Ypy_name;
87 extern const std::string pz_name;
88 extern const std::string Zpz_name;
89 extern const std::string d_name;
90 // Reduced QP Subproblem Info
91 extern const std::string rGf_name;
92 extern const std::string rHL_name;
93 extern const std::string w_name;
94 extern const std::string zeta_name;
95 extern const std::string qp_grad_name;
96 extern const std::string eta_name;
97 // Global Convergence Info
98 extern const std::string alpha_name;
99 extern const std::string merit_func_nlp_name;
100 extern const std::string mu_name;
101 extern const std::string phi_name;
102 // KKT Info
103 extern const std::string opt_kkt_err_name;
104 extern const std::string feas_kkt_err_name;
105 extern const std::string comp_kkt_err_name;
106 extern const std::string GL_name;
107 extern const std::string rGL_name;
108 extern const std::string lambda_name;
109 extern const std::string nu_name;
110 
112 
123 
126 #define STATE_IQ_DECL(TYPE,NAME) \
127  virtual IterQuantityAccess<TYPE>& NAME(); \
128  virtual const IterQuantityAccess<TYPE>& NAME() const; \
129 private: \
130  iq_id_encap NAME ## _iq_id_; \
131 public:
132 
135 #define STATE_INDEX_IQ_DECL(NAME) \
136  STATE_IQ_DECL(index_type,NAME) \
137 
138 
140 #define STATE_SCALAR_IQ_DECL(NAME) \
141  STATE_IQ_DECL(value_type,NAME) \
142 
143 
145 #define STATE_VECTOR_IQ_DECL(NAME) \
146  STATE_IQ_DECL(VectorMutable,NAME) \
147 
148 
155 #define STATE_IQ_DEF(CLASS,TYPE,NAME,NAME_STR) \
156 IterQuantityAccess<TYPE>& \
157 CLASS::NAME() \
158 { \
159  update_iq_id( NAME_STR, &NAME ## _iq_id_ ); \
160  return IterationPack::cast_iq<TYPE>( \
161  *this, NAME ## _iq_id_.iq_id, NAME_STR ); \
162 } \
163 const IterQuantityAccess<TYPE>& \
164 CLASS::NAME() const \
165 { \
166  return const_cast<CLASS*>(this)->NAME(); \
167 }
168 
173 #define STATE_INDEX_IQ_DEF(CLASS,NAME,NAME_STR) \
174 IterQuantityAccess<index_type>& \
175 CLASS::NAME() \
176 { \
177  update_index_type_iq_id( NAME_STR, &NAME ## _iq_id_ ); \
178  return IterationPack::cast_iq<index_type>( \
179  *this, NAME ## _iq_id_.iq_id, NAME_STR ); \
180 } \
181 const IterQuantityAccess<index_type>& \
182 CLASS::NAME() const \
183 { \
184  return const_cast<CLASS*>(this)->NAME(); \
185 }
186 
191 #define STATE_SCALAR_IQ_DEF(CLASS,NAME,NAME_STR) \
192 IterQuantityAccess<value_type>& \
193 CLASS::NAME() \
194 { \
195  update_value_type_iq_id( NAME_STR, &NAME ## _iq_id_ ); \
196  return IterationPack::cast_iq<value_type>( \
197  *this, NAME ## _iq_id_.iq_id, NAME_STR ); \
198 } \
199 const IterQuantityAccess<value_type>& \
200 CLASS::NAME() const \
201 { \
202  return const_cast<CLASS*>(this)->NAME(); \
203 }
204 
214 #define STATE_VECTOR_IQ_DEF(CLASS,NAME,NAME_STR,VEC_SPC,VEC_RN) \
215 IterQuantityAccess<VectorMutable>& \
216 CLASS::NAME() \
217 { \
218  update_vector_iq_id( NAME_STR, VEC_SPC, VEC_RN, &NAME ## _iq_id_ ); \
219  return IterationPack::cast_iq<VectorMutable>( \
220  *this, NAME ## _iq_id_.iq_id, NAME_STR ); \
221 } \
222 const IterQuantityAccess<VectorMutable>& \
223 CLASS::NAME() const \
224 { \
225  return const_cast<CLASS*>(this)->NAME(); \
226 }
227 
229 
264 class NLPAlgoState
265  : public IterationPack::AlgorithmState // doxygen needs full path
266 {
267 public:
268 
271 
273  class InvalidType : public std::logic_error
274  {public: InvalidType(const std::string& what_arg) : std::logic_error(what_arg) {}};
275 
277  typedef Teuchos::RCP<const VectorSpace> vec_space_ptr_t;
278 
280 
281 protected:
282 
283  // /////////////////////////////
284  // Protected types.
285 
287  struct iq_id_encap {
288  iq_id_encap() : iq_id(DOES_NOT_EXIST) {}
289  iq_id_type iq_id;
290  };
291 
292 public:
293 
296 
297  // ToDo: Implement all set_space_xx methods to update factories
298  // for all vector iteration quantities.
299 
301  STANDARD_COMPOSITION_MEMBERS( DecompositionSystem, decomp_sys );
303  STANDARD_CONST_COMPOSITION_MEMBERS( VectorSpace, space_x );
305  STANDARD_CONST_COMPOSITION_MEMBERS( VectorSpace, space_c );
312  void set_space_range (const vec_space_ptr_t& space_range );
313  vec_space_ptr_t& get_space_range();
314  const vec_space_ptr_t& get_space_range() const;
315  const VectorSpace& space_range() const;
322  void set_space_null (const vec_space_ptr_t& space_null );
323  vec_space_ptr_t& get_space_null();
324  const vec_space_ptr_t& get_space_null() const;
325  const VectorSpace& space_null() const;
326 
331  NLPAlgoState(
332  const decomp_sys_ptr_t& decomp_sys = Teuchos::null
333  ,const vec_space_ptr_t& space_x = Teuchos::null
334  ,const vec_space_ptr_t& space_c = Teuchos::null
335  ,const vec_space_ptr_t& space_range = Teuchos::null
336  ,const vec_space_ptr_t& space_null = Teuchos::null
337  );
338 
340  virtual ~NLPAlgoState() {}
341 
343 
346 
348  STATE_INDEX_IQ_DECL(num_basis)
349 
350  //@}
351 
352 
354 
356  STATE_VECTOR_IQ_DECL(x)
358  STATE_SCALAR_IQ_DECL(f)
360  STATE_VECTOR_IQ_DECL(Gf)
362  STATE_IQ_DECL(MatrixSymOp,HL)
364  STATE_VECTOR_IQ_DECL(c)
366  STATE_IQ_DECL(MatrixOp,Gc)
367 
369 
372 
374  STATE_IQ_DECL(MatrixOp,Y)
376  STATE_IQ_DECL(MatrixOp,Z)
378  STATE_IQ_DECL(MatrixOpNonsing,R)
380  STATE_IQ_DECL(MatrixOp,Uy)
382  STATE_IQ_DECL(MatrixOp,Uz)
383 
385 
388 
390  STATE_VECTOR_IQ_DECL(py)
392  STATE_VECTOR_IQ_DECL(Ypy)
394  STATE_VECTOR_IQ_DECL(pz)
396  STATE_VECTOR_IQ_DECL(Zpz)
398  STATE_VECTOR_IQ_DECL(d)
399 
401 
404 
406  STATE_VECTOR_IQ_DECL(rGf)
408  STATE_IQ_DECL(MatrixSymOp,rHL)
410  STATE_VECTOR_IQ_DECL(w)
412  STATE_SCALAR_IQ_DECL(zeta)
414  STATE_VECTOR_IQ_DECL(qp_grad)
416  STATE_SCALAR_IQ_DECL(eta)
417 
419 
422 
424  STATE_SCALAR_IQ_DECL(alpha)
426  STATE_IQ_DECL(MeritFuncNLP,merit_func_nlp)
428  STATE_SCALAR_IQ_DECL(mu)
430  STATE_SCALAR_IQ_DECL(phi)
431 
433 
436 
438  STATE_SCALAR_IQ_DECL(opt_kkt_err)
440  STATE_SCALAR_IQ_DECL(feas_kkt_err)
442  STATE_SCALAR_IQ_DECL(comp_kkt_err)
444  STATE_VECTOR_IQ_DECL(GL)
446  STATE_VECTOR_IQ_DECL(rGL)
448  STATE_VECTOR_IQ_DECL(lambda)
450  STATE_VECTOR_IQ_DECL(nu)
451 
453 
456 
458  STANDARD_MEMBER_COMPOSITION_MEMBERS( Range1D, var_dep );
460  STANDARD_MEMBER_COMPOSITION_MEMBERS( Range1D, var_indep );
461 
463  STANDARD_MEMBER_COMPOSITION_MEMBERS( Range1D, equ_decomp );
465  STANDARD_MEMBER_COMPOSITION_MEMBERS( Range1D, equ_undecomp );
466 
468 
471 
473  STANDARD_COMPOSITION_MEMBERS( Permutation, P_var_current );
475  STANDARD_COMPOSITION_MEMBERS( Permutation, P_var_last );
477  STANDARD_COMPOSITION_MEMBERS( Permutation, P_equ_current );
479  STANDARD_COMPOSITION_MEMBERS( Permutation, P_equ_last );
480 
482 
483 protected:
484 
485  enum { NUM_VEC_SPACE_TYPES = 5 };
486  enum EVecSpaceType {
487  VST_SPACE_X = 0
488  ,VST_SPACE_C = 1
489  ,VST_SPACE_RANGE = 2
490  ,VST_SPACE_NULL = 3
491  };
492 
493  // /////////////////////////////
494  // Protected member functions
495 
496  // These implementations are used to avoid code blot and help in debugging
497  // (can't debug macros very well).
498 
500  void update_iq_id(
501  const std::string& iq_name
502  ,iq_id_encap* iq_id
503  ) const;
505  void update_index_type_iq_id(
506  const std::string& iq_name
507  ,iq_id_encap* iq_id
508  );
510  void update_value_type_iq_id(
511  const std::string& iq_name
512  ,iq_id_encap* iq_id
513  );
515  void update_vector_iq_id(
516  const std::string& iq_name
517  ,const VectorSpace::space_ptr_t& vec_space
518  ,EVecSpaceType vec_space_type
519  ,iq_id_encap* iq_id
520  );
521 
522 private:
523 
524  // ////////////////////////////
525  // Private types
526 
527  typedef std::deque<iq_id_type> iq_vector_list_t;
528 
529  // ////////////////////////////
530  // Private data member
531 
532  vec_space_ptr_t space_range_;
533  vec_space_ptr_t space_null_;
534 
535  iq_vector_list_t vector_iqs_lists_[NUM_VEC_SPACE_TYPES];
536 
537  // ////////////////////////////
538  // Private member functions.
539 
540  // Update the vector factories for all of the iteration quantities
541  // in the input list.
542  void update_vector_factories(
543  EVecSpaceType vec_space_type
544  ,const vec_space_ptr_t& vec_space
545  );
546 
547  // not defined and not to be called
548  NLPAlgoState(const NLPAlgoState&);
549  NLPAlgoState& operator=(const NLPAlgoState&);
550 
551 }; // end class NLPAlgoState
552 
553 // ////////////////////////////////////
554 // Inline members
555 
556 inline
557 NLPAlgoState::vec_space_ptr_t& NLPAlgoState::get_space_range()
558 { return space_range_ ; }
559 
560 inline
561 const NLPAlgoState::vec_space_ptr_t& NLPAlgoState::get_space_range() const
562 { return space_range_; }
563 
564 inline
565 const VectorSpace& NLPAlgoState::space_range() const
566 { return *space_range_; }
567 
568 inline
569 NLPAlgoState::vec_space_ptr_t& NLPAlgoState::get_space_null()
570 { return space_null_ ; }
571 
572 inline
573 const NLPAlgoState::vec_space_ptr_t& NLPAlgoState::get_space_null() const
574 { return space_null_; }
575 
576 inline
577 const VectorSpace& NLPAlgoState::space_null() const
578 { return *space_null_; }
579 
580 } // end namespace MoochoPack
581 
582 #endif // RSQP_STATE_H
MoochoPack::NLPAlgoState::update_iq_id
void update_iq_id(const std::string &iq_name, iq_id_encap *iq_id) const
Definition: MoochoPack_NLPAlgoState.cpp:186
STATE_IQ_DECL
#define STATE_IQ_DECL(TYPE, NAME)
Add class declarations for an arbitrary iteration quantity.
Definition: MoochoPack_NLPAlgoState.hpp:126
STATE_SCALAR_IQ_DECL
#define STATE_SCALAR_IQ_DECL(NAME)
Add class declarations for a scalar (i.e. value_type) iteration quantity.
Definition: MoochoPack_NLPAlgoState.hpp:140
Teuchos_StandardMemberCompositionMacros.hpp
MoochoPack::NLPAlgoState::update_vector_iq_id
void update_vector_iq_id(const std::string &iq_name, const VectorSpace::space_ptr_t &vec_space, EVecSpaceType vec_space_type, iq_id_encap *iq_id)
Definition: MoochoPack_NLPAlgoState.cpp:261
MoochoPack::NLPAlgoState::update_value_type_iq_id
void update_value_type_iq_id(const std::string &iq_name, iq_id_encap *iq_id)
Definition: MoochoPack_NLPAlgoState.cpp:231
MoochoPack::NLPAlgoState
Reduced space SQP state encapsulation interface.
Definition: MoochoPack_NLPAlgoState.hpp:264
MoochoPack::NLPAlgoState::STANDARD_COMPOSITION_MEMBERS
STANDARD_COMPOSITION_MEMBERS(DecompositionSystem, decomp_sys)
Set the DecompositionSystem object that all share.
MoochoPack::NLPAlgoState::vec_space_ptr_t
Teuchos::RCP< const VectorSpace > vec_space_ptr_t
Definition: MoochoPack_NLPAlgoState.hpp:277
STATE_INDEX_IQ_DECL
#define STATE_INDEX_IQ_DECL(NAME)
Add class declarations for an index (i.e. index_type) iteration quantity.
Definition: MoochoPack_NLPAlgoState.hpp:135
MoochoPack::NLPAlgoState::InvalidType
Thrown if an iteration quantity is of an invalid type.
Definition: MoochoPack_NLPAlgoState.hpp:273
MoochoPack::NLPAlgoState::iq_id_encap
Definition: MoochoPack_NLPAlgoState.hpp:287
MoochoPack::NLPAlgoState::set_space_null
void set_space_null(const vec_space_ptr_t &space_null)
Set the VectorSpace of the null space (pz).
Definition: MoochoPack_NLPAlgoState.cpp:109
MoochoPack::NLPAlgoState::update_index_type_iq_id
void update_index_type_iq_id(const std::string &iq_name, iq_id_encap *iq_id)
Definition: MoochoPack_NLPAlgoState.cpp:201
MoochoPack::NLPAlgoState::NLPAlgoState
NLPAlgoState(const decomp_sys_ptr_t &decomp_sys=Teuchos::null, const vec_space_ptr_t &space_x=Teuchos::null, const vec_space_ptr_t &space_c=Teuchos::null, const vec_space_ptr_t &space_range=Teuchos::null, const vec_space_ptr_t &space_null=Teuchos::null)
Construct.
Definition: MoochoPack_NLPAlgoState.cpp:115
MoochoPack::NLPAlgoState::STANDARD_CONST_COMPOSITION_MEMBERS
STANDARD_CONST_COMPOSITION_MEMBERS(VectorSpace, space_x)
Set the VectorSpace of x.
Teuchos_StandardCompositionMacros.hpp
MoochoPack::NLPAlgoState::STANDARD_MEMBER_COMPOSITION_MEMBERS
STANDARD_MEMBER_COMPOSITION_MEMBERS(Range1D, var_dep)
Range of dependent variables [1,r].
MoochoPack::NLPAlgoState::set_space_range
void set_space_range(const vec_space_ptr_t &space_range)
Set the VectorSpace of the range space (py).
Definition: MoochoPack_NLPAlgoState.cpp:103
STATE_VECTOR_IQ_DECL
#define STATE_VECTOR_IQ_DECL(NAME)
Add class declarations for a VectorMutable iteration quantity.
Definition: MoochoPack_NLPAlgoState.hpp:145
Generated on Wed Dec 2 2015 08:50:01 for MoochoPack : Framework for Large-Scale Optimization Algorithms by   doxygen 1.8.6