Ginkgo: ginkgo/core/matrix/coo.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.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>
29 class CooBuilder;
30
31template <typename ValueType, typename IndexType>
32class Hybrid;
33
34
49template <typename ValueType = default_precision, typename IndexType = int32>
50 class 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,
64 public EnableAbsoluteComputation<
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 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
73
74public:
75 using EnableLinOp<Coo>::convert_to;
76 using EnableLinOp<Coo>::move_to;
77 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::convert_to;
78 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::move_to;
79 using ConvertibleTo<Csr<ValueType, IndexType>>::convert_to;
80 using ConvertibleTo<Csr<ValueType, IndexType>>::move_to;
81 using ConvertibleTo<Dense<ValueType>>::convert_to;
82 using ConvertibleTo<Dense<ValueType>>::move_to;
83 using ReadableFromMatrixData<ValueType, IndexType>::read;
84
85 using value_type = ValueType;
86 using index_type = IndexType;
87 using transposed_type = Coo<ValueType, IndexType>;
88 using mat_data = matrix_data<ValueType, IndexType>;
89 using device_mat_data = device_matrix_data<ValueType, IndexType>;
90 using absolute_type = remove_complex<Coo>;
91
92 friend class Coo<previous_precision<ValueType>, IndexType>;
93
94 void convert_to(
95 Coo<next_precision<ValueType>, IndexType>* result) const override;
96
97 void move_to(Coo<next_precision<ValueType>, IndexType>* result) override;
98
99#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
100 friend class Coo<previous_precision<ValueType, 2>, IndexType>;
101 using ConvertibleTo<
102 Coo<next_precision<ValueType, 2>, IndexType>>::convert_to;
103 using ConvertibleTo<Coo<next_precision<ValueType, 2>, IndexType>>::move_to;
104
105 void convert_to(
106 Coo<next_precision<ValueType, 2>, IndexType>* result) const override;
107
108 void move_to(Coo<next_precision<ValueType, 2>, IndexType>* result) override;
109#endif
110
111#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
112 friend class Coo<previous_precision<ValueType, 3>, IndexType>;
113 using ConvertibleTo<
114 Coo<next_precision<ValueType, 3>, IndexType>>::convert_to;
115 using ConvertibleTo<Coo<next_precision<ValueType, 3>, IndexType>>::move_to;
116
117 void convert_to(
118 Coo<next_precision<ValueType, 3>, IndexType>* result) const override;
119
120 void move_to(Coo<next_precision<ValueType, 3>, IndexType>* result) override;
121#endif
122
123 void convert_to(Csr<ValueType, IndexType>* other) const override;
124
125 void move_to(Csr<ValueType, IndexType>* other) override;
126
127 void convert_to(Dense<ValueType>* other) const override;
128
129 void move_to(Dense<ValueType>* other) override;
130
131 void read(const mat_data& data) override;
132
133 void read(const device_mat_data& data) override;
134
135 void read(device_mat_data&& data) override;
136
137 void write(mat_data& data) const override;
138
139 std::unique_ptr<LinOp> transpose() const override;
140
141 std::unique_ptr<LinOp> conj_transpose() const override;
142
143 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
144
145 std::unique_ptr<absolute_type> compute_absolute() const override;
146
147 void compute_absolute_inplace() override;
148
154 value_type* get_values() noexcept { return values_.get_data(); }
155
163 const value_type* get_const_values() const noexcept
164 {
165 return values_.get_const_data();
166 }
167
173 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
174
182 const index_type* get_const_col_idxs() const noexcept
183 {
184 return col_idxs_.get_const_data();
185 }
186
192 index_type* get_row_idxs() noexcept { return row_idxs_.get_data(); }
193
201 const index_type* get_const_row_idxs() const noexcept
202 {
203 return row_idxs_.get_const_data();
204 }
205
211 size_type get_num_stored_elements() const noexcept
212 {
213 return values_.get_size();
214 }
215
226 LinOp* apply2(ptr_param<const LinOp> b, ptr_param<LinOp> x);
227
231 const LinOp* apply2(ptr_param<const LinOp> b, ptr_param<LinOp> x) const;
232
242 LinOp* apply2(ptr_param<const LinOp> alpha, ptr_param<const LinOp> b,
243 ptr_param<LinOp> x);
244
248 const LinOp* apply2(ptr_param<const LinOp> alpha, ptr_param<const LinOp> b,
249 ptr_param<LinOp> x) const;
250
260 static std::unique_ptr<Coo> create(std::shared_ptr<const Executor> exec,
261 const dim<2>& size = dim<2>{},
262 size_type num_nonzeros = {});
263
284 static std::unique_ptr<Coo> create(std::shared_ptr<const Executor> exec,
285 const dim<2>& size,
286 array<value_type> values,
287 array<index_type> col_idxs,
288 array<index_type> row_idxs);
289
294 template <typename InputValueType, typename InputColumnIndexType,
295 typename InputRowIndexType>
296 GKO_DEPRECATED(
297 "explicitly construct the gko::array argument instead of passing "
298 "initializer lists")
299 static std::unique_ptr<Coo> create(
300 std::shared_ptr<const Executor> exec, const dim<2>& size,
301 std::initializer_list<InputValueType> values,
302 std::initializer_list<InputColumnIndexType> col_idxs,
303 std::initializer_list<InputRowIndexType> row_idxs)
304 {
305 return create(exec, size, array<value_type>{exec, std::move(values)},
306 array<index_type>{exec, std::move(col_idxs)},
307 array<index_type>{exec, std::move(row_idxs)});
308 }
309
323 static std::unique_ptr<const Coo> create_const(
324 std::shared_ptr<const Executor> exec, const dim<2>& size,
325 gko::detail::const_array_view<ValueType>&& values,
326 gko::detail::const_array_view<IndexType>&& col_idxs,
327 gko::detail::const_array_view<IndexType>&& row_idxs);
328
329protected:
330 Coo(std::shared_ptr<const Executor> exec, const dim<2>& size = dim<2>{},
331 size_type num_nonzeros = {});
332
333 Coo(std::shared_ptr<const Executor> exec, const dim<2>& size,
334 array<value_type> values, array<index_type> col_idxs,
335 array<index_type> row_idxs);
336
344 void resize(dim<2> new_size, size_type nnz);
345
346 void apply_impl(const LinOp* b, LinOp* x) const override;
347
348 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
349 LinOp* x) const override;
350
351 void apply2_impl(const LinOp* b, LinOp* x) const;
352
353 void apply2_impl(const LinOp* alpha, const LinOp* b, LinOp* x) const;
354
355private:
356 array<value_type> values_;
357 array<index_type> col_idxs_;
358 array<index_type> row_idxs_;
359};
360
361
362} // namespace matrix
363} // namespace gko
364
365
366#endif // GKO_PUBLIC_CORE_MATRIX_COO_HPP_
gko::DiagonalExtractable
The diagonal of a LinOp implementing this interface can be extracted.
Definition lin_op.hpp:743
gko::EnableAbsoluteComputation
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:794
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::Executor
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
gko::LinOp
Definition lin_op.hpp:117
gko::ReadableFromMatrixData
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:605
gko::Transposable
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
gko::WritableToMatrixData
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:660
gko::array
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
gko::device_matrix_data
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
gko::matrix::CooBuilder
Definition coo.hpp:29
gko::matrix::Coo::get_col_idxs
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:173
gko::matrix::Coo::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::matrix::Coo::get_const_col_idxs
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:182
gko::matrix::Coo::create_const
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.
gko::matrix::Coo::apply2
const LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x) const
gko::matrix::Coo::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::matrix::Coo::apply2
LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x)
Applies Coo matrix axpy to a vector (or a sequence of vectors).
gko::matrix::Coo::apply2
LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x)
Performs the operation x = alpha * Coo * b + x.
gko::matrix::Coo::compute_absolute_inplace
void compute_absolute_inplace() override
Compute absolute inplace on each element.
gko::matrix::Coo::get_const_values
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition coo.hpp:163
gko::matrix::Coo::get_const_row_idxs
const index_type * get_const_row_idxs() const noexcept
Definition coo.hpp:201
gko::matrix::Coo::apply2
const LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x) const
gko::matrix::Coo::compute_absolute
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
gko::matrix::Coo::create
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.
gko::matrix::Coo::get_num_stored_elements
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition coo.hpp:211
gko::matrix::Coo::extract_diagonal
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
gko::matrix::Coo::get_row_idxs
index_type * get_row_idxs() noexcept
Returns the row indexes of the matrix.
Definition coo.hpp:192
gko::matrix::Coo::create
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...
gko::matrix::Coo::get_values
value_type * get_values() noexcept
Returns the values of the matrix.
Definition coo.hpp:154
gko::matrix::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
gko::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
gko::matrix::Hybrid
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:57
gko::ptr_param
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
gko::matrix
The matrix namespace.
Definition dense_cache.hpp:24
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::remove_complex
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
gko::to_complex
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
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
gko::previous_precision
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
gko::next_precision
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
std
STL namespace.
gko::dim
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:26
gko::matrix_data
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126