Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
coo.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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 || GINKGO_ENABLE_BFLOAT16
53 public ConvertibleTo<Coo<next_precision<ValueType, 2>, IndexType>>,
54#endif
55#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
56 public ConvertibleTo<Coo<next_precision<ValueType, 3>, IndexType>>,
57#endif
58 public ConvertibleTo<Csr<ValueType, IndexType>>,
59 public ConvertibleTo<Dense<ValueType>>,
60 public DiagonalExtractable<ValueType>,
61 public ReadableFromMatrixData<ValueType, IndexType>,
62 public WritableToMatrixData<ValueType, IndexType>,
63 public Transposable,
65 remove_complex<Coo<ValueType, IndexType>>> {
66 friend class EnablePolymorphicObject<Coo, LinOp>;
67 friend class Csr<ValueType, IndexType>;
68 friend class Dense<ValueType>;
69 friend class CooBuilder<ValueType, IndexType>;
70 friend class Coo<to_complex<ValueType>, IndexType>;
71 friend class Hybrid<ValueType, IndexType>;
72
73public:
74 using EnableLinOp<Coo>::convert_to;
75 using EnableLinOp<Coo>::move_to;
76 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::convert_to;
77 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::move_to;
80 using ConvertibleTo<Dense<ValueType>>::convert_to;
81 using ConvertibleTo<Dense<ValueType>>::move_to;
82 using ReadableFromMatrixData<ValueType, IndexType>::read;
83
84 using value_type = ValueType;
85 using index_type = IndexType;
86 using transposed_type = Coo<ValueType, IndexType>;
87 using mat_data = matrix_data<ValueType, IndexType>;
88 using device_mat_data = device_matrix_data<ValueType, IndexType>;
89 using absolute_type = remove_complex<Coo>;
90
91 friend class Coo<previous_precision<ValueType>, IndexType>;
92
93 void convert_to(
94 Coo<next_precision<ValueType>, IndexType>* result) const override;
95
96 void move_to(Coo<next_precision<ValueType>, IndexType>* result) override;
97
98#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
99 friend class Coo<previous_precision<ValueType, 2>, IndexType>;
100 using ConvertibleTo<
101 Coo<next_precision<ValueType, 2>, IndexType>>::convert_to;
102 using ConvertibleTo<Coo<next_precision<ValueType, 2>, IndexType>>::move_to;
103
104 void convert_to(
105 Coo<next_precision<ValueType, 2>, IndexType>* result) const override;
106
107 void move_to(Coo<next_precision<ValueType, 2>, IndexType>* result) override;
108#endif
109
110#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
111 friend class Coo<previous_precision<ValueType, 3>, IndexType>;
112 using ConvertibleTo<
113 Coo<next_precision<ValueType, 3>, IndexType>>::convert_to;
114 using ConvertibleTo<Coo<next_precision<ValueType, 3>, IndexType>>::move_to;
115
116 void convert_to(
117 Coo<next_precision<ValueType, 3>, IndexType>* result) const override;
118
119 void move_to(Coo<next_precision<ValueType, 3>, IndexType>* result) override;
120#endif
121
122 void convert_to(Csr<ValueType, IndexType>* other) const override;
123
124 void move_to(Csr<ValueType, IndexType>* other) override;
125
126 void convert_to(Dense<ValueType>* other) const override;
127
128 void move_to(Dense<ValueType>* other) override;
129
130 void read(const mat_data& data) override;
131
132 void read(const device_mat_data& data) override;
133
134 void read(device_mat_data&& data) override;
135
136 void write(mat_data& data) const override;
137
138 std::unique_ptr<LinOp> transpose() const override;
139
140 std::unique_ptr<LinOp> conj_transpose() const override;
141
142 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
143
144 std::unique_ptr<absolute_type> compute_absolute() const override;
145
147
153 value_type* get_values() noexcept { return values_.get_data(); }
154
162 const value_type* get_const_values() const noexcept
163 {
164 return values_.get_const_data();
165 }
166
172 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
173
181 const index_type* get_const_col_idxs() const noexcept
182 {
183 return col_idxs_.get_const_data();
184 }
185
191 index_type* get_row_idxs() noexcept { return row_idxs_.get_data(); }
192
200 const index_type* get_const_row_idxs() const noexcept
201 {
202 return row_idxs_.get_const_data();
203 }
204
211 {
212 return values_.get_size();
213 }
214
226
231
243
248 ptr_param<LinOp> x) const;
249
259 static std::unique_ptr<Coo> create(std::shared_ptr<const Executor> exec,
260 const dim<2>& size = dim<2>{},
261 size_type num_nonzeros = {});
262
283 static std::unique_ptr<Coo> create(std::shared_ptr<const Executor> exec,
284 const dim<2>& size,
285 array<value_type> values,
286 array<index_type> col_idxs,
287 array<index_type> row_idxs);
288
293 template <typename InputValueType, typename InputColumnIndexType,
294 typename InputRowIndexType>
295 GKO_DEPRECATED(
296 "explicitly construct the gko::array argument instead of passing "
297 "initializer lists")
298 static std::unique_ptr<Coo> create(
299 std::shared_ptr<const Executor> exec, const dim<2>& size,
300 std::initializer_list<InputValueType> values,
301 std::initializer_list<InputColumnIndexType> col_idxs,
302 std::initializer_list<InputRowIndexType> row_idxs)
303 {
304 return create(exec, size, array<value_type>{exec, std::move(values)},
305 array<index_type>{exec, std::move(col_idxs)},
306 array<index_type>{exec, std::move(row_idxs)});
307 }
308
322 static std::unique_ptr<const Coo> create_const(
323 std::shared_ptr<const Executor> exec, const dim<2>& size,
324 gko::detail::const_array_view<ValueType>&& values,
325 gko::detail::const_array_view<IndexType>&& col_idxs,
326 gko::detail::const_array_view<IndexType>&& row_idxs);
327
328protected:
329 Coo(std::shared_ptr<const Executor> exec, const dim<2>& size = dim<2>{},
330 size_type num_nonzeros = {});
331
332 Coo(std::shared_ptr<const Executor> exec, const dim<2>& size,
333 array<value_type> values, array<index_type> col_idxs,
334 array<index_type> row_idxs);
335
343 void resize(dim<2> new_size, size_type nnz);
344
345 void apply_impl(const LinOp* b, LinOp* x) const override;
346
347 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
348 LinOp* x) const override;
349
350 void apply2_impl(const LinOp* b, LinOp* x) const;
351
352 void apply2_impl(const LinOp* alpha, const LinOp* b, LinOp* x) const;
353
354private:
355 array<value_type> values_;
356 array<index_type> col_idxs_;
357 array<index_type> row_idxs_;
358};
359
360
361} // namespace matrix
362} // namespace gko
363
364
365#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:479
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:668
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
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
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 array.hpp:166
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
Definition coo.hpp:29
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:172
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:181
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.
const LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x) const
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
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:162
const index_type * get_const_row_idxs() const noexcept
Definition coo.hpp:200
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.
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition coo.hpp:210
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:191
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:153
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:57
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
The matrix namespace.
Definition dense_cache.hpp:24
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:264
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:283
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
typename detail::find_precision_impl< T, -step >::type previous_precision
Obtains the previous move type of T in the singly-linked precision corresponding bfloat16/half.
Definition math.hpp:473
typename detail::find_precision_impl< T, step >::type next_precision
Obtains the next move type of T in the singly-linked precision corresponding bfloat16/half.
Definition math.hpp:466
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