AbstractLinAlgPack_MatrixNonsing.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.
// 
// 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_NONSINGULAR_H
#define ABSTRACT_LINALG_PACK_MATRIX_NONSINGULAR_H

#include "AbstractLinAlgPack_MatrixBase.hpp"
#include "Teuchos_RCP.hpp"

namespace AbstractLinAlgPack {

class MatrixNonsing : public virtual MatrixBase {
public:


  friend
  void V_InvMtV(
    VectorMutable* v_lhs, const MatrixNonsing& M_rhs1
    ,BLAS_Cpp::Transp trans_rhs1, const Vector& v_rhs2);
  friend
  void V_InvMtV(
    VectorMutable* v_lhs, const MatrixNonsing& M_rhs1
    ,BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice& sv_rhs2);
  friend
  value_type transVtInvMtV(
    const Vector& v_rhs1, const MatrixNonsing& M_rhs2
    ,BLAS_Cpp::Transp trans_rhs2, const Vector& v_rhs3);
  friend
  value_type transVtInvMtV(
    const SpVectorSlice& sv_rhs1, const MatrixNonsing& M_rhs2
    ,BLAS_Cpp::Transp trans_rhs2, const SpVectorSlice& sv_rhs3);
  friend
  void M_StInvMtM(
    MatrixOp* m_lhs, value_type alpha
    ,const MatrixNonsing&  M_rhs1,     BLAS_Cpp::Transp trans_rhs1
    ,const MatrixOp&       mwo_rhs2,   BLAS_Cpp::Transp trans_rhs2 );
  friend
  void M_StMtInvM(
    MatrixOp* m_lhs, value_type alpha
    ,const MatrixOp&      mwo_rhs1,  BLAS_Cpp::Transp trans_rhs1
    ,const MatrixNonsing& M_rhs2,    BLAS_Cpp::Transp trans_rhs2 );



#ifndef DOXYGEN_COMPILE

  typedef Teuchos::RCP<const MatrixNonsing>    mat_mns_ptr_t;
  typedef Teuchos::RCP<MatrixNonsing>          mat_mns_mut_ptr_t;
#endif

  class SingularMatrix : public std::logic_error
  {public: SingularMatrix(const std::string& what_arg) : std::logic_error(what_arg) {}};



  virtual mat_mns_mut_ptr_t clone_mns();

  virtual mat_mns_ptr_t clone_mns() const;



  virtual void V_InvMtV(
    VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
    ,const Vector& v_rhs2) const = 0;
  virtual void V_InvMtV(
    VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
    , const SpVectorSlice& sv_rhs2) const;
  virtual value_type transVtInvMtV(
    const Vector& v_rhs1
    ,BLAS_Cpp::Transp trans_rhs2, const Vector& v_rhs3) const;
  virtual value_type transVtInvMtV(
    const SpVectorSlice& sv_rhs1
    ,BLAS_Cpp::Transp trans_rhs2, const SpVectorSlice& sv_rhs3) const;

  //    end Level-2 BLAS


  virtual void M_StInvMtM(
    MatrixOp* m_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs1
    ,const MatrixOp& mwo_rhs2, BLAS_Cpp::Transp trans_rhs2
    ) const;
  virtual void M_StMtInvM(
    MatrixOp* m_lhs, value_type alpha
    ,const MatrixOp& mwo_rhs1, BLAS_Cpp::Transp trans_rhs1
    ,BLAS_Cpp::Transp trans_rhs2
    ) const;

  //    end Level-3 BLAS

};  // end class MatrixNonsing


//@ {

inline void V_InvMtV(
  VectorMutable* v_lhs, const MatrixNonsing& M_rhs1
  ,BLAS_Cpp::Transp trans_rhs1, const Vector& v_rhs2)
{
  M_rhs1.V_InvMtV(v_lhs,trans_rhs1,v_rhs2);
}

inline void V_InvMtV(
  VectorMutable* v_lhs, const MatrixNonsing& M_rhs1
  ,BLAS_Cpp::Transp trans_rhs1, const SpVectorSlice& sv_rhs2)
{
  M_rhs1.V_InvMtV(v_lhs,trans_rhs1,sv_rhs2);
}

inline value_type transVtInvMtV(
  const Vector& v_rhs1, const MatrixNonsing& M_rhs2
  ,BLAS_Cpp::Transp trans_rhs2, const Vector& v_rhs3)
{
  return M_rhs2.transVtInvMtV(v_rhs1,trans_rhs2,v_rhs3);
}

inline value_type transVtInvMtV(
  const SpVectorSlice& sv_rhs1, const MatrixNonsing& M_rhs2
  ,BLAS_Cpp::Transp trans_rhs2, const SpVectorSlice& sv_rhs3)
{
  return M_rhs2.transVtInvMtV(sv_rhs1,trans_rhs2,sv_rhs3);
}

//    end Level-2 BLAS
//@ }

//@ {

inline void M_StInvMtM(
  MatrixOp* m_lhs, value_type alpha
  ,const MatrixNonsing&  M_rhs1,     BLAS_Cpp::Transp trans_rhs1
  ,const MatrixOp&       mwo_rhs2,   BLAS_Cpp::Transp trans_rhs2 )
{
  M_rhs1.M_StInvMtM(m_lhs,alpha,trans_rhs1,mwo_rhs2,trans_rhs2);
}

inline void M_StMtInvM(
  MatrixOp* m_lhs, value_type alpha
  ,const MatrixOp&      mwo_rhs1,  BLAS_Cpp::Transp trans_rhs1
  ,const MatrixNonsing& M_rhs2,    BLAS_Cpp::Transp trans_rhs2 )
{
  M_rhs2.M_StMtInvM(m_lhs,alpha,mwo_rhs1,trans_rhs1,trans_rhs2);
}

//    end Level-3 BLAS
//@ }

//    end Inline non-member operation functions

} // end namespace AbstractLinAlgPack

#endif  // ABSTRACT_LINALG_PACK_MATRIX_NONSINGULAR_H