33#ifndef GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
34#define GKO_PUBLIC_CORE_MATRIX_FBCSR_HPP_
37#include <ginkgo/core/base/array.hpp>
38#include <ginkgo/core/base/lin_op.hpp>
39#include <ginkgo/core/base/math.hpp>
46template <
typename ValueType>
49template <
typename ValueType,
typename IndexType>
52template <
typename ValueType,
typename IndexType>
55template <
typename ValueType,
typename IndexType>
58template <
typename ValueType,
typename IndexType>
75template <
typename IndexType>
76inline IndexType get_num_blocks(
const int block_size,
const IndexType size)
78 GKO_ASSERT_BLOCK_SIZE_CONFORMANT(size,
block_size);
126template <
typename ValueType = default_precision,
typename IndexType =
int32>
129 public ConvertibleTo<Fbcsr<next_precision<ValueType>, IndexType>>,
138 remove_complex<Fbcsr<ValueType, IndexType>>> {
141 friend class Csr<ValueType, IndexType>;
142 friend class Dense<ValueType>;
148 using value_type = ValueType;
149 using index_type = IndexType;
324 return this->get_size()[0] / bs_;
332 return this->get_size()[1] / bs_;
349 std::shared_ptr<const Executor> exec,
const dim<2>& size,
int blocksize,
350 gko::detail::const_array_view<ValueType>&& values,
351 gko::detail::const_array_view<IndexType>&& col_idxs,
352 gko::detail::const_array_view<IndexType>&&
row_ptrs)
356 return std::unique_ptr<const Fbcsr>(
358 gko::detail::array_const_cast(std::move(values)),
359 gko::detail::array_const_cast(std::move(col_idxs)),
360 gko::detail::array_const_cast(std::move(
row_ptrs))});
409 Fbcsr(std::shared_ptr<const Executor> exec,
const dim<2>& size,
411 : EnableLinOp<
Fbcsr>(exec, size),
416 row_ptrs_(exec, detail::get_num_blocks(
block_size, size[0]) + 1)
418 GKO_ASSERT_BLOCK_SIZE_CONFORMANT(size[1], bs_);
445 Fbcsr(std::shared_ptr<const Executor> exec,
const dim<2>& size,
448 : EnableLinOp<
Fbcsr>(exec, size),
456 GKO_ASSERT_EQ(this->get_size()[0] / bs_ + 1, row_ptrs_.
get_num_elems());
459 void apply_impl(
const LinOp* b, LinOp* x)
const override;
461 void apply_impl(
const LinOp* alpha,
const LinOp* b,
const LinOp* beta,
462 LinOp* x)
const override;
466 array<value_type> values_;
467 array<index_type> col_idxs_;
468 array<index_type> row_ptrs_;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:499
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:823
This mixin implements a static create() method on ConcreteType that dynamically allocates the memory,...
Definition polymorphic_object.hpp:776
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:634
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:462
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:689
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition array.hpp:646
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:655
void fill(const value_type value)
Fill the array with the given value.
size_type get_num_elems() const noexcept
Returns the number of elements in the array.
Definition array.hpp:637
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:63
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:146
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:136
Fixed-block compressed sparse row storage matrix format.
Definition fbcsr.hpp:138
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:309
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:301
const value_type * get_const_values() const noexcept
Definition fbcsr.hpp:259
const index_type * get_const_col_idxs() const noexcept
Definition fbcsr.hpp:276
index_type get_num_block_rows() const noexcept
Definition fbcsr.hpp:322
index_type * get_row_ptrs() noexcept
Definition fbcsr.hpp:284
int get_block_size() const noexcept
Definition fbcsr.hpp:317
index_type * get_col_idxs() noexcept
Definition fbcsr.hpp:267
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.
Definition fbcsr.hpp:348
void compute_absolute_inplace() override
Compute absolute inplace on each element.
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:250
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:293
Fbcsr & operator=(const Fbcsr &)
Copy-assigns an Fbcsr matrix.
void convert_to(Csr< ValueType, IndexType > *result) const override
Converts the matrix to CSR format.
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:330
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:87
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
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:354
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list.
Definition math.hpp:490
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:373
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:55
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:155