1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
/*
* Copyright 2008-2009 NVIDIA Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*! \file coo_matrix.h
* \brief Coordinate matrix format
*/
#pragma once
#include <cusp/detail/config.h>
#include <cusp/format.h>
#include <cusp/array1d.h>
#include <cusp/detail/matrix_base.h>
namespace cusp
{
// forward definition
template <typename Array1, typename Array2, typename Array3, typename IndexType, typename ValueType, typename MemorySpace> class coo_matrix_view;
/*! \addtogroup sparse_matrices Sparse Matrices
*/
/*! \addtogroup sparse_matrix_containers Sparse Matrix Containers
* \ingroup sparse_matrices
* \{
*/
/*! \p coo_matrix : Coordinate matrix container
*
* \tparam IndexType Type used for matrix indices (e.g. \c int).
* \tparam ValueType Type used for matrix values (e.g. \c float).
* \tparam MemorySpace A memory space (e.g. \c cusp::host_memory or cusp::device_memory)
*
* \note The matrix entries must be sorted by row index.
* \note The matrix should not contain duplicate entries.
*
* The following code snippet demonstrates how to create a 4-by-3
* \p coo_matrix on the host with 6 nonzeros and then copies the
* matrix to the device.
*
* \code
* #include <cusp/coo_matrix.h>
* ...
*
* // allocate storage for (4,3) matrix with 6 nonzeros
* cusp::coo_matrix<int,float,cusp::host_memory> A(4,3,6);
*
* // initialize matrix entries on host
* A.row_indices[0] = 0; A.column_indices[0] = 0; A.values[0] = 10;
* A.row_indices[1] = 0; A.column_indices[1] = 2; A.values[1] = 20;
* A.row_indices[2] = 2; A.column_indices[2] = 2; A.values[2] = 30;
* A.row_indices[3] = 3; A.column_indices[3] = 0; A.values[3] = 40;
* A.row_indices[4] = 3; A.column_indices[4] = 1; A.values[4] = 50;
* A.row_indices[5] = 3; A.column_indices[5] = 2; A.values[5] = 60;
*
* // A now represents the following matrix
* // [10 0 20]
* // [ 0 0 0]
* // [ 0 0 30]
* // [40 50 60]
*
* // copy to the device
* cusp::coo_matrix<int,float,cusp::device_memory> B = A;
* \endcode
*
*/
template <typename IndexType, typename ValueType, class MemorySpace>
class coo_matrix : public detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::coo_format>
{
typedef cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::coo_format> Parent;
public:
/*! rebind matrix to a different MemorySpace
*/
template<typename MemorySpace2>
struct rebind { typedef cusp::coo_matrix<IndexType, ValueType, MemorySpace2> type; };
/*! type of \c row_indices array
*/
typedef typename cusp::array1d<IndexType, MemorySpace> row_indices_array_type;
/*! type of \c column_indices array
*/
typedef typename cusp::array1d<IndexType, MemorySpace> column_indices_array_type;
/*! type of \c values array
*/
typedef typename cusp::array1d<ValueType, MemorySpace> values_array_type;
/*! equivalent container type
*/
typedef typename cusp::coo_matrix<IndexType, ValueType, MemorySpace> container;
/*! equivalent view type
*/
typedef typename cusp::coo_matrix_view<typename row_indices_array_type::view,
typename column_indices_array_type::view,
typename values_array_type::view,
IndexType, ValueType, MemorySpace> view;
/*! equivalent const_view type
*/
typedef typename cusp::coo_matrix_view<typename row_indices_array_type::const_view,
typename column_indices_array_type::const_view,
typename values_array_type::const_view,
IndexType, ValueType, MemorySpace> const_view;
/*! Storage for the row indices of the COO data structure.
*/
row_indices_array_type row_indices;
/*! Storage for the column indices of the COO data structure.
*/
column_indices_array_type column_indices;
/*! Storage for the nonzero entries of the COO data structure.
*/
values_array_type values;
/*! Construct an empty \p coo_matrix.
*/
coo_matrix() {}
/*! Construct a \p coo_matrix with a specific shape and number of nonzero entries.
*
* \param num_rows Number of rows.
* \param num_cols Number of columns.
* \param num_entries Number of nonzero matrix entries.
*/
coo_matrix(size_t num_rows, size_t num_cols, size_t num_entries)
: Parent(num_rows, num_cols, num_entries),
row_indices(num_entries), column_indices(num_entries), values(num_entries) {}
/*! Construct a \p coo_matrix from another matrix.
*
* \param matrix Another sparse or dense matrix.
*/
template <typename MatrixType>
coo_matrix(const MatrixType& matrix);
/*! Resize matrix dimensions and underlying storage
*/
void resize(size_t num_rows, size_t num_cols, size_t num_entries)
{
Parent::resize(num_rows, num_cols, num_entries);
row_indices.resize(num_entries);
column_indices.resize(num_entries);
values.resize(num_entries);
}
/*! Swap the contents of two \p coo_matrix objects.
*
* \param matrix Another \p coo_matrix with the same IndexType and ValueType.
*/
void swap(coo_matrix& matrix)
{
Parent::swap(matrix);
row_indices.swap(matrix.row_indices);
column_indices.swap(matrix.column_indices);
values.swap(matrix.values);
}
/*! Assignment from another matrix.
*
* \param matrix Another sparse or dense matrix.
*/
template <typename MatrixType>
coo_matrix& operator=(const MatrixType& matrix);
/*! Sort matrix elements by row index
*/
void sort_by_row(void);
/*! Sort matrix elements by row and column index
*/
void sort_by_row_and_column(void);
/*! Determine whether matrix elements are sorted by row index
*
* \return \c false, if the row indices are unsorted; \c true, otherwise.
*/
bool is_sorted_by_row(void);
/*! Determine whether matrix elements are sorted by row and column index
*
* \return \c false, if the row and column indices are unsorted; \c true, otherwise.
*/
bool is_sorted_by_row_and_column(void);
}; // class coo_matrix
/*! \}
*/
/*! \addtogroup sparse_matrix_views Sparse Matrix Views
* \ingroup sparse_matrices
* \{
*/
/*! \p coo_matrix_view : Coordinate matrix view
*
* \tparam Array1 Type of \c row_indices array view
* \tparam Array2 Type of \c column_indices array view
* \tparam Array3 Type of \c values array view
* \tparam IndexType Type used for matrix indices (e.g. \c int).
* \tparam ValueType Type used for matrix values (e.g. \c float).
* \tparam MemorySpace A memory space (e.g. \c cusp::host_memory or cusp::device_memory)
*
*/
template <typename Array1,
typename Array2,
typename Array3,
typename IndexType = typename Array1::value_type,
typename ValueType = typename Array3::value_type,
typename MemorySpace = typename cusp::minimum_space<typename Array1::memory_space, typename Array2::memory_space, typename Array3::memory_space>::type >
class coo_matrix_view : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::coo_format>
{
typedef cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::coo_format> Parent;
public:
typedef Array1 row_indices_array_type;
typedef Array2 column_indices_array_type;
typedef Array3 values_array_type;
/*! equivalent container type
*/
typedef typename cusp::coo_matrix<IndexType, ValueType, MemorySpace> container;
/*! equivalent view type
*/
typedef typename cusp::coo_matrix_view<Array1, Array2, Array3, IndexType, ValueType, MemorySpace> view;
/*! View of the row indices of the COO data structure. Also called the "row pointer" array.
*/
row_indices_array_type row_indices;
/*! View of the column indices of the COO data structure.
*/
column_indices_array_type column_indices;
/*! View for the nonzero entries of the COO data structure.
*/
values_array_type values;
// construct empty view
coo_matrix_view(void)
: Parent() {}
// construct from existing COO matrix or view
template <typename Matrix>
coo_matrix_view(Matrix& A)
: Parent(A),
row_indices(A.row_indices),
column_indices(A.column_indices),
values(A.values) {}
// TODO check sizes here
coo_matrix_view(size_t num_rows,
size_t num_cols,
size_t num_entries,
Array1 row_indices,
Array2 column_indices,
Array3 values)
: Parent(num_rows, num_cols, num_entries),
row_indices(row_indices),
column_indices(column_indices),
values(values) {}
/*! Resize matrix dimensions and underlying storage
*/
void resize(size_t num_rows, size_t num_cols, size_t num_entries)
{
Parent::resize(num_rows, num_cols, num_entries);
row_indices.resize(num_entries);
column_indices.resize(num_entries);
values.resize(num_entries);
}
/*! Sort matrix elements by row index
*/
void sort_by_row(void);
/*! Sort matrix elements by row and column index
*/
void sort_by_row_and_column(void);
/*! Determine whether matrix elements are sorted by row index
*
* \return \c false, if the row indices are unsorted; \c true, otherwise.
*/
bool is_sorted_by_row(void);
/*! Determine whether matrix elements are sorted by row and column index
*
* \return \c false, if the row and column indices are unsorted; \c true, otherwise.
*/
bool is_sorted_by_row_and_column(void);
};
/* Convenience functions */
template <typename Array1,
typename Array2,
typename Array3>
coo_matrix_view<Array1,Array2,Array3>
make_coo_matrix_view(size_t num_rows,
size_t num_cols,
size_t num_entries,
Array1 row_indices,
Array2 column_indices,
Array3 values)
{
return coo_matrix_view<Array1,Array2,Array3>
(num_rows, num_cols, num_entries,
row_indices, column_indices, values);
}
template <typename Array1,
typename Array2,
typename Array3,
typename IndexType,
typename ValueType,
typename MemorySpace>
coo_matrix_view<Array1,Array2,Array3,IndexType,ValueType,MemorySpace>
make_coo_matrix_view(const coo_matrix_view<Array1,Array2,Array3,IndexType,ValueType,MemorySpace>& m)
{
return coo_matrix_view<Array1,Array2,Array3,IndexType,ValueType,MemorySpace>(m);
}
template <typename IndexType, typename ValueType, class MemorySpace>
typename coo_matrix<IndexType,ValueType,MemorySpace>::view
make_coo_matrix_view(coo_matrix<IndexType,ValueType,MemorySpace>& m)
{
return make_coo_matrix_view
(m.num_rows, m.num_cols, m.num_entries,
make_array1d_view(m.row_indices),
make_array1d_view(m.column_indices),
make_array1d_view(m.values));
}
template <typename IndexType, typename ValueType, class MemorySpace>
typename coo_matrix<IndexType,ValueType,MemorySpace>::const_view
make_coo_matrix_view(const coo_matrix<IndexType,ValueType,MemorySpace>& m)
{
return make_coo_matrix_view
(m.num_rows, m.num_cols, m.num_entries,
make_array1d_view(m.row_indices),
make_array1d_view(m.column_indices),
make_array1d_view(m.values));
}
/*! \}
*/
} // end namespace cusp
#include <cusp/detail/coo_matrix.inl>
|
