AbstractLinAlgPack_MultiVectorMutableDense.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 MULTI_VECTOR_MUTABLE_DENSE_H
#define MULTI_VECTOR_MUTABLE_DENSE_H

#include "AbstractLinAlgPack_MatrixOpSerial.hpp"
#include "AbstractLinAlgPack_MatrixOpGetGMSMutable.hpp"
#include "AbstractLinAlgPack_MultiVectorMutable.hpp"
#include "DenseLinAlgPack_DMatrixClass.hpp"
#include "ReleaseResource.hpp"

namespace AbstractLinAlgPack {

class MultiVectorMutableDense
  : public AbstractLinAlgPack::MultiVectorMutable   // doxygen needs the full path
  , public MatrixOpSerial
  , public MatrixOpGetGMS
{
public:

  typedef Teuchos::RCP<
    MemMngPack::ReleaseResource>  release_resource_ptr_t;


  MultiVectorMutableDense(
    const size_type                    rows = 0
    ,const size_type                   cols = 0
    );
  MultiVectorMutableDense(
    DMatrixSlice                       gms
    ,BLAS_Cpp::Transp                  gms_trans
    ,const release_resource_ptr_t&     gms_release
    );
  void initialize(
    const size_type                    rows
    ,const size_type                   cols
    );
  void initialize(
    DMatrixSlice                       gms
    ,BLAS_Cpp::Transp                  gms_trans
    ,const release_resource_ptr_t&     gms_release
    );


  
  DMatrixSlice set_gms();
  const DMatrixSlice get_gms() const;
  BLAS_Cpp::Transp gms_trans() const;
  const release_resource_ptr_t& gms_release() const;



  const DMatrixSlice get_gms_view() const;
  void free_gms_view(const DMatrixSlice* gms_view) const;



  DMatrixSlice get_gms_view();
  void commit_gms_view(DMatrixSlice* gms_view);

  

  size_type rows() const;
  size_type cols() const;



  void zero_out();
  void Mt_S( value_type alpha );
  MatrixOp& operator=(const MatrixOp& mwo_rhs);
  std::ostream& output(std::ostream& out) const;
  bool Mp_StM(
    MatrixOp* mwo_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs
    ) const;
  bool Mp_StM(
    value_type alpha,const MatrixOp& M_rhs, BLAS_Cpp::Transp trans_rhs
    );
  bool syrk(
     BLAS_Cpp::Transp M_trans, value_type alpha
    ,value_type beta, MatrixSymOp* sym_lhs
    ) const;
  bool Mp_StMtM(
    MatrixOp* mwo_lhs, value_type alpha
    ,const MatrixOp& mwo_rhs1, BLAS_Cpp::Transp trans_rhs1
    ,BLAS_Cpp::Transp trans_rhs2
    ,value_type beta ) const;
  bool Mp_StMtM(
    MatrixOp* mwo_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs1
    ,const MatrixOp& mwo_rhs2, BLAS_Cpp::Transp trans_rhs2
    ,value_type beta ) const;



  access_by_t access_by() const;



  vec_mut_ptr_t col(index_type j);
  vec_mut_ptr_t row(index_type i);
  vec_mut_ptr_t diag(int k);
  multi_vec_mut_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng);



  void Vp_StMtV(
    DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const DVectorSlice& vs_rhs2, value_type beta) const;
  void Vp_StMtV(
    DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const SpVectorSlice& sv_rhs2, value_type beta) const;

  // ToDo: Add more overrides as they are needed!


protected:


  void apply_op(
    EApplyBy apply_by, const RTOpPack::RTOp& primary_op
    ,const size_t num_multi_vecs,      const MultiVector**   multi_vecs
    ,const size_t num_targ_multi_vecs, MultiVectorMutable**  targ_multi_vecs
    ,RTOpPack::ReductTarget* reduct_objs[]
    ,const index_type primary_first_ele   , const index_type primary_sub_dim   , const index_type primary_global_offset
    ,const index_type secondary_first_ele , const index_type secondary_sub_dim 
    ) const;
  void apply_op(
    EApplyBy apply_by, const RTOpPack::RTOp& primary_op, const RTOpPack::RTOp& secondary_op
    ,const size_t num_multi_vecs,      const MultiVector**   multi_vecs
    ,const size_t num_targ_multi_vecs, MultiVectorMutable**  targ_multi_vecs
    ,RTOpPack::ReductTarget *reduct_obj
    ,const index_type primary_first_ele   , const index_type primary_sub_dim   , const index_type primary_global_offset
    ,const index_type secondary_first_ele , const index_type secondary_sub_dim 
    ) const;


private:

  // ///////////////////////////////////////
  // Private data members
  
  DMatrixSlice              gms_;
  BLAS_Cpp::Transp          gms_trans_;
  release_resource_ptr_t    gms_release_;

}; // end class MultiVectorMutableDense     

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

inline
DMatrixSlice
MultiVectorMutableDense::set_gms()
{
  return gms_;
}

inline
const DMatrixSlice
MultiVectorMutableDense::get_gms() const
{
  return gms_;
}

inline
BLAS_Cpp::Transp
MultiVectorMutableDense::gms_trans() const
{
  return gms_trans_;
}

inline
const MultiVectorMutableDense::release_resource_ptr_t&
MultiVectorMutableDense::gms_release() const
{
  return gms_release_;
}

} // end namespace AbstractLinAlgPack

#endif // MULTI_VECTOR_MUTABLE_DENSE_H