PlayaSimpleScaledOpDecl.hpp
Go to the documentation of this file.
00001 /* @HEADER@ */
00002 // ************************************************************************
00003 // 
00004 //                 Playa: Programmable Linear Algebra
00005 //                 Copyright 2012 Sandia Corporation
00006 // 
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Kevin Long (kevin.long@ttu.edu)
00038 // 
00039 
00040 /* @HEADER@ */
00041 
00042 #ifndef PLAYA_SIMPLE_SCALED_OP_DECL_HPP
00043 #define PLAYA_SIMPLE_SCALED_OP_DECL_HPP
00044 
00045 
00046 
00047 #include "PlayaDefs.hpp"
00048 #include "PlayaLinearOpWithSpacesDecl.hpp"
00049 #include "PlayaLinearOperatorDecl.hpp"
00050 
00051 
00052 namespace Playa
00053 {
00054 using namespace Teuchos;
00055 
00056 
00057 
00058 
00059 /**
00060  * Represent a scaled operator
00061  */
00062 template <class Scalar>
00063 class SimpleScaledOp : public LinearOpWithSpaces<Scalar>,
00064                        public Printable
00065 {
00066 public:
00067   /** */
00068   SimpleScaledOp(const Scalar& alpha, const LinearOperator<Scalar>& A);
00069   
00070   /** */
00071   void apply(Teuchos::ETransp transApplyType,
00072     const Vector<Scalar>& in,
00073     Vector<Scalar> out) const;
00074 
00075   
00076   /** */
00077   std::string description() const ;
00078 
00079   /** */
00080   const Scalar& alpha() const {return alpha_;}
00081 
00082   /** */
00083   LinearOperator<Scalar> op() const {return A_;}
00084 
00085   /** */
00086   void print(std::ostream& os) const ;
00087 
00088 private:
00089   Scalar alpha_;
00090   LinearOperator<Scalar> A_;
00091 };
00092 
00093 
00094 /** \relates SimpleScaledOp */
00095 template <class Scalar>
00096 LinearOperator<Scalar> scaledOperator(
00097   const Scalar& scale,
00098   const LinearOperator<Scalar>& op);
00099 
00100 
00101 template <class Scalar> 
00102 LinearOperator<Scalar> operator*(const Scalar& a, const LinearOperator<Scalar>& A);
00103 
00104 }
00105 
00106 #endif

Site Contact