Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
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
24namespace gko {
25namespace batch {
26
27
51template <typename ValueType = default_precision>
52class MultiVector
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>>> {
62 friend class EnablePolymorphicObject<MultiVector>;
63 friend class MultiVector<to_complex<ValueType>>;
64 friend class MultiVector<previous_precision<ValueType>>;
65
66public:
67 using EnablePolymorphicAssignment<MultiVector>::convert_to;
68 using EnablePolymorphicAssignment<MultiVector>::move_to;
69 using ConvertibleTo<MultiVector<next_precision<ValueType>>>::convert_to;
70 using ConvertibleTo<MultiVector<next_precision<ValueType>>>::move_to;
71
72 using value_type = ValueType;
73 using index_type = int32;
74 using unbatch_type = gko::matrix::Dense<ValueType>;
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>>;
94 using ConvertibleTo<MultiVector<next_precision<ValueType, 2>>>::convert_to;
95 using ConvertibleTo<MultiVector<next_precision<ValueType, 2>>>::move_to;
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>>;
105 using ConvertibleTo<MultiVector<next_precision<ValueType, 3>>>::convert_to;
106 using ConvertibleTo<MultiVector<next_precision<ValueType, 3>>>::move_to;
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,
310 ptr_param<const MultiVector<ValueType>> b);
311
320 void compute_dot(ptr_param<const MultiVector<ValueType>> b,
321 ptr_param<MultiVector<ValueType>> result) const;
322
333 void compute_conj_dot(ptr_param<const MultiVector<ValueType>> b,
334 ptr_param<MultiVector<ValueType>> result) const;
335
344 ptr_param<MultiVector<remove_complex<ValueType>>> result) const;
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
414private:
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
421protected:
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
457private:
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_
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:479
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:743
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition batch_multi_vector.hpp:61
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
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...
size_type get_cumulative_offset(size_type batch_id) const
Get the cumulative storage size offset.
Definition batch_multi_vector.hpp:222
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
void scale(ptr_param< const MultiVector< ValueType > > alpha)
Scales the vector with a scalar (aka: BLAS scal).
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.
value_type * get_values() noexcept
Returns a pointer to the array of values of the multi-vector.
Definition batch_multi_vector.hpp:161
dim< 2 > get_common_size() const
Returns the common size of the batch items.
Definition batch_multi_vector.hpp:154
static std::unique_ptr< MultiVector > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size, array< value_type > values)
Creates a MultiVector from an already allocated (and initialized) array.
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...
void fill(ValueType value)
Fills the input MultiVector with a given value.
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
size_type get_num_batch_items() const
Returns the number of batch items.
Definition batch_multi_vector.hpp:144
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
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
batch_dim< 2 > get_size() const
Returns the batch size.
Definition batch_multi_vector.hpp:137
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.
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
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.
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).
void compute_norm2(ptr_param< MultiVector< remove_complex< ValueType > > > result) const
Computes the Euclidean (L^2) norm of each multi-vector in this batch.
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
static std::unique_ptr< MultiVector > create_with_config_of(ptr_param< const MultiVector > other)
Creates a MultiVector with the configuration of another MultiVector.
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
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.
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
The Ginkgo namespace.
Definition abstract_factory.hpp:20
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
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:107
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
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
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
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
STL namespace.
A type representing the dimensions of a multidimensional batch object.
Definition batch_dim.hpp:27
dim< dimensionality, dimension_type > get_common_size() const
Get the common size of the batch items.
Definition batch_dim.hpp:43
size_type get_num_batch_items() const
Get the number of batch items stored.
Definition batch_dim.hpp:36
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:26