ConstrainedOptPack_MatrixDecompRangeOrthog.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 MATRIX_DECOMP_RANGE_ORTHOG_H
#define MATRIX_DECOMP_RANGE_ORTHOG_H

#include "ConstrainedOptPack_Types.hpp"
#include "AbstractLinAlgPack_MatrixSymOpNonsing.hpp"

namespace ConstrainedOptPack {

class MatrixDecompRangeOrthog
  : public AbstractLinAlgPack::MatrixOpNonsing // full path needed for doxygen
{
public:

#ifndef DOXYGEN_COMPILE

  typedef Teuchos::RCP<const MatrixOpNonsing>     C_ptr_t;
  typedef Teuchos::RCP<const MatrixOp>                D_ptr_t;
  typedef Teuchos::RCP<const MatrixSymOpNonsing>  S_ptr_t;
#endif



  MatrixDecompRangeOrthog();

  MatrixDecompRangeOrthog(
    const C_ptr_t   &C_ptr
    ,const D_ptr_t  &D_ptr
    ,const S_ptr_t  &S_ptr
    );

  void initialize(
    const C_ptr_t   &C_ptr
    ,const D_ptr_t  &D_ptr
    ,const S_ptr_t  &S_ptr
    );

  void set_uninitialized();



  const C_ptr_t& C_ptr() const;
  const D_ptr_t& D_ptr() const;
  const S_ptr_t& S_ptr() const;

  

  size_type rows() const;
  size_type cols() const;
  const VectorSpace& space_cols() const;
  const VectorSpace& space_rows() const;
  std::ostream& output(std::ostream& out) const;
  void Vp_StMtV(
    VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const Vector& v_rhs2, value_type beta ) const;



  void V_InvMtV(
    VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
    , const Vector& v_rhs2 ) const;


private:

#ifdef DOXYGEN_COMPILE
  AbstractLinAlgPack::MatrixOpNonsing      *C;
  AbstractLinAlgPack::MatrixOp                 *D;
  AbstractLinAlgPack::MatrixSymOpNonsing   *S;
#else
  C_ptr_t    C_ptr_;
  D_ptr_t    D_ptr_;
  S_ptr_t    S_ptr_;
#endif

  //
  void assert_initialized(const char func_name[]) const;

  // not defined and not to be called
  MatrixDecompRangeOrthog(const MatrixDecompRangeOrthog&);
  MatrixDecompRangeOrthog& operator=(const MatrixDecompRangeOrthog&);

}; // end class MatrixDecompRangeOrthog

// /////////////////////////////////
// Inline members

inline
const MatrixDecompRangeOrthog::C_ptr_t&
MatrixDecompRangeOrthog::C_ptr() const
{
  return C_ptr_;
}

inline
const MatrixDecompRangeOrthog::D_ptr_t&
MatrixDecompRangeOrthog::D_ptr() const
{
  return D_ptr_;
}

inline
const MatrixDecompRangeOrthog::S_ptr_t&
MatrixDecompRangeOrthog::S_ptr() const
{
  return S_ptr_;
}

} // end namespace ConstrainedOptPack

#endif // MATRIX_DECOMP_RANGE_ORTHOG_H