AbstractLinAlgPack_MatrixSymOp.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_SYM_WITH_OP_H
#define MATRIX_SYM_WITH_OP_H

#include "AbstractLinAlgPack_MatrixOp.hpp"

namespace AbstractLinAlgPack {

class MatrixSymOp : public virtual MatrixOp {
public:

  using MatrixOp::Mp_StPtMtP;


#ifndef DOXYGEN_COMPILE

  typedef Teuchos::RCP<const MatrixSymOp>    mat_mswo_ptr_t;
  typedef Teuchos::RCP<MatrixSymOp>          mat_mswo_mut_ptr_t;
#endif

  enum EMatRhsPlaceHolder { DUMMY_ARG };



  friend
  void Mp_StPtMtP(
    MatrixSymOp* sym_lhs, value_type alpha
    ,EMatRhsPlaceHolder dummy_place_holder
    ,const MatrixSymOp& M
    ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
    ,value_type beta
    );
  friend
  void Mp_StMtMtM(
    MatrixSymOp* sym_lhs, value_type alpha
    ,EMatRhsPlaceHolder dummy_place_holder
    ,const MatrixSymOp& M
    ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
    ,value_type beta
    );



  virtual mat_mswo_mut_ptr_t clone_mswo();

  virtual mat_mswo_ptr_t clone_mswo() const;


protected:


  virtual void Mp_StPtMtP(
    MatrixSymOp* sym_lhs, value_type alpha
    ,EMatRhsPlaceHolder dummy_place_holder
    ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
    ,value_type beta
    ) const;



  virtual void Mp_StMtMtM(
    MatrixSymOp* sym_lhs, value_type alpha
    ,EMatRhsPlaceHolder dummy_place_holder
    ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
    ,value_type beta
    ) const;


public:


  size_type cols() const;
  // Returns <tt>this->space_cols()</tt>
  const VectorSpace& space_rows() const;
  mat_mut_ptr_t clone();
  mat_ptr_t clone() const;

  virtual MatrixSymOp& operator=(const MatrixSymOp& M)
  { static_cast<MatrixOp*>(this)->operator=(M); return *this; }

};  // end class MatrixSymOp


inline
void Mp_StPtMtP(
  MatrixSymOp* sym_lhs, value_type alpha
  ,MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder
  ,const MatrixSymOp& M
  ,const GenPermMatrixSlice& gpms_rhs, BLAS_Cpp::Transp gpms_rhs_trans
  ,value_type beta = 1.0
  )
{
  M.Mp_StPtMtP(sym_lhs,alpha,dummy_place_holder,gpms_rhs,gpms_rhs_trans,beta);
}

inline
void Mp_StMtMtM(
  MatrixSymOp* sym_lhs, value_type alpha
  ,MatrixSymOp::EMatRhsPlaceHolder dummy_place_holder
  ,const MatrixSymOp& M
  ,const MatrixOp& mwo_rhs, BLAS_Cpp::Transp mwo_rhs_trans
  ,value_type beta = 1.0
  )
{
  M.Mp_StMtMtM(sym_lhs,alpha,dummy_place_holder,mwo_rhs,mwo_rhs_trans,beta);
}


} // end namespace AbstractLinAlgPack 

#endif  // MATRIX_SYM_WITH_OP_H