Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_Details_getGraphDiagOffsets_decl.hpp
Go to the documentation of this file.
1/*
2// @HEADER
3// ***********************************************************************
4//
5// Tpetra: Templated Linear Algebra Services Package
6// Copyright (2008) Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39//
40// ************************************************************************
41// @HEADER
42*/
43
44#ifndef TPETRA_DETAILS_GETGRAPHDIAGOFFSETS_DECL_HPP
45#define TPETRA_DETAILS_GETGRAPHDIAGOFFSETS_DECL_HPP
46
51
52#include "TpetraCore_config.h"
53#include "Kokkos_Core.hpp"
54#include "Kokkos_StaticCrsGraph.hpp"
56#include <type_traits>
57
58namespace Tpetra {
59namespace Details {
60namespace Impl {
61
75template<class LO,
76 class GO,
77 class DeviceType,
78 class DiagOffsetType = size_t>
80public:
81 typedef typename DeviceType::device_type device_type;
83 typedef ::Kokkos::View<diag_offset_type*,
84 device_type,
85 ::Kokkos::MemoryUnmanaged> diag_offsets_type;
86 typedef ::Kokkos::StaticCrsGraph<LO,
87 ::Kokkos::LayoutLeft,
88 device_type,
89 void, size_t> local_graph_device_type;
90 typedef ::Tpetra::Details::LocalMap<LO, GO, device_type> local_map_type;
91 typedef ::Kokkos::View<const typename local_graph_device_type::size_type*,
92 ::Kokkos::LayoutLeft,
93 device_type,
94 ::Kokkos::MemoryUnmanaged> row_offsets_type;
95 // This is unmanaged for performance, because we need to take
96 // subviews inside the functor.
97 typedef ::Kokkos::View<const LO*,
98 ::Kokkos::LayoutLeft,
99 device_type,
100 ::Kokkos::MemoryUnmanaged> lcl_col_inds_type;
101
103 GetGraphDiagOffsets (const diag_offsets_type& diagOffsets,
106 const row_offsets_type& ptr,
107 const lcl_col_inds_type& ind,
108 const bool isSorted);
109
111 KOKKOS_FUNCTION void operator() (const LO& lclRowInd) const;
112
113private:
114 diag_offsets_type diagOffsets_;
115 local_map_type lclRowMap_;
116 local_map_type lclColMap_;
117 row_offsets_type ptr_;
118 lcl_col_inds_type ind_;
119 bool isSorted_;
120};
121
122} // namespace Impl
123
124template<class DiagOffsetsType,
125 class LclMapType,
126 class RowOffsetsType,
127 class LclColIndsType>
128void
129getGraphDiagOffsets (const DiagOffsetsType& diagOffsets,
130 const LclMapType& lclRowMap,
131 const LclMapType& lclColMap,
132 const RowOffsetsType& ptr,
133 const LclColIndsType& ind,
134 const bool isSorted)
135{
136 static_assert (Kokkos::is_view<DiagOffsetsType>::value,
137 "DiagOffsetsType (the type of diagOffsets) must be a Kokkos::View.");
138 static_assert (Kokkos::is_view<RowOffsetsType>::value,
139 "RowOffsetsType (the type of ptr) must be a Kokkos::View.");
140 static_assert (Kokkos::is_view<LclColIndsType>::value,
141 "LclColIndsType (the type of ind) must be a Kokkos::View.");
142 static_assert (static_cast<int> (DiagOffsetsType::rank) == 1,
143 "DiagOffsetsType (the type of diagOffsets) must be a rank-1 Kokkos::View.");
144 static_assert (static_cast<int> (RowOffsetsType::rank) == 1,
145 "RowOffsetsType (the type of ptr) must be a rank-1 Kokkos::View.");
146 static_assert (static_cast<int> (LclColIndsType::rank) == 1,
147 "LclColIndsType (the type of ind) must be a rank-1 Kokkos::View.");
148 typedef typename DiagOffsetsType::non_const_value_type diag_offset_type;
149 static_assert (std::is_same<typename DiagOffsetsType::value_type, diag_offset_type>::value,
150 "DiagOffsetsType (the type of diagOffsets) must be a nonconst "
151 "Kokkos::View, since it is the output argument of this function.");
152 static_assert (std::is_integral<diag_offset_type>::value,
153 "The type of each entry of diagOffsets must be an integer.");
154 typedef typename LclColIndsType::non_const_value_type local_ordinal_type;
155 static_assert (std::is_integral<local_ordinal_type>::value,
156 "The type of each entry of ind (the array of column indices) "
157 "must be an integer.");
158 static_assert (sizeof (diag_offset_type) >= sizeof (local_ordinal_type),
159 "Diagonal offset type must be big enough to count the number "
160 "of column indices, since the diagonal entry (if it exists) "
161 "may be anywhere in a row.");
162 typedef typename RowOffsetsType::non_const_value_type row_offset_type;
163 static_assert (std::is_integral<row_offset_type>::value,
164 "The type of each entry of ptr must be an integer.");
165
166 typedef typename LclMapType::local_ordinal_type LO;
167 typedef typename LclMapType::global_ordinal_type GO;
168 typedef typename LclMapType::device_type DT;
169
171 // The functor's constructor runs the functor.
172 impl_type impl (diagOffsets, lclRowMap, lclColMap, ptr, ind, isSorted);
173}
174
175} // namespace Details
176} // namespace Tpetra
177
178#endif // TPETRA_DETAILS_GETGRAPHDIAGOFFSETS_DECL_HPP
Declaration and definition of the Tpetra::Map class, an implementation detail of Tpetra::Map.
Struct that holds views of the contents of a CrsMatrix.
Implementation detail of Tpetra::Details::getGraphDiagOffsets, which in turn is an implementation det...
KOKKOS_FUNCTION void operator()(const LO &lclRowInd) const
Kokkos::parallel_for loop body.
GetGraphDiagOffsets(const diag_offsets_type &diagOffsets, const local_map_type &lclRowMap, const local_map_type &lclColMap, const row_offsets_type &ptr, const lcl_col_inds_type &ind, const bool isSorted)
Constructor; also runs the functor.
Implementation details of Tpetra.
Namespace Tpetra contains the class and methods constituting the Tpetra library.