AbstractLinAlgPack_MatrixSymNonsing.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 ABSTRACT_LINALG_PACK_MATRIX_SYM_NONSINGULAR_H
#define ABSTRACT_LINALG_PACK_MATRIX_SYM_NONSINGULAR_H

#include "AbstractLinAlgPack_MatrixNonsing.hpp"

namespace AbstractLinAlgPack {

class MatrixSymNonsing
  : public virtual MatrixNonsing
{
public:


#ifndef DOXYGEN_COMPILE

  typedef Teuchos::RCP<const MatrixSymNonsing>    mat_msns_ptr_t;
  typedef Teuchos::RCP<MatrixSymNonsing>          mat_msns_mut_ptr_t;
#endif

  enum EMatrixDummyArg { DUMMY_ARG };



  friend
  void M_StMtInvMtM(
    MatrixSymOp* sym_gms_lhs, value_type alpha
    ,const MatrixOp& mwo
    ,BLAS_Cpp::Transp mwo_trans, const MatrixSymNonsing& mswof
    ,EMatrixDummyArg mwo_rhs
     );



  virtual mat_msns_mut_ptr_t clone_msns();

  virtual mat_msns_ptr_t clone_msns() const;


protected:


  virtual void M_StMtInvMtM(
    MatrixSymOp* symwo_lhs, value_type alpha
    ,const MatrixOp& mwo, BLAS_Cpp::Transp mwo_trans
    ,EMatrixDummyArg
    ) const;


public:


  mat_mns_mut_ptr_t clone_mns();
  mat_mns_ptr_t clone_mns() const;

};  // end class MatrixSymNonsing

// ////////////////////////////////////////////////////////////////////////////////////////////////

inline
void M_StMtInvMtM(
  MatrixSymOp* sym_gms_lhs, value_type alpha
  ,const MatrixOp& mwo
  ,BLAS_Cpp::Transp mwo_trans, const MatrixSymNonsing& mswof
  ,MatrixSymNonsing::EMatrixDummyArg mwo_rhs
  )
{
  mswof.M_StMtInvMtM(sym_gms_lhs,alpha,mwo,mwo_trans,mwo_rhs);
}


} // end namespace AbstractLinAlgPack

#endif  // ABSTRACT_LINALG_PACK_MATRIX_SYM_NONSINGULAR_H