NLPInterfacePack_NLPVarReductPerm.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef NLP_VAR_REDUCT_PERM_H
#define NLP_VAR_REDUCT_PERM_H

#include "NLPInterfacePack_NLP.hpp"

namespace NLPInterfacePack {

class NLPVarReductPerm : virtual public NLP
{
public: 


  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<Permutation> >         perm_fcty_ptr_t;

  class InvalidBasis : public std::logic_error
  {public: InvalidBasis(const std::string& what_arg) : std::logic_error(what_arg) {}};



  virtual const perm_fcty_ptr_t factory_P_var() const = 0;
  virtual const perm_fcty_ptr_t factory_P_equ() const = 0;



  virtual Range1D var_dep() const = 0;
  virtual Range1D var_indep() const = 0;
  virtual Range1D equ_decomp() const = 0;
  virtual Range1D equ_undecomp() const = 0;


  
  virtual bool nlp_selects_basis() const = 0;

  virtual bool get_next_basis(
    Permutation*  P_var,   Range1D* var_dep
    ,Permutation* P_equ,   Range1D* equ_decomp
    ) = 0;
  
  virtual void set_basis(
    const Permutation   &P_var,   const Range1D  &var_dep
    ,const Permutation  *P_equ,   const Range1D  *equ_decomp
    ) =  0;

  virtual void get_basis(
    Permutation*  P_var,   Range1D* var_dep
    ,Permutation* P_equ,   Range1D* equ_decomp
    ) const = 0;
  

private:

#ifdef DOXYGEN_COMPILE
  Teuchos::AbstractFactory<AbstractLinAlgPack::Permutation>    *factory_P_var;
  Teuchos::AbstractFactory<AbstractLinAlgPack::Permutation>    *factory_P_equ;
#endif  
  
}; // end class NLPVarReductPerm

} // end namespace NLPInterfacePack 

#endif // NLP_VAR_REDUCT_PERM_H