5#ifndef GKO_PUBLIC_CORE_MATRIX_SPARSITY_CSR_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_SPARSITY_CSR_HPP_
11#include <ginkgo/core/base/array.hpp>
12#include <ginkgo/core/base/lin_op.hpp>
13#include <ginkgo/core/base/polymorphic_object.hpp>
20template <
typename ValueType,
typename IndexType>
24template <
typename ValueType>
28template <
typename ValueType,
typename IndexType>
50template <
typename ValueType = default_precision,
typename IndexType =
int32>
58 friend class Csr<ValueType, IndexType>;
59 friend class Dense<ValueType>;
60 friend class Fbcsr<ValueType, IndexType>;
71 using value_type = ValueType;
72 using index_type = IndexType;
85 void read(
const mat_data& data)
override;
87 void read(
const device_mat_data& data)
override;
89 void read(device_mat_data&& data)
override;
91 void write(mat_data& data)
const override;
118 bool is_sorted_by_column_index()
const;
136 return col_idxs_.get_const_data();
155 return row_ptrs_.get_const_data();
163 value_type*
get_value() noexcept {
return value_.get_data(); }
174 return value_.get_const_data();
191 static std::unique_ptr<SparsityCsr>
create(
192 std::shared_ptr<const Executor> exec,
const dim<2>& size =
dim<2>{},
214 static std::unique_ptr<SparsityCsr>
create(
215 std::shared_ptr<const Executor> exec,
const dim<2>& size,
224 template <
typename ColIndexType,
typename RowPtrType>
226 "explicitly construct the gko::array argument instead of passing "
230 std::initializer_list<ColIndexType> col_idxs,
231 std::initializer_list<RowPtrType> row_ptrs,
232 value_type value =
one<ValueType>())
245 static std::unique_ptr<SparsityCsr>
create(
246 std::shared_ptr<const Executor> exec,
247 std::shared_ptr<const LinOp>
matrix);
263 std::shared_ptr<const Executor> exec,
const dim<2>& size,
264 gko::detail::const_array_view<IndexType>&& col_idxs,
265 gko::detail::const_array_view<IndexType>&& row_ptrs,
270 return std::unique_ptr<const SparsityCsr>(
new SparsityCsr{
271 exec, size, gko::detail::array_const_cast(std::move(col_idxs)),
272 gko::detail::array_const_cast(std::move(row_ptrs)), value});
310 std::shared_ptr<const LinOp>
matrix);
312 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
315 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:479
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:668
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
Definition lin_op.hpp:117
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:126
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
Fixed-block compressed sparse row storage matrix format.
Definition fbcsr.hpp:116
static std::unique_ptr< SparsityCsr > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, array< index_type > col_idxs, array< index_type > row_ptrs, value_type value=one< ValueType >())
Creates a SparsityCsr matrix from already allocated (and initialized) row pointer and column index ar...
std::unique_ptr< SparsityCsr > to_adjacency_matrix() const
Transforms the sparsity matrix to an adjacency matrix.
SparsityCsr & operator=(SparsityCsr &&)
Move-assigns a SparsityCsr matrix.
SparsityCsr & operator=(const SparsityCsr &)
Copy-assigns a SparsityCsr matrix.
index_type * get_col_idxs() noexcept
Returns the column indices of the matrix.
Definition sparsity_csr.hpp:125
SparsityCsr(SparsityCsr &&)
Move-constructs a SparsityCsr matrix.
SparsityCsr(const SparsityCsr &)
Copy-constructs a SparsityCsr matrix.
const index_type * get_const_col_idxs() const noexcept
Returns the column indices of the matrix.
Definition sparsity_csr.hpp:134
const index_type * get_const_row_ptrs() const noexcept
Returns the row pointers of the matrix.
Definition sparsity_csr.hpp:153
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
size_type get_num_nonzeros() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition sparsity_csr.hpp:182
const value_type * get_const_value() const noexcept
Returns the value stored in the matrix.
Definition sparsity_csr.hpp:172
index_type * get_row_ptrs() noexcept
Returns the row pointers of the matrix.
Definition sparsity_csr.hpp:144
static std::unique_ptr< SparsityCsr > create(std::shared_ptr< const Executor > exec, std::shared_ptr< const LinOp > matrix)
Creates a Sparsity matrix from an existing matrix.
void sort_by_column_index()
Sorts each row by column index.
static std::unique_ptr< SparsityCsr > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size=dim< 2 >{}, size_type num_nonzeros={})
Creates an uninitialized SparsityCsr matrix of the specified size.
static std::unique_ptr< const SparsityCsr > create_const(std::shared_ptr< const Executor > exec, const dim< 2 > &size, gko::detail::const_array_view< IndexType > &&col_idxs, gko::detail::const_array_view< IndexType > &&row_ptrs, ValueType value=one< ValueType >())
Creates a constant (immutable) SparsityCsr matrix from constant arrays.
Definition sparsity_csr.hpp:262
value_type * get_value() noexcept
Returns the value stored in the matrix.
Definition sparsity_csr.hpp:163
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
The matrix namespace.
Definition dense_cache.hpp:24
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:654
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
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