Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Kokkos_CrsGraphBase.hpp
00001 //@HEADER
00002 // ************************************************************************
00003 //
00004 //          Kokkos: Node API and Parallel Node Kernels
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 KOKKOS_CRSGRAPHBASE_HPP
00043 #define KOKKOS_CRSGRAPHBASE_HPP
00044 
00045 #include "Kokkos_ConfigDefs.hpp"
00046 #include "Kokkos_DefaultNode.hpp"
00047 
00048 #include <Teuchos_TestForException.hpp>
00049 #include <Teuchos_OrdinalTraits.hpp>
00050 #include <numeric>
00051 
00052 namespace Kokkos {
00053 
00067   template <class Ordinal,
00068             class Node>
00069   class CrsGraphBase {
00070   public:
00071     typedef Ordinal  ordinal_type;
00072     typedef Node     node_type;
00073 
00075 
00076 
00078     CrsGraphBase(Ordinal numRows, Ordinal numCols, const RCP<Node> &node, const RCP<ParameterList> &params);
00079 
00081     virtual ~CrsGraphBase();
00082 
00084 
00086 
00087 
00088     RCP<Node> getNode() const;
00089 
00091     Ordinal getNumRows() const;
00092 
00094     Ordinal getNumCols() const;
00095 
00097 
00103     virtual void setStructure(const ArrayRCP<const size_t> &ptrs,
00104                               const ArrayRCP<const Ordinal> &inds) = 0;
00105 
00107 
00108   private:
00109     RCP<Node> node_;
00110     Ordinal numRows_, numCols_;
00111     RCP<ParameterList> params_;
00112   };
00113 
00114 
00115   //==============================================================================
00116   template <class Ordinal, class Node>
00117   CrsGraphBase<Ordinal,Node>::CrsGraphBase(Ordinal numRows, Ordinal numCols, const RCP<Node> &node, const RCP<ParameterList> &params) 
00118   : node_(node)
00119   , numRows_(numRows)
00120   , numCols_(numCols)
00121   , params_(params)
00122   {}
00123 
00124   //==============================================================================
00125   template <class Ordinal, class Node>
00126   CrsGraphBase<Ordinal,Node>::~CrsGraphBase() {
00127   }
00128 
00129   // ======= numrows ===========
00130   template <class Ordinal, class Node>
00131   Ordinal CrsGraphBase<Ordinal,Node>::getNumRows() const {
00132     return numRows_;
00133   }
00134 
00135   // ======= numcols ===========
00136   template <class Ordinal, class Node>
00137   Ordinal CrsGraphBase<Ordinal,Node>::getNumCols() const {
00138     return numCols_;
00139   }
00140 
00141   // ======= node ===========
00142   template <class Ordinal, class Node>
00143   RCP<Node> CrsGraphBase<Ordinal,Node>::getNode() const {
00144     return node_;
00145   }
00146 
00147 } // namespace Kokkos
00148 
00149 #endif /* KOKKOS_CRSGRAPHBASE_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends