MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NLPInterfacePack_NLPVarReductPerm.hpp
Go to the documentation of this file.
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 NLP_VAR_REDUCT_PERM_H
43 #define NLP_VAR_REDUCT_PERM_H
44 
45 #include "NLPInterfacePack_NLP.hpp"
46 
47 namespace NLPInterfacePack {
48 
105 class NLPVarReductPerm : virtual public NLP
106 {
107 public:
108 
111 
113  typedef Teuchos::RCP<
115 
117  class InvalidBasis : public std::logic_error
118  {public: InvalidBasis(const std::string& what_arg) : std::logic_error(what_arg) {}};
119 
121 
124 
126  virtual const perm_fcty_ptr_t factory_P_var() const = 0;
128  virtual const perm_fcty_ptr_t factory_P_equ() const = 0;
129 
131 
134 
136  virtual Range1D var_dep() const = 0;
138  virtual Range1D var_indep() const = 0;
140  virtual Range1D equ_decomp() const = 0;
142  virtual Range1D equ_undecomp() const = 0;
143 
145 
148 
150  virtual bool nlp_selects_basis() const = 0;
151 
165  virtual bool get_next_basis(
166  Permutation* P_var, Range1D* var_dep
167  ,Permutation* P_equ, Range1D* equ_decomp
168  ) = 0;
169 
182  virtual void set_basis(
183  const Permutation &P_var, const Range1D &var_dep
184  ,const Permutation *P_equ, const Range1D *equ_decomp
185  ) = 0;
186 
194  virtual void get_basis(
195  Permutation* P_var, Range1D* var_dep
196  ,Permutation* P_equ, Range1D* equ_decomp
197  ) const = 0;
198 
200 
201 private:
202 
203 #ifdef DOXYGEN_COMPILE
206 #endif
207 
208 }; // end class NLPVarReductPerm
209 
210 } // end namespace NLPInterfacePack
211 
212 #endif // NLP_VAR_REDUCT_PERM_H
virtual Range1D var_dep() const =0
virtual bool get_next_basis(Permutation *P_var, Range1D *var_dep, Permutation *P_equ, Range1D *equ_decomp)=0
Returns the next basis the NLP has and sets the NLP to the returned basis.
virtual void set_basis(const Permutation &P_var, const Range1D &var_dep, const Permutation *P_equ, const Range1D *equ_decomp)=0
Sets the basis the that the NLP will use to permute the problem.
virtual Range1D equ_decomp() const =0
virtual bool nlp_selects_basis() const =0
Returns true if the NLP can suggest one or more basis selections.
virtual const perm_fcty_ptr_t factory_P_equ() const =0
NLP interface class that adds variable and constriant permutations for variable reduction basis selec...
Teuchos::AbstractFactory< AbstractLinAlgPack::Permutation > * factory_P_var
Teuchos::AbstractFactory< AbstractLinAlgPack::Permutation > * factory_P_equ
Teuchos::RCP< const Teuchos::AbstractFactory< Permutation > > perm_fcty_ptr_t
virtual const perm_fcty_ptr_t factory_P_var() const =0
NLP interface class {abstract}.
virtual const Permutation & P_var() const
Return the permutation object for the variables.
virtual const Permutation & P_equ() const
Return the permutation object for the constraints.
virtual void get_basis(Permutation *P_var, Range1D *var_dep, Permutation *P_equ, Range1D *equ_decomp) const =0
Returns the basis selection currently being used by the NLP.
virtual Range1D var_indep() const =0
virtual Range1D equ_undecomp() const =0