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
fbcsr.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
7
8
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
11#include <ginkgo/core/base/math.hpp>
12
13
14namespace gko {
15namespace matrix {
16
17
18template <typename ValueType>
19class Dense;
20
21template <typename ValueType, typename IndexType>
22class Csr;
23
24template <typename ValueType, typename IndexType>
25class SparsityCsr;
26
27template <typename ValueType, typename IndexType>
28class Fbcsr;
29
30template <typename ValueType, typename IndexType>
32
33
34namespace detail {
35
36
47template <typename IndexType>
48inline IndexType get_num_blocks(const int block_size, const IndexType size)
49{
50 GKO_ASSERT_BLOCK_SIZE_CONFORMANT(size, block_size);
51 return size / block_size;
52}
53
54
55} // namespace detail
56
57
98template <typename ValueType = default_precision, typename IndexType = int32>
99class Fbcsr : public EnableLinOp<Fbcsr<ValueType, IndexType>>,
100 public ConvertibleTo<Fbcsr<next_precision<ValueType>, IndexType>>,
101 public ConvertibleTo<Dense<ValueType>>,
102 public ConvertibleTo<Csr<ValueType, IndexType>>,
103 public ConvertibleTo<SparsityCsr<ValueType, IndexType>>,
104 public DiagonalExtractable<ValueType>,
105 public ReadableFromMatrixData<ValueType, IndexType>,
106 public WritableToMatrixData<ValueType, IndexType>,
107 public Transposable,
109 remove_complex<Fbcsr<ValueType, IndexType>>> {
110 friend class EnablePolymorphicObject<Fbcsr, LinOp>;
111 friend class Csr<ValueType, IndexType>;
112 friend class Dense<ValueType>;
113 friend class SparsityCsr<ValueType, IndexType>;
114 friend class FbcsrBuilder<ValueType, IndexType>;
115 friend class Fbcsr<to_complex<ValueType>, IndexType>;
116
117public:
118 using value_type = ValueType;
119 using index_type = IndexType;
120 using transposed_type = Fbcsr<ValueType, IndexType>;
121 using mat_data = matrix_data<ValueType, IndexType>;
122 using device_mat_data = device_matrix_data<ValueType, IndexType>;
123 using absolute_type = remove_complex<Fbcsr>;
124
130 using EnableLinOp<Fbcsr<ValueType, IndexType>>::move_to;
131
136 using EnableLinOp<Fbcsr<ValueType, IndexType>>::convert_to;
137
138 using ConvertibleTo<
139 Fbcsr<next_precision<ValueType>, IndexType>>::convert_to;
140 using ConvertibleTo<Fbcsr<next_precision<ValueType>, IndexType>>::move_to;
141 using ConvertibleTo<Dense<ValueType>>::convert_to;
142 using ConvertibleTo<Dense<ValueType>>::move_to;
143 using ConvertibleTo<Csr<ValueType, IndexType>>::convert_to;
144 using ConvertibleTo<Csr<ValueType, IndexType>>::move_to;
145 using ConvertibleTo<SparsityCsr<ValueType, IndexType>>::convert_to;
146 using ConvertibleTo<SparsityCsr<ValueType, IndexType>>::move_to;
147
148 friend class Fbcsr<next_precision<ValueType>, IndexType>;
149
150 void convert_to(
151 Fbcsr<next_precision<ValueType>, IndexType>* result) const override;
152
153 void move_to(Fbcsr<next_precision<ValueType>, IndexType>* result) override;
154
155 void convert_to(Dense<ValueType>* other) const override;
156
157 void move_to(Dense<ValueType>* other) override;
158
165 void convert_to(Csr<ValueType, IndexType>* result) const override;
166
167 void move_to(Csr<ValueType, IndexType>* result) override;
168
175 void convert_to(SparsityCsr<ValueType, IndexType>* result) const override;
176
177 void move_to(SparsityCsr<ValueType, IndexType>* result) override;
178
185 void read(const mat_data& data) override;
186
187 void read(const device_mat_data& data) override;
188
189 void read(device_mat_data&& data) override;
190
191 void write(mat_data& data) const override;
192
193 std::unique_ptr<LinOp> transpose() const override;
194
195 std::unique_ptr<LinOp> conj_transpose() const override;
196
197 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
198
199 std::unique_ptr<absolute_type> compute_absolute() const override;
200
202
208
216
220 value_type* get_values() noexcept { return values_.get_data(); }
221
229 const value_type* get_const_values() const noexcept
230 {
231 return values_.get_const_data();
232 }
233
237 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
238
246 const index_type* get_const_col_idxs() const noexcept
247 {
248 return col_idxs_.get_const_data();
249 }
250
254 index_type* get_row_ptrs() noexcept { return row_ptrs_.get_data(); }
255
263 const index_type* get_const_row_ptrs() const noexcept
264 {
265 return row_ptrs_.get_const_data();
266 }
267
272 {
273 return values_.get_size();
274 }
275
280 {
281 return col_idxs_.get_size();
282 }
283
287 int get_block_size() const noexcept { return bs_; }
288
292 index_type get_num_block_rows() const noexcept
293 {
294 return this->get_size()[0] / bs_;
295 }
296
300 index_type get_num_block_cols() const noexcept
301 {
302 return this->get_size()[1] / bs_;
303 }
304
314 static std::unique_ptr<Fbcsr> create(std::shared_ptr<const Executor> exec,
315 int block_size = 1);
316
328 static std::unique_ptr<Fbcsr> create(std::shared_ptr<const Executor> exec,
329 const dim<2>& size,
330 size_type num_nonzeros,
331 int block_size);
332
353 static std::unique_ptr<Fbcsr> create(std::shared_ptr<const Executor> exec,
354 const dim<2>& size, int block_size,
355 array<value_type> values,
356 array<index_type> col_idxs,
357 array<index_type> row_ptrs);
358
364 template <typename InputValueType, typename InputColumnIndexType,
365 typename InputRowPtrType>
366 GKO_DEPRECATED(
367 "explicitly construct the gko::array argument instead of passing "
368 "initializer lists")
369 static std::unique_ptr<Fbcsr> create(
370 std::shared_ptr<const Executor> exec, const dim<2>& size,
371 int block_size, std::initializer_list<InputValueType> values,
372 std::initializer_list<InputColumnIndexType> col_idxs,
373 std::initializer_list<InputRowPtrType> row_ptrs)
374 {
375 return create(exec, size, block_size,
376 array<value_type>{exec, std::move(values)},
377 array<index_type>{exec, std::move(col_idxs)},
378 array<index_type>{exec, std::move(row_ptrs)});
379 }
380
395 static std::unique_ptr<const Fbcsr> create_const(
396 std::shared_ptr<const Executor> exec, const dim<2>& size, int blocksize,
397 gko::detail::const_array_view<ValueType>&& values,
398 gko::detail::const_array_view<IndexType>&& col_idxs,
399 gko::detail::const_array_view<IndexType>&& row_ptrs);
400
406
413
417 Fbcsr(const Fbcsr&);
418
425
426protected:
427 Fbcsr(std::shared_ptr<const Executor> exec, int block_size = 1);
428
429 Fbcsr(std::shared_ptr<const Executor> exec, const dim<2>& size,
430 size_type num_nonzeros, int block_size);
431
432 Fbcsr(std::shared_ptr<const Executor> exec, const dim<2>& size,
433 int block_size, array<value_type> values, array<index_type> col_idxs,
434 array<index_type> row_ptrs);
435
436 void apply_impl(const LinOp* b, LinOp* x) const override;
437
438 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
439 LinOp* x) const override;
440
441private:
442 int bs_;
443 array<value_type> values_;
444 array<index_type> col_idxs_;
445 array<index_type> row_ptrs_;
446};
447
448
449} // namespace matrix
450} // namespace gko
451
452
453#endif // GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:471
The diagonal of a LinOp implementing this interface can be extracted.
Definition lin_op.hpp:744
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:795
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:616
Definition lin_op.hpp:118
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:211
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:606
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:434
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:661
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
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition sparsity_csr.hpp:22
Definition fbcsr.hpp:31
Fixed-block compressed sparse row storage matrix format.
Definition sparsity_csr.hpp:30
void read(device_mat_data &&data) override
Reads a matrix from a device_matrix_data structure.
size_type get_num_stored_blocks() const noexcept
Definition fbcsr.hpp:279
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
void read(const device_mat_data &data) override
Reads a matrix from a device_matrix_data structure.
size_type get_num_stored_elements() const noexcept
Definition fbcsr.hpp:271
const value_type * get_const_values() const noexcept
Definition fbcsr.hpp:229
const index_type * get_const_col_idxs() const noexcept
Definition fbcsr.hpp:246
index_type get_num_block_rows() const noexcept
Definition fbcsr.hpp:292
index_type * get_row_ptrs() noexcept
Definition fbcsr.hpp:254
int get_block_size() const noexcept
Definition fbcsr.hpp:287
index_type * get_col_idxs() noexcept
Definition fbcsr.hpp:237
static std::unique_ptr< Fbcsr > create(std::shared_ptr< const Executor > exec, int block_size=1)
Creates an uninitialized FBCSR matrix with the given block size.
Fbcsr(const Fbcsr &)
Copy-constructs an Ell matrix.
void write(mat_data &data) const override
Writes a matrix to a matrix_data structure.
static std::unique_ptr< const Fbcsr > create_const(std::shared_ptr< const Executor > exec, const dim< 2 > &size, int blocksize, gko::detail::const_array_view< ValueType > &&values, gko::detail::const_array_view< IndexType > &&col_idxs, gko::detail::const_array_view< IndexType > &&row_ptrs)
Creates a constant (immutable) Fbcsr matrix from a constant array.
void compute_absolute_inplace() override
Compute absolute inplace on each element.
static std::unique_ptr< Fbcsr > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_nonzeros, int block_size)
Creates an uninitialized FBCSR matrix of the specified size.
void sort_by_column_index()
Sorts the values blocks and block-column indices in each row by column index.
value_type * get_values() noexcept
Definition fbcsr.hpp:220
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
Fbcsr & operator=(Fbcsr &&)
Move-assigns an Fbcsr matrix.
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
Fbcsr(Fbcsr &&)
Move-constructs an Fbcsr matrix.
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
const index_type * get_const_row_ptrs() const noexcept
Definition fbcsr.hpp:263
Fbcsr & operator=(const Fbcsr &)
Copy-assigns an Fbcsr matrix.
void convert_to(Csr< ValueType, IndexType > *result) const override
Converts the matrix to CSR format.
static std::unique_ptr< Fbcsr > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, int block_size, array< value_type > values, array< index_type > col_idxs, array< index_type > row_ptrs)
Creates a FBCSR matrix from already allocated (and initialized) row pointer, column index and value a...
void read(const mat_data &data) override
Reads a matrix_data into Fbcsr format.
bool is_sorted_by_column_index() const
Tests if all row entry pairs (value, col_idx) are sorted by column index.
index_type get_num_block_cols() const noexcept
Definition fbcsr.hpp:300
void convert_to(SparsityCsr< ValueType, IndexType > *result) const override
Get the block sparsity pattern in CSR-like format.
SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressi...
Definition sparsity_csr.hpp:57
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
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 object.
Definition dim.hpp:27
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:127