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_BLOCKVECTORSPACEBASEDECL_HPP 00043 #define PLAYA_BLOCKVECTORSPACEBASEDECL_HPP 00044 00045 #include "PlayaDefs.hpp" 00046 #include "PlayaVectorSpaceBaseDecl.hpp" 00047 00048 namespace Playa 00049 { 00050 00051 /** 00052 * This is a base class for a blocked vector space. It assumes nothing about 00053 * the physical storage of the blocks. 00054 * 00055 * @author Kevin Long (kevin.long@ttu.edu) 00056 */ 00057 template <class Scalar> 00058 class BlockVectorSpaceBase : public VectorSpaceBase<Scalar> 00059 { 00060 public: 00061 /** virtual dtor */ 00062 virtual ~BlockVectorSpaceBase() {;} 00063 00064 /** Compute dimension. The default implementation sums the dimensions 00065 * of all blocks. */ 00066 virtual int dim() const ; 00067 00068 /** Count the locally owned elements */ 00069 virtual int numLocalElements() const ; 00070 00071 /** Check compatibility with another space. The default implementation 00072 * loops over blocks checking compatiblilty at each index. */ 00073 virtual bool isCompatible(const VectorSpaceBase<Scalar>* other) const ; 00074 00075 /** Get a block specified by an integer index. This function 00076 * should hrow an exception if the index is out of range 00077 */ 00078 virtual const VectorSpace<Scalar>& getBlock(int b) const = 0 ; 00079 00080 /** Write a description by recursivle describing the blocks */ 00081 virtual std::string description() const ; 00082 00083 }; 00084 00085 00086 00087 00088 00089 00090 } 00091 00092 #endif