NLPInterfacePack_NLPVarReductPerm.hpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef NLP_VAR_REDUCT_PERM_H
00030 #define NLP_VAR_REDUCT_PERM_H
00031 
00032 #include "NLPInterfacePack_NLP.hpp"
00033 
00034 namespace NLPInterfacePack {
00035 
00092 class NLPVarReductPerm : virtual public NLP
00093 {
00094 public: 
00095 
00098 
00100   typedef Teuchos::RCP<
00101     const Teuchos::AbstractFactory<Permutation> >         perm_fcty_ptr_t;
00102 
00104   class InvalidBasis : public std::logic_error
00105   {public: InvalidBasis(const std::string& what_arg) : std::logic_error(what_arg) {}};
00106 
00108 
00111 
00113   virtual const perm_fcty_ptr_t factory_P_var() const = 0;
00115   virtual const perm_fcty_ptr_t factory_P_equ() const = 0;
00116 
00118 
00121 
00123   virtual Range1D var_dep() const = 0;
00125   virtual Range1D var_indep() const = 0;
00127   virtual Range1D equ_decomp() const = 0;
00129   virtual Range1D equ_undecomp() const = 0;
00130 
00132 
00135   
00137   virtual bool nlp_selects_basis() const = 0;
00138 
00152   virtual bool get_next_basis(
00153     Permutation*  P_var,   Range1D* var_dep
00154     ,Permutation* P_equ,   Range1D* equ_decomp
00155     ) = 0;
00156   
00169   virtual void set_basis(
00170     const Permutation   &P_var,   const Range1D  &var_dep
00171     ,const Permutation  *P_equ,   const Range1D  *equ_decomp
00172     ) =  0;
00173 
00181   virtual void get_basis(
00182     Permutation*  P_var,   Range1D* var_dep
00183     ,Permutation* P_equ,   Range1D* equ_decomp
00184     ) const = 0;
00185   
00187 
00188 private:
00189 
00190 #ifdef DOXYGEN_COMPILE
00191   Teuchos::AbstractFactory<AbstractLinAlgPack::Permutation>    *factory_P_var;
00192   Teuchos::AbstractFactory<AbstractLinAlgPack::Permutation>    *factory_P_equ;
00193 #endif  
00194   
00195 }; // end class NLPVarReductPerm
00196 
00197 } // end namespace NLPInterfacePack 
00198 
00199 #endif // NLP_VAR_REDUCT_PERM_H

Generated on Tue Oct 20 12:51:48 2009 for MOOCHO (Single Doxygen Collection) by doxygen 1.4.7