AbstractLinAlgPack_MatrixSymNonsing.hpp

Go to the documentation of this file.

// @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 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