Ginkgo  Generated from pipelines/2017069469 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
batch_csr.hpp
1 // SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2 //
3 // SPDX-License-Identifier: BSD-3-Clause
4 
5 #ifndef GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_HPP_
6 #define GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_HPP_
7 
8 
9 #include <initializer_list>
10 #include <vector>
11 
12 #include <ginkgo/core/base/array.hpp>
13 #include <ginkgo/core/base/batch_lin_op.hpp>
14 #include <ginkgo/core/base/batch_multi_vector.hpp>
15 #include <ginkgo/core/base/executor.hpp>
16 #include <ginkgo/core/base/mtx_io.hpp>
17 #include <ginkgo/core/base/types.hpp>
18 #include <ginkgo/core/base/utils.hpp>
19 #include <ginkgo/core/matrix/csr.hpp>
20 
21 
22 namespace gko {
23 namespace batch {
24 namespace matrix {
25 
26 
46 template <typename ValueType = default_precision, typename IndexType = int32>
47 class Csr final
48  : public EnableBatchLinOp<Csr<ValueType, IndexType>>,
49 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
50  public ConvertibleTo<Csr<next_precision<ValueType, 2>, IndexType>>,
51 #endif
52 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
53  public ConvertibleTo<Csr<next_precision<ValueType, 3>, IndexType>>,
54 #endif
55  public ConvertibleTo<Csr<next_precision<ValueType>, IndexType>> {
56  friend class EnablePolymorphicObject<Csr, BatchLinOp>;
57  friend class Csr<to_complex<ValueType>, IndexType>;
58  friend class Csr<previous_precision<ValueType>, IndexType>;
59  static_assert(std::is_same<IndexType, int32>::value,
60  "IndexType must be a 32 bit integer");
61 
62 public:
65 
66  using value_type = ValueType;
67  using index_type = IndexType;
69  using absolute_type = remove_complex<Csr>;
70  using complex_type = to_complex<Csr>;
71 
72  void convert_to(
73  Csr<next_precision<ValueType>, IndexType>* result) const override;
74 
75  void move_to(Csr<next_precision<ValueType>, IndexType>* result) override;
76 
77 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
78  friend class Csr<previous_precision<ValueType, 2>, IndexType>;
79  using ConvertibleTo<
80  Csr<next_precision<ValueType, 2>, IndexType>>::convert_to;
81  using ConvertibleTo<Csr<next_precision<ValueType, 2>, IndexType>>::move_to;
82 
83  void convert_to(
84  Csr<next_precision<ValueType, 2>, IndexType>* result) const override;
85 
86  void move_to(Csr<next_precision<ValueType, 2>, IndexType>* result) override;
87 #endif
88 
89 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
90  friend class Csr<previous_precision<ValueType, 3>, IndexType>;
91  using ConvertibleTo<
92  Csr<next_precision<ValueType, 3>, IndexType>>::convert_to;
93  using ConvertibleTo<Csr<next_precision<ValueType, 3>, IndexType>>::move_to;
94 
95  void convert_to(
96  Csr<next_precision<ValueType, 3>, IndexType>* result) const override;
97 
98  void move_to(Csr<next_precision<ValueType, 3>, IndexType>* result) override;
99 #endif
100 
111  std::unique_ptr<unbatch_type> create_view_for_item(size_type item_id);
112 
116  std::unique_ptr<const unbatch_type> create_const_view_for_item(
117  size_type item_id) const;
118 
124  value_type* get_values() noexcept { return values_.get_data(); }
125 
133  const value_type* get_const_values() const noexcept
134  {
135  return values_.get_const_data();
136  }
137 
143  index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
144 
152  const index_type* get_const_col_idxs() const noexcept
153  {
154  return col_idxs_.get_const_data();
155  }
156 
162  index_type* get_row_ptrs() noexcept { return row_ptrs_.get_data(); }
163 
171  const index_type* get_const_row_ptrs() const noexcept
172  {
173  return row_ptrs_.get_const_data();
174  }
175 
184  {
185  return values_.get_size();
186  }
187 
194  {
195  return this->get_num_stored_elements() / this->get_num_batch_items();
196  }
197 
206  value_type* get_values_for_item(size_type batch_id) noexcept
207  {
208  GKO_ASSERT(batch_id < this->get_num_batch_items());
209  GKO_ASSERT(values_.get_size() >=
210  batch_id * this->get_num_elements_per_item());
211  return values_.get_data() +
212  batch_id * this->get_num_elements_per_item();
213  }
214 
222  const value_type* get_const_values_for_item(
223  size_type batch_id) const noexcept
224  {
225  GKO_ASSERT(batch_id < this->get_num_batch_items());
226  GKO_ASSERT(values_.get_size() >=
227  batch_id * this->get_num_elements_per_item());
228  return values_.get_const_data() +
229  batch_id * this->get_num_elements_per_item();
230  }
231 
247  static std::unique_ptr<Csr> create(
248  std::shared_ptr<const Executor> exec,
249  const batch_dim<2>& size = batch_dim<2>{},
250  size_type num_nonzeros_per_item = {});
251 
268  static std::unique_ptr<Csr> create(std::shared_ptr<const Executor> exec,
269  const batch_dim<2>& size,
270  array<value_type> values,
271  array<index_type> col_idxs,
272  array<index_type> row_ptrs);
273 
279  template <typename InputValueType, typename ColIndexType,
280  typename RowPtrType>
281  GKO_DEPRECATED(
282  "explicitly construct the gko::array arguments instead of passing "
283  "initializer lists")
284  static std::unique_ptr<Csr> create(
285  std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
286  std::initializer_list<InputValueType> values,
287  std::initializer_list<ColIndexType> col_idxs,
288  std::initializer_list<RowPtrType> row_ptrs)
289  {
290  return create(exec, size, array<value_type>{exec, std::move(values)},
291  array<index_type>{exec, std::move(col_idxs)},
292  array<index_type>{exec, std::move(row_ptrs)});
293  }
294 
313  static std::unique_ptr<const Csr> create_const(
314  std::shared_ptr<const Executor> exec, const batch_dim<2>& sizes,
315  gko::detail::const_array_view<value_type>&& values,
316  gko::detail::const_array_view<index_type>&& col_idxs,
317  gko::detail::const_array_view<index_type>&& row_ptrs);
318 
328 
343 
347  const Csr* apply(ptr_param<const MultiVector<value_type>> b,
349 
355  const Csr* apply(ptr_param<const MultiVector<value_type>> alpha,
359 
366  void scale(const array<value_type>& row_scale,
367  const array<value_type>& col_scale);
368 
380  ptr_param<const MultiVector<value_type>> beta);
381 
382 private:
383  Csr(std::shared_ptr<const Executor> exec,
384  const batch_dim<2>& size = batch_dim<2>{},
385  size_type num_nonzeros_per_item = {});
386 
387  Csr(std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
388  array<value_type> values, array<index_type> col_idxs,
389  array<index_type> row_ptrs)
390  : EnableBatchLinOp<Csr>(exec, size),
391  values_{exec, std::move(values)},
392  col_idxs_{exec, std::move(col_idxs)},
393  row_ptrs_{exec, std::move(row_ptrs)}
394  {
395  // Ensure that the value and col_idxs arrays have the correct size
396  auto max_num_elems = this->get_common_size()[0] *
397  this->get_common_size()[1] *
398  this->get_num_batch_items();
399  GKO_ASSERT(values_.get_size() <= max_num_elems);
400  GKO_ASSERT_EQ(row_ptrs_.get_size(), this->get_common_size()[0] + 1);
401  GKO_ASSERT_EQ(this->get_num_elements_per_item(), col_idxs_.get_size());
402  }
403 
404  void apply_impl(const MultiVector<value_type>* b,
405  MultiVector<value_type>* x) const;
406 
407  void apply_impl(const MultiVector<value_type>* alpha,
408  const MultiVector<value_type>* b,
409  const MultiVector<value_type>* beta,
410  MultiVector<value_type>* x) const;
411 
412  array<value_type> values_;
413  array<index_type> col_idxs_;
414  array<index_type> row_ptrs_;
415 };
416 
417 
418 } // namespace matrix
419 } // namespace batch
420 } // namespace gko
421 
422 
423 #endif // GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_HPP_
gko::batch::EnableBatchLinOp
The EnableBatchLinOp mixin can be used to provide sensible default implementations of the majority of...
Definition: batch_lin_op.hpp:250
gko::batch::matrix::Csr::get_col_idxs
index_type * get_col_idxs() noexcept
Returns a pointer to the array of column indices of the matrix.
Definition: batch_csr.hpp:143
gko::batch::matrix::Csr::create_const_view_for_item
std::unique_ptr< const unbatch_type > create_const_view_for_item(size_type item_id) const
Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object...
gko::batch::matrix::Csr::get_values_for_item
value_type * get_values_for_item(size_type batch_id) noexcept
Returns a pointer to the array of values of the matrix for a specific batch item.
Definition: batch_csr.hpp:206
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::batch::BatchLinOp
Definition: batch_lin_op.hpp:59
gko::batch::matrix::Csr::create_view_for_item
std::unique_ptr< unbatch_type > create_view_for_item(size_type item_id)
Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object...
gko::batch::matrix::Csr::create
static std::unique_ptr< Csr > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{}, size_type num_nonzeros_per_item={})
Creates an uninitialized Csr matrix of the specified size.
gko::batch::matrix::Csr::scale
void scale(const array< value_type > &row_scale, const array< value_type > &col_scale)
Performs in-place row and column scaling for this matrix.
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition: types.hpp:90
gko::batch::matrix::Csr
Csr is a general sparse matrix format that stores the column indices for each nonzero entry and a cum...
Definition: batch_csr.hpp:47
gko::batch::MultiVector
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition: batch_multi_vector.hpp:52
gko
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
gko::batch::matrix::Csr::apply
Csr * apply(ptr_param< const MultiVector< value_type >> b, ptr_param< MultiVector< value_type >> x)
Apply the matrix to a multi-vector.
gko::array< value_type >
gko::batch_dim< 2 >
gko::batch::matrix::Csr::get_const_values_for_item
const value_type * get_const_values_for_item(size_type batch_id) const noexcept
Returns a pointer to the array of values of the matrix for a specific batch item.
Definition: batch_csr.hpp:222
gko::batch::matrix::Csr::get_num_elements_per_item
size_type get_num_elements_per_item() const noexcept
Returns the number of stored elements in each batch item.
Definition: batch_csr.hpp:193
gko::batch::matrix::Csr::get_row_ptrs
index_type * get_row_ptrs() noexcept
Returns a pointer to the array of row pointers of the matrix.
Definition: batch_csr.hpp:162
gko::batch::matrix::Csr::get_num_stored_elements
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the batch matrix, cumulative across all the batch...
Definition: batch_csr.hpp:183
gko::ptr_param
This class is used for function parameters in the place of raw pointers.
Definition: utils_helper.hpp:41
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::batch::matrix::Csr::add_scaled_identity
void add_scaled_identity(ptr_param< const MultiVector< value_type >> alpha, ptr_param< const MultiVector< value_type >> beta)
Performs the operation this = alpha*I + beta*this.
gko::batch::matrix::Csr::get_const_col_idxs
const index_type * get_const_col_idxs() const noexcept
Returns a pointer to the array of column indices of the matrix.
Definition: batch_csr.hpp:152
gko::batch::matrix::Csr::get_const_row_ptrs
const index_type * get_const_row_ptrs() const noexcept
Returns a pointer to the array of row pointers of the matrix.
Definition: batch_csr.hpp:171
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::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::batch::matrix::Csr::create_const
static std::unique_ptr< const Csr > create_const(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &sizes, gko::detail::const_array_view< value_type > &&values, gko::detail::const_array_view< index_type > &&col_idxs, gko::detail::const_array_view< index_type > &&row_ptrs)
Creates a constant (immutable) batch csr matrix from a constant array.
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::batch::matrix::Csr::get_const_values
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition: batch_csr.hpp:133
gko::Executor
The first step in using the Ginkgo library consists of creating an executor.
Definition: executor.hpp:615
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::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::batch::matrix::Csr::get_values
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition: batch_csr.hpp:124
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