Ginkgo  Generated from pipelines/2017069469 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
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 
13 namespace gko {
19 namespace matrix {
20 
21 
22 template <typename ValueType, typename IndexType>
23 class Csr;
24 
25 template <typename ValueType>
26 class Dense;
27 
28 template <typename ValueType, typename IndexType>
29 class CooBuilder;
30 
31 template <typename ValueType, typename IndexType>
32 class Hybrid;
33 
34 
49 template <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,
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 
73 public:
76  using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::convert_to;
77  using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::move_to;
78  using ConvertibleTo<Csr<ValueType, IndexType>>::convert_to;
80  using ConvertibleTo<Dense<ValueType>>::convert_to;
81  using ConvertibleTo<Dense<ValueType>>::move_to;
83 
84  using value_type = ValueType;
85  using index_type = 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 
146  void compute_absolute_inplace() override;
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 
242  ptr_param<LinOp> x);
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 
328 protected:
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 
354 private:
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_
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::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition: matrix.hpp:30
gko::matrix::Coo::get_col_idxs
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition: coo.hpp:172
gko::LinOp
Definition: lin_op.hpp:117
gko::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition: dense_cache.hpp:28
gko::DiagonalExtractable
The diagonal of a LinOp implementing this interface can be extracted.
Definition: lin_op.hpp:743
gko::matrix::Coo::read
void read(const mat_data &data) override
Reads a matrix from a matrix_data structure.
gko::matrix::Coo::compute_absolute
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
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:181
gko::Transposable
Linear operators which support transposition should implement the Transposable interface.
Definition: lin_op.hpp:433
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition: types.hpp:90
gko::matrix::CooBuilder
Definition: coo.hpp:29
gko
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
gko::array< value_type >
gko::dim< 2 >
gko::matrix_data
This structure is used as an intermediate data type to store a sparse matrix.
Definition: matrix_data.hpp:126
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:210
gko::ptr_param
This class is used for function parameters in the place of raw pointers.
Definition: utils_helper.hpp:41
gko::matrix::Coo::write
void write(mat_data &data) const override
Writes a matrix to a matrix_data structure.
gko::array::get_data
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:687
gko::ReadableFromMatrixData
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition: lin_op.hpp:605
gko::WritableToMatrixData
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition: lin_op.hpp:660
gko::matrix::Coo::get_values
value_type * get_values() noexcept
Returns the values of the matrix.
Definition: coo.hpp:153
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
gko::matrix::Coo::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
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::matrix::Coo::get_const_row_idxs
const index_type * get_const_row_idxs() const noexcept
Definition: coo.hpp:200
gko::ConvertibleTo
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition: polymorphic_object.hpp:479
gko::matrix::Coo::compute_absolute_inplace
void compute_absolute_inplace() override
Compute absolute inplace on each element.
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::Executor
The first step in using the Ginkgo library consists of creating an executor.
Definition: executor.hpp:615
gko::matrix::Hybrid
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition: coo.hpp:32
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::array::get_const_data
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:696
gko::matrix::Coo::get_const_values
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition: coo.hpp:162
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::EnableAbsoluteComputation
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition: lin_op.hpp:794
gko::matrix::Coo::get_row_idxs
index_type * get_row_idxs() noexcept
Returns the row indexes of the matrix.
Definition: coo.hpp:191
gko::array::get_size
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition: array.hpp:670
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::device_matrix_data
This type is a device-side equivalent to matrix_data.
Definition: device_matrix_data.hpp:36
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:877
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::LinOp::LinOp
LinOp(const LinOp &)=default
Copy-constructs a LinOp.
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::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition: polymorphic_object.hpp:667
gko::matrix::Coo
COO stores a matrix in the coordinate matrix format.
Definition: coo.hpp:50