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_csr.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_CSR_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_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/types.hpp>
18#include <ginkgo/core/base/utils.hpp>
19#include <ginkgo/core/matrix/csr.hpp>
20
21
22namespace gko {
23namespace batch {
24namespace matrix {
25
26
46template <typename ValueType = default_precision, typename IndexType = int32>
47class Csr final
48 : public EnableBatchLinOp<Csr<ValueType, IndexType>>,
49#if GINKGO_ENABLE_HALF
50 public ConvertibleTo<
51 Csr<next_precision<next_precision<ValueType>>, IndexType>>,
52#endif
53 public ConvertibleTo<Csr<next_precision<ValueType>, IndexType>> {
54 friend class EnablePolymorphicObject<Csr, BatchLinOp>;
55 friend class Csr<to_complex<ValueType>, IndexType>;
56 friend class Csr<previous_precision<ValueType>, IndexType>;
57 static_assert(std::is_same<IndexType, int32>::value,
58 "IndexType must be a 32 bit integer");
59
60public:
61 using EnableBatchLinOp<Csr>::convert_to;
62 using EnableBatchLinOp<Csr>::move_to;
63
64 using value_type = ValueType;
65 using index_type = IndexType;
67 using absolute_type = remove_complex<Csr>;
68 using complex_type = to_complex<Csr>;
69
70 void convert_to(
71 Csr<next_precision<ValueType>, IndexType>* result) const override;
72
73 void move_to(Csr<next_precision<ValueType>, IndexType>* result) override;
74
75#if GINKGO_ENABLE_HALF
76 friend class Csr<previous_precision<previous_precision<ValueType>>,
77 IndexType>;
78 using ConvertibleTo<
79 Csr<next_precision<next_precision<ValueType>>, IndexType>>::convert_to;
80 using ConvertibleTo<
81 Csr<next_precision<next_precision<ValueType>>, IndexType>>::move_to;
82
83 void convert_to(Csr<next_precision<next_precision<ValueType>>, IndexType>*
84 result) const override;
85
86 void move_to(Csr<next_precision<next_precision<ValueType>>, IndexType>*
87 result) override;
88#endif
89
100 std::unique_ptr<unbatch_type> create_view_for_item(size_type item_id);
101
105 std::unique_ptr<const unbatch_type> create_const_view_for_item(
106 size_type item_id) const;
107
113 value_type* get_values() noexcept { return values_.get_data(); }
114
122 const value_type* get_const_values() const noexcept
123 {
124 return values_.get_const_data();
125 }
126
132 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
133
141 const index_type* get_const_col_idxs() const noexcept
142 {
143 return col_idxs_.get_const_data();
144 }
145
151 index_type* get_row_ptrs() noexcept { return row_ptrs_.get_data(); }
152
160 const index_type* get_const_row_ptrs() const noexcept
161 {
162 return row_ptrs_.get_const_data();
163 }
164
173 {
174 return values_.get_size();
175 }
176
183 {
184 return this->get_num_stored_elements() / this->get_num_batch_items();
185 }
186
195 value_type* get_values_for_item(size_type batch_id) noexcept
196 {
197 GKO_ASSERT(batch_id < this->get_num_batch_items());
198 GKO_ASSERT(values_.get_size() >=
199 batch_id * this->get_num_elements_per_item());
200 return values_.get_data() +
201 batch_id * this->get_num_elements_per_item();
202 }
203
211 const value_type* get_const_values_for_item(
212 size_type batch_id) const noexcept
213 {
214 GKO_ASSERT(batch_id < this->get_num_batch_items());
215 GKO_ASSERT(values_.get_size() >=
216 batch_id * this->get_num_elements_per_item());
217 return values_.get_const_data() +
218 batch_id * this->get_num_elements_per_item();
219 }
220
236 static std::unique_ptr<Csr> create(
237 std::shared_ptr<const Executor> exec,
238 const batch_dim<2>& size = batch_dim<2>{},
239 size_type num_nonzeros_per_item = {});
240
257 static std::unique_ptr<Csr> create(std::shared_ptr<const Executor> exec,
258 const batch_dim<2>& size,
259 array<value_type> values,
260 array<index_type> col_idxs,
261 array<index_type> row_ptrs);
262
268 template <typename InputValueType, typename ColIndexType,
269 typename RowPtrType>
270 GKO_DEPRECATED(
271 "explicitly construct the gko::array arguments instead of passing "
272 "initializer lists")
273 static std::unique_ptr<Csr> create(
274 std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
275 std::initializer_list<InputValueType> values,
276 std::initializer_list<ColIndexType> col_idxs,
277 std::initializer_list<RowPtrType> row_ptrs)
278 {
279 return create(exec, size, array<value_type>{exec, std::move(values)},
280 array<index_type>{exec, std::move(col_idxs)},
281 array<index_type>{exec, std::move(row_ptrs)});
282 }
283
302 static std::unique_ptr<const Csr> create_const(
303 std::shared_ptr<const Executor> exec, const batch_dim<2>& sizes,
304 gko::detail::const_array_view<value_type>&& values,
305 gko::detail::const_array_view<index_type>&& col_idxs,
306 gko::detail::const_array_view<index_type>&& row_ptrs);
307
317
332
338
344 const Csr* apply(ptr_param<const MultiVector<value_type>> alpha,
348
355 void scale(const array<value_type>& row_scale,
356 const array<value_type>& col_scale);
357
370
371private:
372 Csr(std::shared_ptr<const Executor> exec,
373 const batch_dim<2>& size = batch_dim<2>{},
374 size_type num_nonzeros_per_item = {});
375
376 Csr(std::shared_ptr<const Executor> exec, const batch_dim<2>& size,
377 array<value_type> values, array<index_type> col_idxs,
378 array<index_type> row_ptrs)
379 : EnableBatchLinOp<Csr>(exec, size),
380 values_{exec, std::move(values)},
381 col_idxs_{exec, std::move(col_idxs)},
382 row_ptrs_{exec, std::move(row_ptrs)}
383 {
384 // Ensure that the value and col_idxs arrays have the correct size
385 auto max_num_elems = this->get_common_size()[0] *
386 this->get_common_size()[1] *
387 this->get_num_batch_items();
388 GKO_ASSERT(values_.get_size() <= max_num_elems);
389 GKO_ASSERT_EQ(row_ptrs_.get_size(), this->get_common_size()[0] + 1);
390 GKO_ASSERT_EQ(this->get_num_elements_per_item(), col_idxs_.get_size());
391 }
392
393 void apply_impl(const MultiVector<value_type>* b,
394 MultiVector<value_type>* x) const;
395
396 void apply_impl(const MultiVector<value_type>* alpha,
397 const MultiVector<value_type>* b,
398 const MultiVector<value_type>* beta,
399 MultiVector<value_type>* x) const;
400
401 array<value_type> values_;
402 array<index_type> col_idxs_;
403 array<index_type> row_ptrs_;
404};
405
406
407} // namespace matrix
408} // namespace batch
409} // namespace gko
410
411
412#endif // GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_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 array.hpp:166
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 batch_multi_vector.hpp:59
void scale(const array< value_type > &row_scale, const array< value_type > &col_scale)
Performs in-place row and column scaling for this matrix.
const Csr * apply(ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) const
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_csr.hpp:195
std::unique_ptr< const unbatch_type > create_const_view_for_item(size_type item_id) const
Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<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_csr.hpp:172
Csr * apply(ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x)
Apply the matrix to a multi-vector.
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition batch_csr.hpp:113
const Csr * 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
static std::unique_ptr< Csr > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size, array< value_type > values, array< index_type > col_idxs, array< index_type > row_ptrs)
Creates a Csr matrix from an already allocated (and initialized) array.
const index_type * get_const_row_ptrs() const noexcept
Returns a pointer to the array of row pointers of the matrix.
Definition batch_csr.hpp:160
static std::unique_ptr< const Csr > create_const(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &sizes, gko::detail::const_array_view< value_type > &&values, gko::detail::const_array_view< index_type > &&col_idxs, gko::detail::const_array_view< index_type > &&row_ptrs)
Creates a constant (immutable) batch csr matrix from a constant array.
Csr * 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.
index_type * get_col_idxs() noexcept
Returns a pointer to the array of column indices of the matrix.
Definition batch_csr.hpp:132
const index_type * get_const_col_idxs() const noexcept
Returns a pointer to the array of column indices of the matrix.
Definition batch_csr.hpp:141
size_type get_num_elements_per_item() const noexcept
Returns the number of stored elements in each batch item.
Definition batch_csr.hpp:182
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_csr.hpp:211
static std::unique_ptr< Csr > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{}, size_type num_nonzeros_per_item={})
Creates an uninitialized Csr matrix of the specified size.
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition batch_csr.hpp:122
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.
index_type * get_row_ptrs() noexcept
Returns a pointer to the array of row pointers of the matrix.
Definition batch_csr.hpp:151
std::unique_ptr< unbatch_type > create_view_for_item(size_type item_id)
Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object...
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:121
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