Zoltan2
Zoltan2_BasicIdentifierAdapter.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Zoltan2: A package of combinatorial algorithms for scientific computing
6 // Copyright 2012 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 Karen Devine (kddevin@sandia.gov)
39 // Erik Boman (egboman@sandia.gov)
40 // Siva Rajamanickam (srajama@sandia.gov)
41 //
42 // ***********************************************************************
43 //
44 // @HEADER
45 
50 #ifndef _ZOLTAN2_BASICIDENTIFIERADAPTER_HPP_
51 #define _ZOLTAN2_BASICIDENTIFIERADAPTER_HPP_
52 
54 #include <Zoltan2_StridedData.hpp>
55 
56 namespace Zoltan2 {
57 
82 template <typename User>
84 
85 public:
86 
88  typedef typename InputTraits<User>::lno_t lno_t;
89  typedef typename InputTraits<User>::gno_t gno_t;
93  typedef User user_t;
94 
110  BasicIdentifierAdapter( lno_t numIds, const gno_t *idPtr,
111  std::vector<const scalar_t *> &weights, std::vector<int> &weightStrides);
112 
114  // The Adapter interface.
116 
117  size_t getLocalNumIDs() const { return numIds_;}
118 
119  void getIDsView(const gno_t *&Ids) const { Ids = idList_; }
120 
121  int getNumWeightsPerID() const { return weights_.size(); }
122 
123  void getWeightsView(const scalar_t *&weights, int &stride, int idx) const
124  {
125  if (idx < 0 || idx >= weights_.size()) {
126  std::ostringstream emsg;
127  emsg << __FILE__ << ":" << __LINE__
128  << " Invalid weight index " << idx << std::endl;
129  throw std::runtime_error(emsg.str());
130  }
131  size_t length;
132  weights_[idx].getStridedList(length, weights, stride);
133  }
134 
135 private:
136 
137  lno_t numIds_;
138  const gno_t *idList_;
139  ArrayRCP<StridedData<lno_t, scalar_t> > weights_;
140 };
141 
143 // Definitions
145 
146 template <typename User>
148  lno_t numIds, const gno_t *idPtr,
149  std::vector<const scalar_t *> &weights, std::vector<int> &weightStrides):
150  numIds_(numIds), idList_(idPtr), weights_()
151 {
152  typedef StridedData<lno_t,scalar_t> input_t;
153  size_t numWeights = weights.size();
154 
155  if (numWeights > 0){
156  weights_ = arcp(new input_t [numWeights], 0, numWeights, true);
157 
158  if (numIds > 0){
159  for (size_t i=0; i < numWeights; i++){
160  int stride = weightStrides.size() ? weightStrides[i] : 1;
161  ArrayRCP<const scalar_t> wgtV(weights[i], 0, stride*numIds, false);
162  weights_[i] = input_t(wgtV, stride);
163  }
164  }
165  }
166 }
167 
168 
169 
170 } //namespace Zoltan2
171 
172 #endif
BasicIdentifierAdapter(lno_t numIds, const gno_t *idPtr, std::vector< const scalar_t * > &weights, std::vector< int > &weightStrides)
Constructor.
IdentifierAdapter defines the interface for identifiers.
void getIDsView(const gno_t *&Ids) const
Provide a pointer to this process&#39; identifiers.
lno_t size() const
Return the length of the strided array.
default_part_t part_t
The data type to represent part numbers.
Defines the IdentifierAdapter interface.
static ArrayRCP< ArrayRCP< zscalar_t > > weights
This class represents a collection of global Identifiers and their associated weights, if any.
default_lno_t lno_t
The ordinal type (e.g., int, long, int64_t) that represents local counts and local indices...
The StridedData class manages lists of weights or coordinates.
default_gno_t gno_t
The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers.
default_node_t node_t
The Kokkos node type. This is only meaningful for users of Tpetra objects.
int getNumWeightsPerID() const
Returns the number of weights per object. Number of weights per object should be zero or greater...
void getWeightsView(const scalar_t *&weights, int &stride, int idx) const
Provide pointer to a weight array with stride.
size_t getLocalNumIDs() const
Returns the number of objects on this process.
default_scalar_t scalar_t
The data type for weights and coordinates.
This file defines the StridedData class.