ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_DecompositionSystemVarReduct.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 DECOMPOSITION_SYSTEM_VAR_REDUCT_H
43 #define DECOMPOSITION_SYSTEM_VAR_REDUCT_H
44 
45 #include "ConstrainedOptPack_DecompositionSystem.hpp"
47 #include "AbstractLinAlgPack_BasisSystem.hpp"
48 
49 namespace ConstrainedOptPack {
50 
77 public:
78 
81 
84  MAT_IMP_EXPLICIT
85  ,MAT_IMP_IMPLICIT
86  ,MAT_IMP_AUTO
87  };
88 
90 
93 
98 
99  // ToDo: The above could be implemented as pure virtual funtions if needed later!
100 
102 
105 
108  EExplicitImplicit D_imp = MAT_IMP_AUTO
109  ,EExplicitImplicit Uz_imp = MAT_IMP_AUTO
110  )
111  :D_imp_(D_imp), Uz_imp_(Uz_imp)
112  {}
113 
115 
118 
120  virtual Range1D var_indep() const = 0;
122  virtual Range1D var_dep() const = 0;
123 
125 
126 private:
127 
128  // not defined and not to be called!
131 
132 }; // end class DecompositionSystemVarReduct
133 
134 } // end namespace ConstrainedOptPack
135 
136 #endif // DECOMPOSITION_SYSTEM_VAR_REDUCT_H
DecompositionSystemVarReduct(EExplicitImplicit D_imp=MAT_IMP_AUTO, EExplicitImplicit Uz_imp=MAT_IMP_AUTO)
This class abstracts a decomposition choice for the quasi-range space Y and null space Z matrices for...
Specialization of DecompositionSystem for variable reduction decompositions.
STANDARD_MEMBER_COMPOSITION_MEMBERS(EExplicitImplicit, D_imp)
Set whether to use explicit or implicit D = -inv(C)*N matrix.