NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs Version of the Day
NLPInterfacePack_NLPVarReductPerm.hpp
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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef NLP_VAR_REDUCT_PERM_H
00043 #define NLP_VAR_REDUCT_PERM_H
00044 
00045 #include "NLPInterfacePack_NLP.hpp"
00046 
00047 namespace NLPInterfacePack {
00048 
00105 class NLPVarReductPerm : virtual public NLP
00106 {
00107 public: 
00108 
00111 
00113   typedef Teuchos::RCP<
00114     const Teuchos::AbstractFactory<Permutation> >         perm_fcty_ptr_t;
00115 
00117   class InvalidBasis : public std::logic_error
00118   {public: InvalidBasis(const std::string& what_arg) : std::logic_error(what_arg) {}};
00119 
00121 
00124 
00126   virtual const perm_fcty_ptr_t factory_P_var() const = 0;
00128   virtual const perm_fcty_ptr_t factory_P_equ() const = 0;
00129 
00131 
00134 
00136   virtual Range1D var_dep() const = 0;
00138   virtual Range1D var_indep() const = 0;
00140   virtual Range1D equ_decomp() const = 0;
00142   virtual Range1D equ_undecomp() const = 0;
00143 
00145 
00148   
00150   virtual bool nlp_selects_basis() const = 0;
00151 
00165   virtual bool get_next_basis(
00166     Permutation*  P_var,   Range1D* var_dep
00167     ,Permutation* P_equ,   Range1D* equ_decomp
00168     ) = 0;
00169   
00182   virtual void set_basis(
00183     const Permutation   &P_var,   const Range1D  &var_dep
00184     ,const Permutation  *P_equ,   const Range1D  *equ_decomp
00185     ) =  0;
00186 
00194   virtual void get_basis(
00195     Permutation*  P_var,   Range1D* var_dep
00196     ,Permutation* P_equ,   Range1D* equ_decomp
00197     ) const = 0;
00198   
00200 
00201 private:
00202 
00203 #ifdef DOXYGEN_COMPILE
00204   Teuchos::AbstractFactory<AbstractLinAlgPack::Permutation>    *factory_P_var;
00205   Teuchos::AbstractFactory<AbstractLinAlgPack::Permutation>    *factory_P_equ;
00206 #endif  
00207   
00208 }; // end class NLPVarReductPerm
00209 
00210 } // end namespace NLPInterfacePack 
00211 
00212 #endif // NLP_VAR_REDUCT_PERM_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends