Tpetra parallel linear algebra  Version of the Day
Tpetra_Details_localRowOffsets_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // ************************************************************************
38 // @HEADER
39 
40 #ifndef TPETRA_DETAILS_LOCALROWOFFSETS_DECL_HPP
41 #define TPETRA_DETAILS_LOCALROWOFFSETS_DECL_HPP
42 
46 
47 #include "Tpetra_CrsGraph_fwd.hpp"
48 #include "Tpetra_RowGraph_fwd.hpp"
49 #include "KokkosSparse_CrsMatrix.hpp"
50 #include <utility> // pair
51 
52 namespace Tpetra {
53 namespace Details {
54 
56 template <class NT>
58 private:
59  using local_graph_device_type =
60  typename KokkosSparse::CrsMatrix<
61  double, int, typename NT::device_type, void, size_t>::
62  staticcrsgraph_type;
63 public:
64  using offsets_type =
65  typename local_graph_device_type::row_map_type::non_const_type;
66  using offset_type = typename offsets_type::non_const_value_type;
67 
68  offsets_type ptr;
69  offset_type nnz;
70  size_t maxNumEnt;
71 };
72 
73 namespace Impl {
74 
75 template <class LO, class GO, class NT>
76 std::pair<typename LocalRowOffsetsResult<NT>::offsets_type, size_t>
77 localRowCounts (const RowGraph<LO, GO, NT>& G);
78 
79 template <class LO, class GO, class NT>
81 localRowOffsetsFromRowGraph (const RowGraph<LO, GO, NT>& G);
82 
83 template <class LO, class GO, class NT>
85 localRowOffsetsFromFillCompleteCrsGraph (const CrsGraph<LO, GO, NT>& G);
86 
87 } // namespace Impl
88 
91 template <class LO, class GO, class NT>
92 LocalRowOffsetsResult<NT>
94 
95 } // namespace Details
96 } // namespace Tpetra
97 
98 #endif // TPETRA_DETAILS_LOCALROWOFFSETS_DECL_HPP
Forward declaration of Tpetra::CrsGraph.
Forward declaration of Tpetra::RowGraph.
A distributed graph accessed by rows (adjacency lists) and stored sparsely.
An abstract interface for graphs accessed by rows.
Implementation details of Tpetra.
LocalRowOffsetsResult< NT > localRowOffsets(const RowGraph< LO, GO, NT > &G)
Get local row offsets ("ptr", in compressed sparse row terms) for the given graph.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Result returned by localRowOffsets (see below).
offsets_type ptr
Local row offsets (Kokkos::View)
offset_type nnz
Local number of graph / matrix entries.
size_t maxNumEnt
Max number of entries over all local rows.