5#ifndef GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
11#include <ginkgo/core/base/math.hpp>
18template <
typename ValueType>
21template <
typename ValueType,
typename IndexType>
24template <
typename ValueType,
typename IndexType>
27template <
typename ValueType,
typename IndexType>
30template <
typename ValueType,
typename IndexType>
47template <
typename IndexType>
48inline IndexType get_num_blocks(
const int block_size,
const IndexType size)
50 GKO_ASSERT_BLOCK_SIZE_CONFORMANT(size, block_size);
51 return size / block_size;
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
103 Fbcsr<next_precision<next_precision<ValueType>>, IndexType>>,
113 remove_complex<Fbcsr<ValueType, IndexType>>> {
115 friend class Csr<ValueType, IndexType>;
116 friend class Dense<ValueType>;
117 friend class SparsityCsr<ValueType, IndexType>;
118 friend class FbcsrBuilder<ValueType, IndexType>;
122 using value_type = ValueType;
123 using index_type = IndexType;
124 using transposed_type = Fbcsr<ValueType, IndexType>;
134 using EnableLinOp<Fbcsr<ValueType, IndexType>>::move_to;
140 using EnableLinOp<Fbcsr<ValueType, IndexType>>::convert_to;
149 using ConvertibleTo<SparsityCsr<ValueType, IndexType>>::convert_to;
150 using ConvertibleTo<SparsityCsr<ValueType, IndexType>>::move_to;
152 friend class Fbcsr<previous_precision<ValueType>, IndexType>;
159#if GINKGO_ENABLE_HALF
160 friend class Fbcsr<previous_precision<previous_precision<ValueType>>,
163 IndexType>>::convert_to;
168 result)
const override;
174 void convert_to(Dense<ValueType>* other)
const override;
176 void move_to(Dense<ValueType>* other)
override;
333 static std::unique_ptr<Fbcsr>
create(std::shared_ptr<const Executor> exec,
347 static std::unique_ptr<Fbcsr>
create(std::shared_ptr<const Executor> exec,
372 static std::unique_ptr<Fbcsr>
create(std::shared_ptr<const Executor> exec,
373 const dim<2>& size,
int block_size,
383 template <
typename InputValueType,
typename InputColumnIndexType,
384 typename InputRowPtrType>
386 "explicitly construct the gko::array argument instead of passing "
390 int block_size,
std::initializer_list<InputValueType> values,
391 std::initializer_list<InputColumnIndexType> col_idxs,
392 std::initializer_list<InputRowPtrType> row_ptrs)
394 return create(exec, size, block_size,
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);
446 Fbcsr(std::shared_ptr<const Executor> exec,
int block_size = 1);
448 Fbcsr(std::shared_ptr<const Executor> exec,
const dim<2>& size,
451 Fbcsr(std::shared_ptr<const Executor> exec,
const dim<2>& size,
455 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
458 LinOp* x)
const override;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:470
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 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
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:21
Fixed-block compressed sparse row storage matrix format.
Definition sparsity_csr.hpp:29
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:298
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: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.
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: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 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
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