ConstrainedOptPack_DecompositionSystem.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 DECOMPOSITION_SYSTEM_H
#define DECOMPOSITION_SYSTEM_H

#include <stdexcept>

#include "ConstrainedOptPack_Types.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"

namespace ConstrainedOptPack {

class DecompositionSystem {
public:


  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixOpNonsing> >    mat_nonsing_fcty_ptr_t;
  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixOp> >               mat_fcty_ptr_t;
  class SingularDecomposition : public std::logic_error
  {public: SingularDecomposition(const std::string& what_arg) : std::logic_error(what_arg) {}};
  class InvalidMatrixType : public std::logic_error
  {public: InvalidMatrixType(const std::string& what_arg) : std::logic_error(what_arg) {}};
  class TestFailed : public std::runtime_error
  {public: TestFailed(const std::string& what_arg) : std::runtime_error(what_arg) {}};
  enum EOutputLevel {
    PRINT_NONE          = 0,
    PRINT_BASIC_INFO    = 1,
    PRINT_MORE_INFO     = 2,
    PRINT_VECTORS       = 3,
    PRINT_EVERY_THING   = 4
    };
  enum ERunTests { RUN_TESTS, NO_TESTS };
  enum EMatRelations { MATRICES_INDEP_IMPS, MATRICES_ALLOW_DEP_IMPS };


  virtual ~DecompositionSystem() {}


  virtual size_type n() const;

  virtual size_type m() const = 0;

  virtual size_type r() const;

  virtual Range1D equ_decomp() const;

  virtual Range1D equ_undecomp() const;



  virtual const VectorSpace::space_ptr_t space_range() const = 0;

  virtual const VectorSpace::space_ptr_t space_null() const = 0;



  virtual const mat_fcty_ptr_t factory_Z() const = 0;

  virtual const mat_fcty_ptr_t factory_Y() const = 0;

  virtual const mat_nonsing_fcty_ptr_t factory_R() const = 0;
  
  virtual const mat_fcty_ptr_t factory_Uz() const = 0;

  virtual const mat_fcty_ptr_t factory_Uy() const = 0;



  virtual void update_decomp(
    std::ostream          *out
    ,EOutputLevel         olevel
    ,ERunTests            test_what
    ,const MatrixOp       &Gc
    ,MatrixOp             *Z
    ,MatrixOp             *Y
    ,MatrixOpNonsing      *R
    ,MatrixOp             *Uz
    ,MatrixOp             *Vy
    ,EMatRelations        mat_rel = MATRICES_INDEP_IMPS
    ) const = 0;
  
  virtual void print_update_decomp(
    std::ostream& out, const std::string& leading_str ) const = 0;

  
};  // end class DecompositionSystem

} // end namespace ConstrainedOptPack

#endif // DECOMPOSITION_SYSTEM_H