Ginkgo Generated from branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
batch_multi_vector.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 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
13#include <ginkgo/core/base/array.hpp>
14#include <ginkgo/core/base/batch_dim.hpp>
15#include <ginkgo/core/base/dim.hpp>
16#include <ginkgo/core/base/executor.hpp>
17#include <ginkgo/core/base/mtx_io.hpp>
18#include <ginkgo/core/base/polymorphic_object.hpp>
19#include <ginkgo/core/base/range_accessors.hpp>
20#include <ginkgo/core/base/types.hpp>
21#include <ginkgo/core/base/utils.hpp>
22#include <ginkgo/core/matrix/dense.hpp>
23
24
25namespace gko {
26namespace batch {
27
28
52template <typename ValueType = default_precision>
53class MultiVector
54 : public EnablePolymorphicObject<MultiVector<ValueType>>,
55 public EnablePolymorphicAssignment<MultiVector<ValueType>>,
56 public ConvertibleTo<MultiVector<next_precision<ValueType>>> {
57 friend class EnablePolymorphicObject<MultiVector>;
58 friend class MultiVector<to_complex<ValueType>>;
59 friend class MultiVector<next_precision<ValueType>>;
60
61public:
62 using EnablePolymorphicAssignment<MultiVector>::convert_to;
63 using EnablePolymorphicAssignment<MultiVector>::move_to;
64 using ConvertibleTo<MultiVector<next_precision<ValueType>>>::convert_to;
65 using ConvertibleTo<MultiVector<next_precision<ValueType>>>::move_to;
66
67 using value_type = ValueType;
68 using index_type = int32;
69 using unbatch_type = gko::matrix::Dense<ValueType>;
70 using absolute_type = remove_complex<MultiVector<ValueType>>;
71 using complex_type = to_complex<MultiVector<ValueType>>;
72
79 static std::unique_ptr<MultiVector> create_with_config_of(
81
82 void convert_to(
83 MultiVector<next_precision<ValueType>>* result) const override;
84
85 void move_to(MultiVector<next_precision<ValueType>>* result) override;
86
97 std::unique_ptr<unbatch_type> create_view_for_item(size_type item_id);
98
102 std::unique_ptr<const unbatch_type> create_const_view_for_item(
103 size_type item_id) const;
104
110 batch_dim<2> get_size() const { return batch_size_; }
111
118 {
119 return batch_size_.get_num_batch_items();
120 }
121
127 dim<2> get_common_size() const { return batch_size_.get_common_size(); }
128
134 value_type* get_values() noexcept { return values_.get_data(); }
135
143 const value_type* get_const_values() const noexcept
144 {
145 return values_.get_const_data();
146 }
147
156 value_type* get_values_for_item(size_type batch_id) noexcept
157 {
158 GKO_ASSERT(batch_id < this->get_num_batch_items());
159 return values_.get_data() + this->get_cumulative_offset(batch_id);
160 }
161
169 const value_type* get_const_values_for_item(
170 size_type batch_id) const noexcept
171 {
172 GKO_ASSERT(batch_id < this->get_num_batch_items());
173 return values_.get_const_data() + this->get_cumulative_offset(batch_id);
174 }
175
184 {
185 return values_.get_size();
186 }
187
196 {
197 return batch_id * this->get_common_size()[0] *
198 this->get_common_size()[1];
199 }
200
212 value_type& at(size_type batch_id, size_type row, size_type col)
213 {
214 GKO_ASSERT(batch_id < this->get_num_batch_items());
215 return values_.get_data()[linearize_index(batch_id, row, col)];
216 }
217
221 value_type at(size_type batch_id, size_type row, size_type col) const
222 {
223 GKO_ASSERT(batch_id < this->get_num_batch_items());
224 return values_.get_const_data()[linearize_index(batch_id, row, col)];
225 }
226
241 ValueType& at(size_type batch_id, size_type idx) noexcept
242 {
243 return values_.get_data()[linearize_index(batch_id, idx)];
244 }
245
249 ValueType at(size_type batch_id, size_type idx) const noexcept
250 {
251 return values_.get_const_data()[linearize_index(batch_id, idx)];
252 }
253
269
284
294 ptr_param<MultiVector<ValueType>> result) const;
295
307 ptr_param<MultiVector<ValueType>> result) const;
308
318
328 static std::unique_ptr<MultiVector> create(
329 std::shared_ptr<const Executor> exec,
330 const batch_dim<2>& size = batch_dim<2>{});
331
344 static std::unique_ptr<MultiVector> create(
345 std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
346 array<value_type> values);
347
352 template <typename InputValueType>
353 GKO_DEPRECATED(
354 "explicitly construct the gko::array argument instead of passing an "
355 "initializer list")
356 static std::unique_ptr<MultiVector> create(
357 std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
358 std::initializer_list<InputValueType> values)
359 {
360 return create(exec, size, array<index_type>{exec, std::move(values)});
361 }
362
376 static std::unique_ptr<const MultiVector> create_const(
377 std::shared_ptr<const Executor> exec, const batch_dim<2>& sizes,
378 gko::detail::const_array_view<ValueType>&& values);
379
385 void fill(ValueType value);
386
387private:
388 inline size_type compute_num_elems(const batch_dim<2>& size)
389 {
390 return size.get_num_batch_items() * size.get_common_size()[0] *
391 size.get_common_size()[1];
392 }
393
394protected:
400 void set_size(const batch_dim<2>& value) noexcept;
401
402 MultiVector(std::shared_ptr<const Executor> exec,
403 const batch_dim<2>& size = batch_dim<2>{});
404
405 MultiVector(std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
406 array<value_type> values);
407
415 std::unique_ptr<MultiVector> create_with_same_config() const;
416
417 size_type linearize_index(size_type batch, size_type row,
418 size_type col) const noexcept
419 {
420 return this->get_cumulative_offset(batch) +
421 row * batch_size_.get_common_size()[1] + col;
422 }
423
424 size_type linearize_index(size_type batch, size_type idx) const noexcept
425 {
426 return linearize_index(batch, idx / this->get_common_size()[1],
427 idx % this->get_common_size()[1]);
428 }
429
430private:
431 batch_dim<2> batch_size_;
432 array<value_type> values_;
433};
434
435
436} // namespace batch
437} // namespace gko
438
439
440#endif // GKO_PUBLIC_CORE_BASE_BATCH_MULTI_VECTOR_HPP_
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:616
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition logger.hpp:25
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition array.hpp:674
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:683
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition array.hpp:657
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition logger.hpp:41
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:156
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:195
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:169
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:134
dim< 2 > get_common_size() const
Returns the common size of the batch items.
Definition batch_multi_vector.hpp:127
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:241
size_type get_num_batch_items() const
Returns the number of batch items.
Definition batch_multi_vector.hpp:117
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:183
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:249
batch_dim< 2 > get_size() const
Returns the batch size.
Definition batch_multi_vector.hpp:110
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:143
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:221
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:212
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 sparsity_csr.hpp:26
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:43
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:326
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:103
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list.
Definition math.hpp:462
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:345
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:86
A type representing the dimensions of a multidimensional batch object.
Definition batch_dim.hpp:28
dim< dimensionality, dimension_type > get_common_size() const
Get the common size of the batch items.
Definition batch_dim.hpp:44
size_type get_num_batch_items() const
Get the number of batch items stored.
Definition batch_dim.hpp:37
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:27