Thyra_LinearOpBase_decl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) 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 Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_LINEAR_OP_DECL_HPP
#define THYRA_LINEAR_OP_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_ExpandScalarTypeMacros.hpp"
#include "Teuchos_PromotionTraits.hpp"


namespace Thyra {


template<class Scalar>
class LinearOpBase : virtual public Teuchos::Describable {
public:


  virtual RCP< const VectorSpaceBase<Scalar> > range() const = 0;

  virtual RCP< const VectorSpaceBase<Scalar> > domain() const = 0;

  bool opSupported(EOpTransp M_trans) const
    {
      return opSupportedImpl(M_trans);
    }

  void apply(
    const EOpTransp M_trans,
    const MultiVectorBase<Scalar> &X,
    const Ptr<MultiVectorBase<Scalar> > &Y,
    const Scalar alpha,
    const Scalar beta
    ) const
    {
      applyImpl(M_trans, X, Y, alpha, beta);
    }

  virtual RCP<const LinearOpBase<Scalar> > clone() const;



  THYRA_DEPRECATED bool applySupports( const EConj conj ) const;

  THYRA_DEPRECATED void apply(
    const EConj conj,
    const MultiVectorBase<Scalar> &X,
    MultiVectorBase<Scalar> *Y,
    const Scalar alpha = static_cast<Scalar>(1.0),
    const Scalar beta = static_cast<Scalar>(0.0)
    ) const;

  THYRA_DEPRECATED bool applyTransposeSupports( const EConj conj ) const;

  THYRA_DEPRECATED void applyTranspose(
    const EConj conj,
    const MultiVectorBase<Scalar> &X,
    MultiVectorBase<Scalar> *Y,
    const Scalar alpha = static_cast<Scalar>(1.0),
    const Scalar beta = static_cast<Scalar>(0.0)
    ) const;


protected:


  virtual bool opSupportedImpl(EOpTransp M_trans) const = 0;

  virtual void applyImpl(
    const EOpTransp M_trans,
    const MultiVectorBase<Scalar> &X,
    const Ptr<MultiVectorBase<Scalar> > &Y,
    const Scalar alpha,
    const Scalar beta
    ) const = 0;


private:
  
  // Not defined and not to be called
  LinearOpBase<Scalar>&
  operator=(const LinearOpBase<Scalar>&);

};


template<class Scalar>
bool isFullyUninitialized( const LinearOpBase<Scalar> &M );


template<class Scalar>
bool isPartiallyInitialized( const LinearOpBase<Scalar> &M );


template<class Scalar>
bool isFullyInitialized( const LinearOpBase<Scalar> &M );


template<class Scalar>
inline
bool opSupported( const LinearOpBase<Scalar> &M, EOpTransp M_trans );


template<class Scalar>
void apply(
  const LinearOpBase<Scalar> &M,
  const EOpTransp M_trans,
  const MultiVectorBase<Scalar> &X,
  const Ptr<MultiVectorBase<Scalar> > &Y,
  const Scalar alpha = static_cast<Scalar>(1.0),
  const Scalar beta = static_cast<Scalar>(0.0)
  );


inline
void apply(
  const LinearOpBase<double> &M,
  const EOpTransp M_trans,
  const MultiVectorBase<double> &X,
  const Ptr<MultiVectorBase<double> > &Y,
  const double alpha = 1.0,
  const double beta = 0.0
  );


// Deprecated


template<class Scalar>
inline
THYRA_DEPRECATED void apply(
  const LinearOpBase<Scalar> &M,
  const EConj conj,
  const MultiVectorBase<Scalar> &X,
  MultiVectorBase<Scalar> *Y,
  const Scalar alpha = static_cast<Scalar>(1.0),
  const Scalar beta = static_cast<Scalar>(0.0)
  );


template<class Scalar>
inline
THYRA_DEPRECATED void applyTranspose(
  const LinearOpBase<Scalar> &M,
  const EConj conj,
  const MultiVectorBase<Scalar> &X,
  MultiVectorBase<Scalar> *Y,
  const Scalar alpha = static_cast<Scalar>(1.0),
  const Scalar beta = static_cast<Scalar>(0.0)
  );


template<class Scalar>
THYRA_DEPRECATED void apply(
  const LinearOpBase<Scalar> &M,
  const EOpTransp M_trans,
  const MultiVectorBase<Scalar> &X,
  MultiVectorBase<Scalar> *Y,
  const Scalar alpha = static_cast<Scalar>(1.0),
  const Scalar beta = static_cast<Scalar>(0.0)
  );


} // end namespace Thyra


//
// Inline and other Template Implementations
//


template<class Scalar>
inline
bool Thyra::isFullyUninitialized( const LinearOpBase<Scalar> &M )
{
  return ( is_null(M.range()) || is_null(M.domain()) );
}


template<class Scalar>
bool Thyra::isPartiallyInitialized( const LinearOpBase<Scalar> &M )
{
  return
    (
      ( !is_null(M.range()) && !is_null(M.domain()) )
      && 
      (
        !opSupported(M,NOTRANS) && !opSupported(M,CONJ)
        && !opSupported(M,TRANS) && !opSupported(M,CONJTRANS)
        )
      );
}


template<class Scalar>
bool Thyra::isFullyInitialized( const LinearOpBase<Scalar> &M )
{
  return
    (
      ( !is_null(M.range()) && !is_null(M.domain()) )
      && 
      (
        opSupported(M,NOTRANS) || opSupported(M,CONJ)
        || opSupported(M,TRANS) || opSupported(M,CONJTRANS)
        )
      );
}


template<class Scalar>
inline
bool Thyra::opSupported( const LinearOpBase<Scalar> &M, EOpTransp M_trans )
{
  return M.opSupported(M_trans);
}


inline
void Thyra::apply(
  const LinearOpBase<double> &M,
  const EOpTransp M_trans,
  const MultiVectorBase<double> &X,
  const Ptr<MultiVectorBase<double> > &Y,
  const double alpha,
  const double beta
  )
{
  apply<double>(M, M_trans, X, Y, alpha, beta);
}


// Deprecated


template<class Scalar>
inline
void Thyra::apply(
  const LinearOpBase<Scalar> &M,
  const EConj conj,
  const MultiVectorBase<Scalar> &X,
  MultiVectorBase<Scalar> *Y,
  const Scalar alpha,
  const Scalar beta
  )
{
  M.apply(conj, X, Y, alpha, beta);
}


template<class Scalar>
inline
void Thyra::applyTranspose(
  const LinearOpBase<Scalar> &M,
  const EConj conj,
  const MultiVectorBase<Scalar> &X,
  MultiVectorBase<Scalar> *Y,
  const Scalar alpha,
  const Scalar beta
  )
{
  M.applyTranspose(conj, X, Y, alpha, beta);
}


template<class Scalar>
inline
void Thyra::apply(
  const LinearOpBase<Scalar> &M,
  const EOpTransp M_trans,
  const MultiVectorBase<Scalar> &X,
  MultiVectorBase<Scalar> *Y,
  const Scalar alpha,
  const Scalar beta
  )
{
  apply(M, M_trans, X, Teuchos::ptr(Y), alpha, beta);
}


#endif  // THYRA_LINEAR_OP_DECL_HPP