00001 /* @HEADER@ */ 00002 /* *********************************************************************** 00003 // 00004 // TSFExtended: Trilinos Solver Framework Extended 00005 // Copyright (2004) Sandia Corporation 00006 // 00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive 00008 // license for use of this work by or on behalf of the U.S. Government. 00009 // 00010 // This library is free software; you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as 00012 // published by the Free Software Foundation; either version 2.1 of the 00013 // License, or (at your option) any later version. 00014 // 00015 // This library is distributed in the hope that it will be useful, but 00016 // WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00018 // Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public 00021 // License along with this library; if not, write to the Free Software 00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 00023 // USA 00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 00025 // 00026 // **********************************************************************/ 00027 /* @HEADER@ */ 00028 00029 #ifndef TSFINDEXABLEVECTOR_HPP 00030 #define TSFINDEXABLEVECTOR_HPP 00031 00032 #include "SundanceDefs.hpp" 00033 00034 #include "TSFLoadableVector.hpp" 00035 #include "TSFAccessibleVector.hpp" 00036 00037 00038 00039 namespace TSFExtended 00040 { 00041 00042 00043 /** 00044 * TSFExtended::IndexableVector defines an interface through which 00045 * elements for a vector can be accessed for both reading and writing 00046 * through indexing operators. 00047 * 00048 * Default implementations of the loadable and accessible interface 00049 * methods are provided. 00050 * 00051 * @author Kevin Long (krlong@sandia.gov) 00052 */ 00053 template <class Scalar> 00054 class IndexableVector : public virtual LoadableVector<Scalar>, 00055 public virtual AccessibleVector<Scalar> 00056 { 00057 public: 00058 /** virtual dtor */ 00059 virtual ~IndexableVector() {;} 00060 00061 /** read the element at the given global index */ 00062 virtual const Scalar& operator[](OrdType globalIndex) const = 0 ; 00063 00064 /** writable access to the element at the given global index */ 00065 virtual Scalar& operator[](OrdType globalIndex) = 0 ; 00066 00067 /** set a single element at the given global index */ 00068 virtual void setElement(OrdType globalIndex, const Scalar& value) 00069 {operator[](globalIndex) = value;} 00070 00071 /** add to the existing value of 00072 * a single element at the given global index */ 00073 virtual void addToElement(OrdType globalIndex, const Scalar& value) 00074 {operator[](globalIndex) += value;} 00075 00076 /** get the element at the given global index */ 00077 virtual const Scalar& getElement(OrdType globalIndex) const 00078 {return operator[](globalIndex);} 00079 }; 00080 } 00081 00082 00083 #endif