Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
batch_ell.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 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
24namespace gko {
25namespace batch {
26namespace matrix {
27
28
51template <typename ValueType = default_precision, typename IndexType = int32>
52class Ell final
53 : public EnableBatchLinOp<Ell<ValueType, IndexType>>,
54#if GINKGO_ENABLE_HALF
55 public ConvertibleTo<
56 Ell<next_precision<next_precision<ValueType>>, IndexType>>,
57#endif
58 public ConvertibleTo<Ell<next_precision<ValueType>, IndexType>> {
60 friend class Ell<to_complex<ValueType>, IndexType>;
61 friend class Ell<previous_precision<ValueType>, IndexType>;
62 static_assert(std::is_same<IndexType, int32>::value,
63 "IndexType must be a 32 bit integer");
64
65public:
66 using EnableBatchLinOp<Ell>::convert_to;
67 using EnableBatchLinOp<Ell>::move_to;
68
69 using value_type = ValueType;
70 using index_type = IndexType;
72 using absolute_type = remove_complex<Ell>;
73 using complex_type = to_complex<Ell>;
74
75 void convert_to(
76 Ell<next_precision<ValueType>, IndexType>* result) const override;
77
78 void move_to(Ell<next_precision<ValueType>, IndexType>* result) override;
79
80#if GINKGO_ENABLE_HALF
81 friend class Ell<previous_precision<previous_precision<ValueType>>,
82 IndexType>;
83 using ConvertibleTo<
84 Ell<next_precision<next_precision<ValueType>>, IndexType>>::convert_to;
85 using ConvertibleTo<
87
88 void convert_to(Ell<next_precision<next_precision<ValueType>>, IndexType>*
89 result) const override;
90
91 void move_to(Ell<next_precision<next_precision<ValueType>>, IndexType>*
92 result) override;
93#endif
94
105 std::unique_ptr<unbatch_type> create_view_for_item(size_type item_id);
106
110 std::unique_ptr<const unbatch_type> create_const_view_for_item(
111 size_type item_id) const;
112
118 value_type* get_values() noexcept { return values_.get_data(); }
119
127 const value_type* get_const_values() const noexcept
128 {
129 return values_.get_const_data();
130 }
131
137 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
138
146 const index_type* get_const_col_idxs() const noexcept
147 {
148 return col_idxs_.get_const_data();
149 }
150
157 index_type get_num_stored_elements_per_row() const noexcept
158 {
159 return num_elems_per_row_;
160 }
161
170 {
171 return values_.get_size();
172 }
173
180 {
181 return this->get_num_stored_elements() / this->get_num_batch_items();
182 }
183
192 index_type* get_col_idxs_for_item(size_type batch_id) noexcept
193 {
194 GKO_ASSERT(batch_id < this->get_num_batch_items());
195 return col_idxs_.get_data();
196 }
197
206 size_type batch_id) const noexcept
207 {
208 GKO_ASSERT(batch_id < this->get_num_batch_items());
209 return col_idxs_.get_const_data();
210 }
211
220 value_type* get_values_for_item(size_type batch_id) noexcept
221 {
222 GKO_ASSERT(batch_id < this->get_num_batch_items());
223 return values_.get_data() +
224 batch_id * this->get_num_elements_per_item();
225 }
226
234 const value_type* get_const_values_for_item(
235 size_type batch_id) const noexcept
236 {
237 GKO_ASSERT(batch_id < this->get_num_batch_items());
238 return values_.get_const_data() +
239 batch_id * this->get_num_elements_per_item();
240 }
241
251 static std::unique_ptr<Ell> create(
252 std::shared_ptr<const Executor> exec,
253 const batch_dim<2>& size = batch_dim<2>{},
254 const IndexType num_elems_per_row = 0);
255
272 static std::unique_ptr<Ell> create(std::shared_ptr<const Executor> exec,
273 const batch_dim<2>& size,
274 const IndexType num_elems_per_row,
275 array<value_type> values,
276 array<index_type> col_idxs);
277
283 template <typename InputValueType, typename ColIndexType>
284 GKO_DEPRECATED(
285 "explicitly construct the gko::array arguments instead of passing "
286 "initializer lists")
287 static std::unique_ptr<Ell> create(
288 std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
289 const IndexType num_elems_per_row,
290 std::initializer_list<InputValueType> values,
291 std::initializer_list<ColIndexType> col_idxs)
292 {
293 return create(exec, size, num_elems_per_row,
294 array<value_type>{exec, std::move(values)},
295 array<index_type>{exec, std::move(col_idxs)});
296 }
297
314 static std::unique_ptr<const Ell> create_const(
315 std::shared_ptr<const Executor> exec, const batch_dim<2>& sizes,
316 const index_type num_elems_per_row,
317 gko::detail::const_array_view<value_type>&& values,
318 gko::detail::const_array_view<index_type>&& col_idxs);
319
329
344
350
360
367 void scale(const array<value_type>& row_scale,
368 const array<value_type>& col_scale);
369
382
383private:
384 size_type compute_num_elems(const batch_dim<2>& size,
385 IndexType num_elems_per_row)
386 {
387 return size.get_num_batch_items() * size.get_common_size()[0] *
388 num_elems_per_row;
389 }
390
391 Ell(std::shared_ptr<const Executor> exec,
392 const batch_dim<2>& size = batch_dim<2>{},
393 const IndexType num_elems_per_row = 0);
394
395 Ell(std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
396 const IndexType num_elems_per_row, array<value_type> values,
397 array<index_type> col_idxs);
398
399 void apply_impl(const MultiVector<value_type>* b,
400 MultiVector<value_type>* x) const;
401
402 void apply_impl(const MultiVector<value_type>* alpha,
404 const MultiVector<value_type>* beta,
405 MultiVector<value_type>* x) const;
406
407 index_type num_elems_per_row_;
408 array<value_type> values_;
409 array<index_type> col_idxs_;
410};
411
412
413} // namespace matrix
414} // namespace batch
415} // namespace gko
416
417
418#endif // GKO_PUBLIC_CORE_MATRIX_BATCH_ELL_HPP_
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:470
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
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 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:673
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:682
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition array.hpp:656
Definition batch_lin_op.hpp:59
The EnableBatchLinOp mixin can be used to provide sensible default implementations of the majority of...
Definition batch_lin_op.hpp:252
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition logger.hpp:41
Ell is a sparse matrix format that stores the same number of nonzeros in each row,...
Definition batch_ell.hpp:58
const Ell * apply(ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) const
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:205
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.
index_type get_num_stored_elements_per_row() const noexcept
Returns the number of elements per row explicitly stored.
Definition batch_ell.hpp:157
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition batch_ell.hpp:118
Ell * apply(ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x)
Apply the matrix to a multi-vector.
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:146
static std::unique_ptr< Ell > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size, const IndexType num_elems_per_row, array< value_type > values, array< index_type > col_idxs)
Creates a Ell matrix from an already allocated (and initialized) array.
size_type get_num_elements_per_item() const noexcept
Returns the number of stored elements in each batch item.
Definition batch_ell.hpp:179
const Ell * apply(ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > b, ptr_param< const MultiVector< value_type > > beta, ptr_param< MultiVector< value_type > > x) const
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition batch_ell.hpp:127
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...
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:169
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.
Ell * apply(ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > b, ptr_param< const MultiVector< value_type > > beta, ptr_param< MultiVector< value_type > > x)
Apply the matrix to a multi-vector with a linear combination of the given input vector.
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...
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.
index_type * get_col_idxs() noexcept
Returns a pointer to the array of column indices of the matrix.
Definition batch_ell.hpp:137
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:192
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:234
void scale(const array< value_type > &row_scale, const array< value_type > &col_scale)
Performs in-place row and column scaling for this matrix.
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:220
ELL is a matrix format where stride with explicit zeros is used such that all rows have the same numb...
Definition ell.hpp:64
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:260
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list with half.
Definition math.hpp:438
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:279
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
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