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_MULTI_VECTOR_OPERATOR_DECL_HPP 00043 #define Playa_MULTI_VECTOR_OPERATOR_DECL_HPP 00044 00045 #include "PlayaDefs.hpp" 00046 #include "PlayaRowAccessibleOp.hpp" 00047 #include "PlayaLinearOpWithSpacesDecl.hpp" 00048 #include "PlayaLinearOperatorDecl.hpp" 00049 #include "PlayaHandleable.hpp" 00050 #include "Teuchos_RefCountPtr.hpp" 00051 #include "PlayaVectorDecl.hpp" 00052 00053 namespace Playa 00054 { 00055 /** 00056 * A MultiVectorOperator is a linear operator whose 00057 * rows or columns are represented as a multivector 00058 */ 00059 template <class Scalar> 00060 class MultiVectorOperator 00061 : public LinearOpWithSpaces<Scalar>, 00062 public RowAccessibleOp<Scalar> 00063 { 00064 public: 00065 00066 /** 00067 * Construct from an array of vectors and a specifier for the 00068 * domain space. 00069 */ 00070 MultiVectorOperator(const Teuchos::Array<Vector<Scalar> >& cols, 00071 const VectorSpace<Scalar>& domain); 00072 00073 /** Virtual dtor */ 00074 virtual ~MultiVectorOperator(){;} 00075 00076 00077 /** 00078 * Apply does an element-by-element multiply between the input 00079 * vector, x, and the diagonal values. 00080 */ 00081 virtual void apply( 00082 Teuchos::ETransp transType, 00083 const Vector<Scalar>& in, 00084 Vector<Scalar> out) const ; 00085 00086 00087 /** Return the kth row */ 00088 void getRow(const int& k, 00089 Teuchos::Array<int>& indices, 00090 Teuchos::Array<Scalar>& values) const ; 00091 00092 private: 00093 00094 Teuchos::Array<Vector<Scalar> > cols_; 00095 }; 00096 00097 /** \relates MultiVectorOperator */ 00098 template <class Scalar> 00099 LinearOperator<Scalar> multiVectorOperator( 00100 const Teuchos::Array<Vector<Scalar> >& cols, 00101 const VectorSpace<Scalar>& domain); 00102 00103 00104 } 00105 00106 #endif