Ginkgo  Generated from pipelines/2017069469 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
batch_multi_vector.hpp
1 // SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2 //
3 // SPDX-License-Identifier: BSD-3-Clause
4 
5 #ifndef GKO_PUBLIC_CORE_BASE_BATCH_MULTI_VECTOR_HPP_
6 #define GKO_PUBLIC_CORE_BASE_BATCH_MULTI_VECTOR_HPP_
7 
8 
9 #include <initializer_list>
10 #include <vector>
11 
12 #include <ginkgo/core/base/array.hpp>
13 #include <ginkgo/core/base/batch_dim.hpp>
14 #include <ginkgo/core/base/dim.hpp>
15 #include <ginkgo/core/base/executor.hpp>
16 #include <ginkgo/core/base/mtx_io.hpp>
17 #include <ginkgo/core/base/polymorphic_object.hpp>
18 #include <ginkgo/core/base/range_accessors.hpp>
19 #include <ginkgo/core/base/types.hpp>
20 #include <ginkgo/core/base/utils.hpp>
21 #include <ginkgo/core/matrix/dense.hpp>
22 
23 
24 namespace gko {
25 namespace batch {
26 
27 
51 template <typename ValueType = default_precision>
53  : public EnablePolymorphicObject<MultiVector<ValueType>>,
54  public EnablePolymorphicAssignment<MultiVector<ValueType>>,
55 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
56  public ConvertibleTo<MultiVector<next_precision<ValueType, 2>>>,
57 #endif
58 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
59  public ConvertibleTo<MultiVector<next_precision<ValueType, 3>>>,
60 #endif
61  public ConvertibleTo<MultiVector<next_precision<ValueType>>> {
63  friend class MultiVector<to_complex<ValueType>>;
64  friend class MultiVector<previous_precision<ValueType>>;
65 
66 public:
71 
72  using value_type = ValueType;
73  using index_type = int32;
75  using absolute_type = remove_complex<MultiVector<ValueType>>;
76  using complex_type = to_complex<MultiVector<ValueType>>;
77 
84  static std::unique_ptr<MultiVector> create_with_config_of(
86 
87  void convert_to(
88  MultiVector<next_precision<ValueType>>* result) const override;
89 
90  void move_to(MultiVector<next_precision<ValueType>>* result) override;
91 
92 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
93  friend class MultiVector<previous_precision<ValueType, 2>>;
96 
97  void convert_to(
98  MultiVector<next_precision<ValueType, 2>>* result) const override;
99 
100  void move_to(MultiVector<next_precision<ValueType, 2>>* result) override;
101 #endif
102 
103 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
104  friend class MultiVector<previous_precision<ValueType, 3>>;
107 
108  void convert_to(
109  MultiVector<next_precision<ValueType, 3>>* result) const override;
110 
111  void move_to(MultiVector<next_precision<ValueType, 3>>* result) override;
112 #endif
113 
124  std::unique_ptr<unbatch_type> create_view_for_item(size_type item_id);
125 
129  std::unique_ptr<const unbatch_type> create_const_view_for_item(
130  size_type item_id) const;
131 
137  batch_dim<2> get_size() const { return batch_size_; }
138 
145  {
146  return batch_size_.get_num_batch_items();
147  }
148 
154  dim<2> get_common_size() const { return batch_size_.get_common_size(); }
155 
161  value_type* get_values() noexcept { return values_.get_data(); }
162 
170  const value_type* get_const_values() const noexcept
171  {
172  return values_.get_const_data();
173  }
174 
183  value_type* get_values_for_item(size_type batch_id) noexcept
184  {
185  GKO_ASSERT(batch_id < this->get_num_batch_items());
186  return values_.get_data() + this->get_cumulative_offset(batch_id);
187  }
188 
196  const value_type* get_const_values_for_item(
197  size_type batch_id) const noexcept
198  {
199  GKO_ASSERT(batch_id < this->get_num_batch_items());
200  return values_.get_const_data() + this->get_cumulative_offset(batch_id);
201  }
202 
211  {
212  return values_.get_size();
213  }
214 
223  {
224  return batch_id * this->get_common_size()[0] *
225  this->get_common_size()[1];
226  }
227 
239  value_type& at(size_type batch_id, size_type row, size_type col)
240  {
241  GKO_ASSERT(batch_id < this->get_num_batch_items());
242  return values_.get_data()[linearize_index(batch_id, row, col)];
243  }
244 
248  value_type at(size_type batch_id, size_type row, size_type col) const
249  {
250  GKO_ASSERT(batch_id < this->get_num_batch_items());
251  return values_.get_const_data()[linearize_index(batch_id, row, col)];
252  }
253 
268  ValueType& at(size_type batch_id, size_type idx) noexcept
269  {
270  return values_.get_data()[linearize_index(batch_id, idx)];
271  }
272 
276  ValueType at(size_type batch_id, size_type idx) const noexcept
277  {
278  return values_.get_const_data()[linearize_index(batch_id, idx)];
279  }
280 
295  void scale(ptr_param<const MultiVector<ValueType>> alpha);
296 
309  void add_scaled(ptr_param<const MultiVector<ValueType>> alpha,
311 
321  ptr_param<MultiVector<ValueType>> result) const;
322 
334  ptr_param<MultiVector<ValueType>> result) const;
335 
343  void compute_norm2(
345 
355  static std::unique_ptr<MultiVector> create(
356  std::shared_ptr<const Executor> exec,
357  const batch_dim<2>& size = batch_dim<2>{});
358 
371  static std::unique_ptr<MultiVector> create(
372  std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
373  array<value_type> values);
374 
379  template <typename InputValueType>
380  GKO_DEPRECATED(
381  "explicitly construct the gko::array argument instead of passing an "
382  "initializer list")
383  static std::unique_ptr<MultiVector> create(
384  std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
385  std::initializer_list<InputValueType> values)
386  {
387  return create(exec, size, array<index_type>{exec, std::move(values)});
388  }
389 
403  static std::unique_ptr<const MultiVector> create_const(
404  std::shared_ptr<const Executor> exec, const batch_dim<2>& sizes,
405  gko::detail::const_array_view<ValueType>&& values);
406 
412  void fill(ValueType value);
413 
414 private:
415  inline size_type compute_num_elems(const batch_dim<2>& size)
416  {
417  return size.get_num_batch_items() * size.get_common_size()[0] *
418  size.get_common_size()[1];
419  }
420 
421 protected:
427  void set_size(const batch_dim<2>& value) noexcept;
428 
429  MultiVector(std::shared_ptr<const Executor> exec,
430  const batch_dim<2>& size = batch_dim<2>{});
431 
432  MultiVector(std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
433  array<value_type> values);
434 
442  std::unique_ptr<MultiVector> create_with_same_config() const;
443 
444  size_type linearize_index(size_type batch, size_type row,
445  size_type col) const noexcept
446  {
447  return this->get_cumulative_offset(batch) +
448  row * batch_size_.get_common_size()[1] + col;
449  }
450 
451  size_type linearize_index(size_type batch, size_type idx) const noexcept
452  {
453  return linearize_index(batch, idx / this->get_common_size()[1],
454  idx % this->get_common_size()[1]);
455  }
456 
457 private:
458  batch_dim<2> batch_size_;
459  array<value_type> values_;
460 };
461 
462 
463 } // namespace batch
464 } // namespace gko
465 
466 
467 #endif // GKO_PUBLIC_CORE_BASE_BATCH_MULTI_VECTOR_HPP_
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::MultiVector::at
value_type & at(size_type batch_id, size_type row, size_type col)
Returns a single element for a particular batch item.
Definition: batch_multi_vector.hpp:239
gko::batch::MultiVector::scale
void scale(ptr_param< const MultiVector< ValueType >> alpha)
Scales the vector with a scalar (aka: BLAS scal).
gko::batch::MultiVector::add_scaled
void add_scaled(ptr_param< const MultiVector< ValueType >> alpha, ptr_param< const MultiVector< ValueType >> b)
Adds b scaled by alpha to the vector (aka: BLAS axpy).
gko::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition: dense_cache.hpp:28
gko::batch::MultiVector::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_multi_vector.hpp:210
gko::batch::MultiVector::compute_dot
void compute_dot(ptr_param< const MultiVector< ValueType >> b, ptr_param< MultiVector< ValueType >> result) const
Computes the column-wise dot product of each multi-vector in this batch and its corresponding entry i...
gko::batch::MultiVector::create_view_for_item
std::unique_ptr< unbatch_type > create_view_for_item(size_type item_id)
Creates a mutable view (of matrix::Dense type) of one item of the Batch MultiVector object.
gko::batch::MultiVector::at
ValueType at(size_type batch_id, size_type idx) const noexcept
Returns a single element for a particular batch item.
Definition: batch_multi_vector.hpp:276
gko::batch::MultiVector::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 multi-vector for a specific batch item.
Definition: batch_multi_vector.hpp:196
gko::batch::MultiVector::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 multi-vector for a specific batch item.
Definition: batch_multi_vector.hpp:183
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition: types.hpp:90
gko::EnablePolymorphicAssignment
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition: polymorphic_object.hpp:743
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::MultiVector::fill
void fill(ValueType value)
Fills the input MultiVector with a given value.
gko::batch::MultiVector::at
ValueType & at(size_type batch_id, size_type idx) noexcept
Returns a single element for a particular batch item.
Definition: batch_multi_vector.hpp:268
gko
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
gko::batch::MultiVector::get_size
batch_dim< 2 > get_size() const
Returns the batch size.
Definition: batch_multi_vector.hpp:137
gko::batch::MultiVector::compute_conj_dot
void compute_conj_dot(ptr_param< const MultiVector< ValueType >> b, ptr_param< MultiVector< ValueType >> result) const
Computes the column-wise conjugate dot product of each multi-vector in this batch and its correspondi...
gko::array< value_type >
gko::batch::MultiVector::compute_norm2
void compute_norm2(ptr_param< MultiVector< remove_complex< ValueType >>> result) const
Computes the Euclidean (L^2) norm of each multi-vector in this batch.
gko::batch::MultiVector::get_values
value_type * get_values() noexcept
Returns a pointer to the array of values of the multi-vector.
Definition: batch_multi_vector.hpp:161
gko::dim< 2 >
gko::batch::MultiVector::at
value_type at(size_type batch_id, size_type row, size_type col) const
Returns a single element for a particular batch item.
Definition: batch_multi_vector.hpp:248
gko::batch::MultiVector::create_const
static std::unique_ptr< const MultiVector > create_const(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &sizes, gko::detail::const_array_view< ValueType > &&values)
Creates a constant (immutable) batch multi-vector from a constant array.
gko::batch::MultiVector::get_common_size
dim< 2 > get_common_size() const
Returns the common size of the batch items.
Definition: batch_multi_vector.hpp:154
gko::batch::MultiVector::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::Dense type) of one item of the Batch MultiVector object.
gko::batch_dim< 2 >
gko::batch::MultiVector::get_num_batch_items
size_type get_num_batch_items() const
Returns the number of batch items.
Definition: batch_multi_vector.hpp:144
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::MultiVector::create
static std::unique_ptr< MultiVector > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{})
Creates an uninitialized multi-vector of the specified size.
gko::batch::MultiVector::get_const_values
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the multi-vector.
Definition: batch_multi_vector.hpp:170
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::ConvertibleTo
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition: polymorphic_object.hpp:479
gko::int32
std::int32_t int32
32-bit signed integral type.
Definition: types.hpp:107
gko::batch::MultiVector::create_with_config_of
static std::unique_ptr< MultiVector > create_with_config_of(ptr_param< const MultiVector > other)
Creates a MultiVector with the configuration of another MultiVector.
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::MultiVector::get_cumulative_offset
size_type get_cumulative_offset(size_type batch_id) const
Get the cumulative storage size offset.
Definition: batch_multi_vector.hpp:222
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