Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
coo.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_MATRIX_COO_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_COO_HPP_
7
8
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
11
12
13namespace gko {
19namespace matrix {
20
21
22template <typename ValueType, typename IndexType>
23class Csr;
24
25template <typename ValueType>
26class Dense;
27
28template <typename ValueType, typename IndexType>
30
31template <typename ValueType, typename IndexType>
32class Hybrid;
33
34
49template <typename ValueType = default_precision, typename IndexType = int32>
50class Coo : public EnableLinOp<Coo<ValueType, IndexType>>,
51 public ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>,
52#if GINKGO_ENABLE_HALF
53 public ConvertibleTo<
54 Coo<next_precision<next_precision<ValueType>>, IndexType>>,
55#endif
56 public ConvertibleTo<Csr<ValueType, IndexType>>,
57 public ConvertibleTo<Dense<ValueType>>,
58 public DiagonalExtractable<ValueType>,
59 public ReadableFromMatrixData<ValueType, IndexType>,
60 public WritableToMatrixData<ValueType, IndexType>,
62 remove_complex<Coo<ValueType, IndexType>>> {
63 friend class EnablePolymorphicObject<Coo, LinOp>;
64 friend class Csr<ValueType, IndexType>;
65 friend class Dense<ValueType>;
66 friend class CooBuilder<ValueType, IndexType>;
67 friend class Coo<to_complex<ValueType>, IndexType>;
68 friend class Hybrid<ValueType, IndexType>;
69
70public:
71 using EnableLinOp<Coo>::convert_to;
72 using EnableLinOp<Coo>::move_to;
73 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::convert_to;
74 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::move_to;
77 using ConvertibleTo<Dense<ValueType>>::convert_to;
78 using ConvertibleTo<Dense<ValueType>>::move_to;
79 using ReadableFromMatrixData<ValueType, IndexType>::read;
80
81 using value_type = ValueType;
82 using index_type = IndexType;
83 using mat_data = matrix_data<ValueType, IndexType>;
84 using device_mat_data = device_matrix_data<ValueType, IndexType>;
85 using absolute_type = remove_complex<Coo>;
86
87 friend class Coo<previous_precision<ValueType>, IndexType>;
88
89 void convert_to(
90 Coo<next_precision<ValueType>, IndexType>* result) const override;
91
92 void move_to(Coo<next_precision<ValueType>, IndexType>* result) override;
93
94#if GINKGO_ENABLE_HALF
95 friend class Coo<previous_precision<previous_precision<ValueType>>,
96 IndexType>;
97 using ConvertibleTo<
98 Coo<next_precision<next_precision<ValueType>>, IndexType>>::convert_to;
99 using ConvertibleTo<
101
102 void convert_to(Coo<next_precision<next_precision<ValueType>>, IndexType>*
103 result) const override;
104
105 void move_to(Coo<next_precision<next_precision<ValueType>>, IndexType>*
106 result) override;
107#endif
108
109 void convert_to(Csr<ValueType, IndexType>* other) const override;
110
111 void move_to(Csr<ValueType, IndexType>* other) override;
112
113 void convert_to(Dense<ValueType>* other) const override;
114
115 void move_to(Dense<ValueType>* other) override;
116
117 void read(const mat_data& data) override;
118
119 void read(const device_mat_data& data) override;
120
121 void read(device_mat_data&& data) override;
122
123 void write(mat_data& data) const override;
124
125 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
126
127 std::unique_ptr<absolute_type> compute_absolute() const override;
128
130
136 value_type* get_values() noexcept { return values_.get_data(); }
137
145 const value_type* get_const_values() const noexcept
146 {
147 return values_.get_const_data();
148 }
149
155 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
156
164 const index_type* get_const_col_idxs() const noexcept
165 {
166 return col_idxs_.get_const_data();
167 }
168
174 index_type* get_row_idxs() noexcept { return row_idxs_.get_data(); }
175
183 const index_type* get_const_row_idxs() const noexcept
184 {
185 return row_idxs_.get_const_data();
186 }
187
194 {
195 return values_.get_size();
196 }
197
209
214
226
231 ptr_param<LinOp> x) const;
232
242 static std::unique_ptr<Coo> create(std::shared_ptr<const Executor> exec,
243 const dim<2>& size = dim<2>{},
244 size_type num_nonzeros = {});
245
266 static std::unique_ptr<Coo> create(std::shared_ptr<const Executor> exec,
267 const dim<2>& size,
268 array<value_type> values,
269 array<index_type> col_idxs,
270 array<index_type> row_idxs);
271
276 template <typename InputValueType, typename InputColumnIndexType,
277 typename InputRowIndexType>
278 GKO_DEPRECATED(
279 "explicitly construct the gko::array argument instead of passing "
280 "initializer lists")
281 static std::unique_ptr<Coo> create(
282 std::shared_ptr<const Executor> exec, const dim<2>& size,
283 std::initializer_list<InputValueType> values,
284 std::initializer_list<InputColumnIndexType> col_idxs,
285 std::initializer_list<InputRowIndexType> row_idxs)
286 {
287 return create(exec, size, array<value_type>{exec, std::move(values)},
288 array<index_type>{exec, std::move(col_idxs)},
289 array<index_type>{exec, std::move(row_idxs)});
290 }
291
305 static std::unique_ptr<const Coo> create_const(
306 std::shared_ptr<const Executor> exec, const dim<2>& size,
307 gko::detail::const_array_view<ValueType>&& values,
308 gko::detail::const_array_view<IndexType>&& col_idxs,
309 gko::detail::const_array_view<IndexType>&& row_idxs);
310
311protected:
312 Coo(std::shared_ptr<const Executor> exec, const dim<2>& size = dim<2>{},
313 size_type num_nonzeros = {});
314
315 Coo(std::shared_ptr<const Executor> exec, const dim<2>& size,
316 array<value_type> values, array<index_type> col_idxs,
317 array<index_type> row_idxs);
318
326 void resize(dim<2> new_size, size_type nnz);
327
328 void apply_impl(const LinOp* b, LinOp* x) const override;
329
330 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
331 LinOp* x) const override;
332
333 void apply2_impl(const LinOp* b, LinOp* x) const;
334
335 void apply2_impl(const LinOp* alpha, const LinOp* b, LinOp* x) const;
336
337private:
338 array<value_type> values_;
339 array<index_type> col_idxs_;
340 array<index_type> row_idxs_;
341};
342
343
344} // namespace matrix
345} // namespace gko
346
347
348#endif // GKO_PUBLIC_CORE_MATRIX_COO_HPP_
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:470
The diagonal of a LinOp implementing this interface can be extracted.
Definition lin_op.hpp:743
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:794
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
Definition lin_op.hpp:117
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:605
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:660
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition logger.hpp:25
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition array.hpp:673
const value_type * get_const_data() const noexcept
Returns a constant pointer to the block of memory used to store the elements of the array.
Definition array.hpp:682
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition array.hpp:656
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
Definition coo.hpp:29
COO stores a matrix in the coordinate matrix format.
Definition ell.hpp:21
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:155
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:164
void read(const device_mat_data &data) override
Reads a matrix from a device_matrix_data structure.
static std::unique_ptr< const Coo > create_const(std::shared_ptr< const Executor > exec, const dim< 2 > &size, gko::detail::const_array_view< ValueType > &&values, gko::detail::const_array_view< IndexType > &&col_idxs, gko::detail::const_array_view< IndexType > &&row_idxs)
Creates a constant (immutable) Coo matrix from a set of constant arrays.
void read(device_mat_data &&data) override
Reads a matrix from a device_matrix_data structure.
const LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x) const
LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x)
Applies Coo matrix axpy to a vector (or a sequence of vectors).
LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x)
Performs the operation x = alpha * Coo * b + x.
void compute_absolute_inplace() override
Compute absolute inplace on each element.
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition coo.hpp:145
void read(const mat_data &data) override
Reads a matrix from a matrix_data structure.
const index_type * get_const_row_idxs() const noexcept
Definition coo.hpp:183
const LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x) const
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
static std::unique_ptr< Coo > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size=dim< 2 >{}, size_type num_nonzeros={})
Creates an uninitialized COO matrix of the specified size.
void write(mat_data &data) const override
Writes a matrix to a matrix_data structure.
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition coo.hpp:193
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
index_type * get_row_idxs() noexcept
Returns the row indexes of the matrix.
Definition coo.hpp:174
static std::unique_ptr< Coo > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, array< value_type > values, array< index_type > col_idxs, array< index_type > row_idxs)
Creates a COO matrix from already allocated (and initialized) row index, column index and value array...
value_type * get_values() noexcept
Returns the values of the matrix.
Definition coo.hpp:136
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition sparsity_csr.hpp:21
Dense is a matrix format which explicitly stores all values of the matrix.
Definition sparsity_csr.hpp:25
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:55
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
The Ginkgo namespace.
Definition abstract_factory.hpp:20
typename detail::remove_complex_s< T >::type remove_complex
Obtain the type which removed the complex of complex/scalar type or the template parameter of class b...
Definition math.hpp:260
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list with half.
Definition math.hpp:438
typename detail::to_complex_s< T >::type to_complex
Obtain the type which adds the complex of complex/scalar type or the template parameter of class by a...
Definition math.hpp:279
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
STL namespace.
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:26
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126