Tpetra Matrix/Vector Services Version of the Day
Tpetra_Vector_decl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) 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 Michael A. Heroux (maherou@sandia.gov) 
00038 // 
00039 // ************************************************************************
00040 // @HEADER
00041 
00042 #ifndef TPETRA_VECTOR_DECL_HPP
00043 #define TPETRA_VECTOR_DECL_HPP
00044 
00045 #include "Tpetra_ConfigDefs.hpp"
00046 #include "Tpetra_MultiVector_decl.hpp"
00047 
00048 namespace Tpetra {
00049 
00051 
00056   template<class Scalar, class LocalOrdinal=int, class GlobalOrdinal=LocalOrdinal, class Node=Kokkos::DefaultNode::DefaultNodeType>
00057   class Vector : public MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
00058 
00059     // need this so that MultiVector::operator() can call Vector's private view constructor
00060     friend class MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>;
00061 
00062   public:
00063 
00065 
00066 
00068     explicit Vector(const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map, bool zeroOut=true);
00069 
00071     Vector(const Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &source);
00072 
00074     Vector(const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map, const ArrayView<const Scalar> &A);
00075 
00077     virtual ~Vector();
00078 
00080 
00082 
00083 
00085 
00087     void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value);
00088 
00090 
00092     void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value);
00093 
00095 
00097     void replaceLocalValue(LocalOrdinal myRow, const Scalar &value);
00098 
00100 
00102     void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value);
00103 
00105 
00107 
00108 
00109     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::get1dCopy; // overloading, not hiding
00111     void get1dCopy(ArrayView<Scalar> A) const;
00112 
00114 
00116 
00117 
00118     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::dot; // overloading, not hiding
00120     Scalar dot(const Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &a) const;
00121 
00122     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::norm1; // overloading, not hiding
00124     typename Teuchos::ScalarTraits<Scalar>::magnitudeType norm1() const;
00125 
00126     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::norm2; // overloading, not hiding
00128     typename Teuchos::ScalarTraits<Scalar>::magnitudeType norm2() const;
00129 
00130     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::normInf; // overloading, not hiding
00132     typename Teuchos::ScalarTraits<Scalar>::magnitudeType normInf() const;
00133 
00134     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::normWeighted; // overloading, not hiding
00136     typename Teuchos::ScalarTraits<Scalar>::magnitudeType normWeighted(const Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &weights) const;
00137 
00138     using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::meanValue; // overloading, not hiding
00140     Scalar meanValue() const;
00141 
00143 
00145 
00146 
00148     std::string description() const;
00149 
00151     void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;
00152 
00154 
00155     protected:
00156 
00157     template <class S,class LO,class GO,class N>
00158     friend RCP< Vector<S,LO,GO,N> > 
00159     createVectorFromView(const RCP<const Map<LO,GO,N> > &,const ArrayRCP<S> &);
00160 
00161     // view constructor, sitting on user allocated data, only for CPU nodes
00162     // and his non-member constructor friend
00163     Vector(const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map, const ArrayRCP<Scalar> &view, EPrivateHostViewConstructor /* dummy */);
00164 
00166     Vector(const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map, const ArrayRCP<Scalar> & data);
00167 
00169     Vector(const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map, const ArrayRCP<Scalar> & data, EPrivateComputeViewConstructor /* dummy */);
00170 
00171     typedef Kokkos::MultiVector<Scalar,Node> KMV;
00172     typedef Kokkos::DefaultArithmetic<KMV>   MVT;
00173 
00174   }; // class Vector
00175 
00180   template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00181   RCP< Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00182   createVector(const RCP< const Map<LocalOrdinal,GlobalOrdinal,Node> > &map) 
00183   {
00184     const bool DO_INIT_TO_ZERO = true;
00185     return rcp( new Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(map,DO_INIT_TO_ZERO) );
00186   }
00187 
00189 
00192   template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00193   RCP< Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > 
00194   createVectorFromView(const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > &map, 
00195                        const ArrayRCP<Scalar> &view) 
00196   {
00197     return rcp(
00198       // this is a protected constructor, but we are friends 
00199       new Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(
00200         map,
00201         // this will fail to compile for unsupported node types
00202         Tpetra::details::ViewAccepter<Node>::template acceptView<Scalar>(view),
00203         HOST_VIEW_CONSTRUCTOR)
00204     );
00205   }
00206 
00207 } // namespace Tpetra
00208 
00209 #endif // TPETRA_VECTOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines