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
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#if GINKGO_ENABLE_HALF
102 public ConvertibleTo<
103 Fbcsr<next_precision<next_precision<ValueType>>, IndexType>>,
104#endif
105 public ConvertibleTo<Dense<ValueType>>,
106 public ConvertibleTo<Csr<ValueType, IndexType>>,
107 public ConvertibleTo<SparsityCsr<ValueType, IndexType>>,
108 public DiagonalExtractable<ValueType>,
109 public ReadableFromMatrixData<ValueType, IndexType>,
110 public WritableToMatrixData<ValueType, IndexType>,
111 public Transposable,
113 remove_complex<Fbcsr<ValueType, IndexType>>> {
114 friend class EnablePolymorphicObject<Fbcsr, LinOp>;
115 friend class Csr<ValueType, IndexType>;
116 friend class Dense<ValueType>;
117 friend class SparsityCsr<ValueType, IndexType>;
118 friend class FbcsrBuilder<ValueType, IndexType>;
119 friend class Fbcsr<to_complex<ValueType>, IndexType>;
120
121public:
122 using value_type = ValueType;
123 using index_type = IndexType;
124 using transposed_type = Fbcsr<ValueType, IndexType>;
125 using mat_data = matrix_data<ValueType, IndexType>;
126 using device_mat_data = device_matrix_data<ValueType, IndexType>;
127 using absolute_type = remove_complex<Fbcsr>;
128
135
140 using EnableLinOp<Fbcsr<ValueType, IndexType>>::convert_to;
141
142 using ConvertibleTo<
143 Fbcsr<next_precision<ValueType>, IndexType>>::convert_to;
144 using ConvertibleTo<Fbcsr<next_precision<ValueType>, IndexType>>::move_to;
145 using ConvertibleTo<Dense<ValueType>>::convert_to;
146 using ConvertibleTo<Dense<ValueType>>::move_to;
147 using ConvertibleTo<Csr<ValueType, IndexType>>::convert_to;
151
152 friend class Fbcsr<previous_precision<ValueType>, IndexType>;
153
154 void convert_to(
155 Fbcsr<next_precision<ValueType>, IndexType>* result) const override;
156
157 void move_to(Fbcsr<next_precision<ValueType>, IndexType>* result) override;
158
159#if GINKGO_ENABLE_HALF
160 friend class Fbcsr<previous_precision<previous_precision<ValueType>>,
161 IndexType>;
163 IndexType>>::convert_to;
164 using ConvertibleTo<
166
167 void convert_to(Fbcsr<next_precision<next_precision<ValueType>>, IndexType>*
168 result) const override;
169
170 void move_to(Fbcsr<next_precision<next_precision<ValueType>>, IndexType>*
171 result) override;
172#endif
173
174 void convert_to(Dense<ValueType>* other) const override;
175
176 void move_to(Dense<ValueType>* other) override;
177
184 void convert_to(Csr<ValueType, IndexType>* result) const override;
185
186 void move_to(Csr<ValueType, IndexType>* result) override;
187
194 void convert_to(SparsityCsr<ValueType, IndexType>* result) const override;
195
196 void move_to(SparsityCsr<ValueType, IndexType>* result) override;
197
204 void read(const mat_data& data) override;
205
206 void read(const device_mat_data& data) override;
207
208 void read(device_mat_data&& data) override;
209
210 void write(mat_data& data) const override;
211
212 std::unique_ptr<LinOp> transpose() const override;
213
214 std::unique_ptr<LinOp> conj_transpose() const override;
215
216 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
217
218 std::unique_ptr<absolute_type> compute_absolute() const override;
219
221
227
235
239 value_type* get_values() noexcept { return values_.get_data(); }
240
248 const value_type* get_const_values() const noexcept
249 {
250 return values_.get_const_data();
251 }
252
256 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
257
265 const index_type* get_const_col_idxs() const noexcept
266 {
267 return col_idxs_.get_const_data();
268 }
269
273 index_type* get_row_ptrs() noexcept { return row_ptrs_.get_data(); }
274
282 const index_type* get_const_row_ptrs() const noexcept
283 {
284 return row_ptrs_.get_const_data();
285 }
286
291 {
292 return values_.get_size();
293 }
294
299 {
300 return col_idxs_.get_size();
301 }
302
306 int get_block_size() const noexcept { return bs_; }
307
311 index_type get_num_block_rows() const noexcept
312 {
313 return this->get_size()[0] / bs_;
314 }
315
319 index_type get_num_block_cols() const noexcept
320 {
321 return this->get_size()[1] / bs_;
322 }
323
333 static std::unique_ptr<Fbcsr> create(std::shared_ptr<const Executor> exec,
334 int block_size = 1);
335
347 static std::unique_ptr<Fbcsr> create(std::shared_ptr<const Executor> exec,
348 const dim<2>& size,
349 size_type num_nonzeros,
350 int block_size);
351
372 static std::unique_ptr<Fbcsr> create(std::shared_ptr<const Executor> exec,
373 const dim<2>& size, int block_size,
374 array<value_type> values,
375 array<index_type> col_idxs,
376 array<index_type> row_ptrs);
377
383 template <typename InputValueType, typename InputColumnIndexType,
384 typename InputRowPtrType>
385 GKO_DEPRECATED(
386 "explicitly construct the gko::array argument instead of passing "
387 "initializer lists")
388 static std::unique_ptr<Fbcsr> create(
389 std::shared_ptr<const Executor> exec, const dim<2>& size,
390 int block_size, std::initializer_list<InputValueType> values,
391 std::initializer_list<InputColumnIndexType> col_idxs,
392 std::initializer_list<InputRowPtrType> row_ptrs)
393 {
394 return create(exec, size, block_size,
395 array<value_type>{exec, std::move(values)},
396 array<index_type>{exec, std::move(col_idxs)},
397 array<index_type>{exec, std::move(row_ptrs)});
398 }
399
414 static std::unique_ptr<const Fbcsr> create_const(
415 std::shared_ptr<const Executor> exec, const dim<2>& size, int blocksize,
416 gko::detail::const_array_view<ValueType>&& values,
417 gko::detail::const_array_view<IndexType>&& col_idxs,
418 gko::detail::const_array_view<IndexType>&& row_ptrs);
419
425
432
436 Fbcsr(const Fbcsr&);
437
444
445protected:
446 Fbcsr(std::shared_ptr<const Executor> exec, int block_size = 1);
447
448 Fbcsr(std::shared_ptr<const Executor> exec, const dim<2>& size,
449 size_type num_nonzeros, int block_size);
450
451 Fbcsr(std::shared_ptr<const Executor> exec, const dim<2>& size,
452 int block_size, array<value_type> values, array<index_type> col_idxs,
453 array<index_type> row_ptrs);
454
455 void apply_impl(const LinOp* b, LinOp* x) const override;
456
457 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
458 LinOp* x) const override;
459
460private:
461 int bs_;
462 array<value_type> values_;
463 array<index_type> col_idxs_;
464 array<index_type> row_ptrs_;
465};
466
467
468} // namespace matrix
469} // namespace gko
470
471
472#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:470
The diagonal of a LinOp implementing this interface can be extracted.
Definition lin_op.hpp:743
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:794
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
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
Definition lin_op.hpp:117
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:210
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:605
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:660
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
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 csr.hpp:121
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:117
Definition fbcsr.hpp:31
Fixed-block compressed sparse row storage matrix format.
Definition fbcsr.hpp:113
size_type get_num_stored_blocks() const noexcept
Definition fbcsr.hpp:298
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
size_type get_num_stored_elements() const noexcept
Definition fbcsr.hpp:290
const value_type * get_const_values() const noexcept
Definition fbcsr.hpp:248
const index_type * get_const_col_idxs() const noexcept
Definition fbcsr.hpp:265
index_type get_num_block_rows() const noexcept
Definition fbcsr.hpp:311
index_type * get_row_ptrs() noexcept
Definition fbcsr.hpp:273
int get_block_size() const noexcept
Definition fbcsr.hpp:306
index_type * get_col_idxs() noexcept
Definition fbcsr.hpp:256
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.
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:239
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:282
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:319
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:56
The matrix namespace.
Definition dense_cache.hpp:15
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 object.
Definition dim.hpp:26
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126