Ginkgo  Generated from pipelines/2017069469 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
batch_ell.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_ELL_HPP_
6 #define GKO_PUBLIC_CORE_MATRIX_BATCH_ELL_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/range_accessors.hpp>
18 #include <ginkgo/core/base/types.hpp>
19 #include <ginkgo/core/base/utils.hpp>
20 #include <ginkgo/core/base/utils_helper.hpp>
21 #include <ginkgo/core/matrix/ell.hpp>
22 
23 
24 namespace gko {
25 namespace batch {
26 namespace matrix {
27 
28 
51 template <typename ValueType = default_precision, typename IndexType = int32>
52 class Ell final
53  : public EnableBatchLinOp<Ell<ValueType, IndexType>>,
54 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
55  public ConvertibleTo<Ell<next_precision<ValueType, 2>, IndexType>>,
56 #endif
57 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
58  public ConvertibleTo<Ell<next_precision<ValueType, 3>, IndexType>>,
59 #endif
60  public ConvertibleTo<Ell<next_precision<ValueType>, IndexType>> {
61  friend class EnablePolymorphicObject<Ell, BatchLinOp>;
62  friend class Ell<to_complex<ValueType>, IndexType>;
63  friend class Ell<previous_precision<ValueType>, IndexType>;
64  static_assert(std::is_same<IndexType, int32>::value,
65  "IndexType must be a 32 bit integer");
66 
67 public:
70 
71  using value_type = ValueType;
72  using index_type = IndexType;
74  using absolute_type = remove_complex<Ell>;
75  using complex_type = to_complex<Ell>;
76 
77  void convert_to(
78  Ell<next_precision<ValueType>, IndexType>* result) const override;
79 
80  void move_to(Ell<next_precision<ValueType>, IndexType>* result) override;
81 
82 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
83  friend class Ell<previous_precision<ValueType, 2>, IndexType>;
84  using ConvertibleTo<
85  Ell<next_precision<ValueType, 2>, IndexType>>::convert_to;
86  using ConvertibleTo<Ell<next_precision<ValueType, 2>, IndexType>>::move_to;
87 
88  void convert_to(
89  Ell<next_precision<ValueType, 2>, IndexType>* result) const override;
90 
91  void move_to(Ell<next_precision<ValueType, 2>, IndexType>* result) override;
92 #endif
93 
94 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
95  friend class Ell<previous_precision<ValueType, 3>, IndexType>;
96  using ConvertibleTo<
97  Ell<next_precision<ValueType, 3>, IndexType>>::convert_to;
98  using ConvertibleTo<Ell<next_precision<ValueType, 3>, IndexType>>::move_to;
99 
100  void convert_to(
101  Ell<next_precision<ValueType, 3>, IndexType>* result) const override;
102 
103  void move_to(Ell<next_precision<ValueType, 3>, IndexType>* result) override;
104 #endif
105 
116  std::unique_ptr<unbatch_type> create_view_for_item(size_type item_id);
117 
121  std::unique_ptr<const unbatch_type> create_const_view_for_item(
122  size_type item_id) const;
123 
129  value_type* get_values() noexcept { return values_.get_data(); }
130 
138  const value_type* get_const_values() const noexcept
139  {
140  return values_.get_const_data();
141  }
142 
148  index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
149 
157  const index_type* get_const_col_idxs() const noexcept
158  {
159  return col_idxs_.get_const_data();
160  }
161 
168  index_type get_num_stored_elements_per_row() const noexcept
169  {
170  return num_elems_per_row_;
171  }
172 
181  {
182  return values_.get_size();
183  }
184 
191  {
192  return this->get_num_stored_elements() / this->get_num_batch_items();
193  }
194 
203  index_type* get_col_idxs_for_item(size_type batch_id) noexcept
204  {
205  GKO_ASSERT(batch_id < this->get_num_batch_items());
206  return col_idxs_.get_data();
207  }
208 
216  const index_type* get_const_col_idxs_for_item(
217  size_type batch_id) const noexcept
218  {
219  GKO_ASSERT(batch_id < this->get_num_batch_items());
220  return col_idxs_.get_const_data();
221  }
222 
231  value_type* get_values_for_item(size_type batch_id) noexcept
232  {
233  GKO_ASSERT(batch_id < this->get_num_batch_items());
234  return values_.get_data() +
235  batch_id * this->get_num_elements_per_item();
236  }
237 
245  const value_type* get_const_values_for_item(
246  size_type batch_id) const noexcept
247  {
248  GKO_ASSERT(batch_id < this->get_num_batch_items());
249  return values_.get_const_data() +
250  batch_id * this->get_num_elements_per_item();
251  }
252 
262  static std::unique_ptr<Ell> create(
263  std::shared_ptr<const Executor> exec,
264  const batch_dim<2>& size = batch_dim<2>{},
265  const IndexType num_elems_per_row = 0);
266 
283  static std::unique_ptr<Ell> create(std::shared_ptr<const Executor> exec,
284  const batch_dim<2>& size,
285  const IndexType num_elems_per_row,
286  array<value_type> values,
287  array<index_type> col_idxs);
288 
294  template <typename InputValueType, typename ColIndexType>
295  GKO_DEPRECATED(
296  "explicitly construct the gko::array arguments instead of passing "
297  "initializer lists")
298  static std::unique_ptr<Ell> create(
299  std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
300  const IndexType num_elems_per_row,
301  std::initializer_list<InputValueType> values,
302  std::initializer_list<ColIndexType> col_idxs)
303  {
304  return create(exec, size, num_elems_per_row,
305  array<value_type>{exec, std::move(values)},
306  array<index_type>{exec, std::move(col_idxs)});
307  }
308 
325  static std::unique_ptr<const Ell> create_const(
326  std::shared_ptr<const Executor> exec, const batch_dim<2>& sizes,
327  const index_type num_elems_per_row,
328  gko::detail::const_array_view<value_type>&& values,
329  gko::detail::const_array_view<index_type>&& col_idxs);
330 
340 
355 
359  const Ell* apply(ptr_param<const MultiVector<value_type>> b,
361 
367  const Ell* apply(ptr_param<const MultiVector<value_type>> alpha,
371 
378  void scale(const array<value_type>& row_scale,
379  const array<value_type>& col_scale);
380 
392  ptr_param<const MultiVector<value_type>> beta);
393 
394 private:
395  size_type compute_num_elems(const batch_dim<2>& size,
396  IndexType num_elems_per_row)
397  {
398  return size.get_num_batch_items() * size.get_common_size()[0] *
399  num_elems_per_row;
400  }
401 
402  Ell(std::shared_ptr<const Executor> exec,
403  const batch_dim<2>& size = batch_dim<2>{},
404  const IndexType num_elems_per_row = 0);
405 
406  Ell(std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
407  const IndexType num_elems_per_row, array<value_type> values,
408  array<index_type> col_idxs);
409 
410  void apply_impl(const MultiVector<value_type>* b,
411  MultiVector<value_type>* x) const;
412 
413  void apply_impl(const MultiVector<value_type>* alpha,
414  const MultiVector<value_type>* b,
415  const MultiVector<value_type>* beta,
416  MultiVector<value_type>* x) const;
417 
418  index_type num_elems_per_row_;
419  array<value_type> values_;
420  array<index_type> col_idxs_;
421 };
422 
423 
424 } // namespace matrix
425 } // namespace batch
426 } // namespace gko
427 
428 
429 #endif // GKO_PUBLIC_CORE_MATRIX_BATCH_ELL_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::Ell::get_num_stored_elements_per_row
index_type get_num_stored_elements_per_row() const noexcept
Returns the number of elements per row explicitly stored.
Definition: batch_ell.hpp:168
gko::batch_dim::get_num_batch_items
size_type get_num_batch_items() const
Get the number of batch items stored.
Definition: batch_dim.hpp:36
gko::batch_dim::get_common_size
dim< dimensionality, dimension_type > get_common_size() const
Get the common size of the batch items.
Definition: batch_dim.hpp:43
gko::batch::matrix::Ell::get_values
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition: batch_ell.hpp:129
gko::batch::matrix::Ell::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_ell.hpp:180
gko::batch::matrix::Ell
Ell is a sparse matrix format that stores the same number of nonzeros in each row,...
Definition: batch_ell.hpp:52
gko::batch::BatchLinOp
Definition: batch_lin_op.hpp:59
gko::batch::matrix::Ell::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::Ell::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_ell.hpp:231
gko::batch::matrix::Ell::get_col_idxs_for_item
index_type * get_col_idxs_for_item(size_type batch_id) noexcept
Returns a pointer to the array of col_idxs of the matrix.
Definition: batch_ell.hpp:203
gko::batch::MultiVector
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition: batch_multi_vector.hpp:52
gko::batch::matrix::Ell::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_ell.hpp:245
gko::batch::matrix::Ell::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_ell.hpp:157
gko
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
gko::batch::matrix::Ell::create_view_for_item
std::unique_ptr< unbatch_type > create_view_for_item(size_type item_id)
Creates a mutable view (of matrix::Ell type) of one item of the batch::matrix::Ell<value_type> object...
gko::array< value_type >
gko::batch::matrix::Ell::get_col_idxs
index_type * get_col_idxs() noexcept
Returns a pointer to the array of column indices of the matrix.
Definition: batch_ell.hpp:148
gko::batch::matrix::Ell::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_dim< 2 >
gko::batch::matrix::Ell::create
static std::unique_ptr< Ell > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{}, const IndexType num_elems_per_row=0)
Creates an uninitialized Ell matrix of the specified size.
gko::ptr_param
This class is used for function parameters in the place of raw pointers.
Definition: utils_helper.hpp:41
gko::batch::matrix::Ell::apply
Ell * apply(ptr_param< const MultiVector< value_type >> b, ptr_param< MultiVector< value_type >> x)
Apply the matrix to a multi-vector.
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::Ell::create_const
static std::unique_ptr< const Ell > create_const(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &sizes, const index_type num_elems_per_row, gko::detail::const_array_view< value_type > &&values, gko::detail::const_array_view< index_type > &&col_idxs)
Creates a constant (immutable) batch ell matrix from a constant array.
gko::batch::matrix::Ell::get_const_col_idxs_for_item
const index_type * get_const_col_idxs_for_item(size_type batch_id) const noexcept
Returns a pointer to the array of col_idxs of the matrix.
Definition: batch_ell.hpp:216
gko::batch::matrix::Ell::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_ell.hpp:190
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::matrix::Ell
ELL is a matrix format where stride with explicit zeros is used such that all rows have the same numb...
Definition: csr.hpp:31
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::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::batch::matrix::Ell::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::Ell type) of one item of the batch::matrix::Ell<value_type> object...
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::Ell::get_const_values
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition: batch_ell.hpp:138
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