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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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