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
ell.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_MATRIX_ELL_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_ELL_HPP_
7
8
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
11
12
13namespace gko {
14namespace matrix {
15
16
17template <typename ValueType>
18class Dense;
19
20template <typename ValueType, typename IndexType>
21class Coo;
22
23template <typename ValueType, typename IndexType>
24class Csr;
25
26template <typename ValueType, typename IndexType>
27class Hybrid;
28
29
51template <typename ValueType = default_precision, typename IndexType = int32>
52class Ell : public EnableLinOp<Ell<ValueType, IndexType>>,
53 public ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>,
54#if GINKGO_ENABLE_HALF
55 public ConvertibleTo<
56 Ell<next_precision<next_precision<ValueType>>, IndexType>>,
57#endif
58 public ConvertibleTo<Dense<ValueType>>,
59 public ConvertibleTo<Csr<ValueType, IndexType>>,
60 public DiagonalExtractable<ValueType>,
61 public ReadableFromMatrixData<ValueType, IndexType>,
62 public WritableToMatrixData<ValueType, IndexType>,
64 remove_complex<Ell<ValueType, IndexType>>> {
65 friend class EnablePolymorphicObject<Ell, LinOp>;
66 friend class Dense<ValueType>;
67 friend class Coo<ValueType, IndexType>;
68 friend class Csr<ValueType, IndexType>;
69 friend class Ell<to_complex<ValueType>, IndexType>;
70 friend class Ell<previous_precision<ValueType>, IndexType>;
71 friend class Hybrid<ValueType, IndexType>;
72
73public:
74 using EnableLinOp<Ell>::convert_to;
75 using EnableLinOp<Ell>::move_to;
76 using ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>::convert_to;
77 using ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>::move_to;
78 using ConvertibleTo<Dense<ValueType>>::convert_to;
79 using ConvertibleTo<Dense<ValueType>>::move_to;
82 using ReadableFromMatrixData<ValueType, IndexType>::read;
83
84 using value_type = ValueType;
85 using index_type = IndexType;
88 using absolute_type = remove_complex<Ell>;
89
90 void convert_to(
91 Ell<next_precision<ValueType>, IndexType>* result) const override;
92
93 void move_to(Ell<next_precision<ValueType>, IndexType>* result) override;
94
95#if GINKGO_ENABLE_HALF
96 friend class Ell<previous_precision<previous_precision<ValueType>>,
97 IndexType>;
98 using ConvertibleTo<
99 Ell<next_precision<next_precision<ValueType>>, IndexType>>::convert_to;
100 using ConvertibleTo<
102
103 void convert_to(Ell<next_precision<next_precision<ValueType>>, IndexType>*
104 result) const override;
105
106 void move_to(Ell<next_precision<next_precision<ValueType>>, IndexType>*
107 result) override;
108#endif
109
110 void convert_to(Dense<ValueType>* other) const override;
111
112 void move_to(Dense<ValueType>* other) override;
113
114 void convert_to(Csr<ValueType, IndexType>* other) const override;
115
116 void move_to(Csr<ValueType, IndexType>* other) override;
117
118 void read(const mat_data& data) override;
119
120 void read(const device_mat_data& data) override;
121
122 void read(device_mat_data&& data) override;
123
124 void write(mat_data& data) const override;
125
126 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
127
128 std::unique_ptr<absolute_type> compute_absolute() const override;
129
131
137 value_type* get_values() noexcept { return values_.get_data(); }
138
146 const value_type* get_const_values() const noexcept
147 {
148 return values_.get_const_data();
149 }
150
156 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
157
165 const index_type* get_const_col_idxs() const noexcept
166 {
167 return col_idxs_.get_const_data();
168 }
169
176 {
177 return num_stored_elements_per_row_;
178 }
179
185 size_type get_stride() const noexcept { return stride_; }
186
193 {
194 return values_.get_size();
195 }
196
207 value_type& val_at(size_type row, size_type idx) noexcept
208 {
209 return values_.get_data()[this->linearize_index(row, idx)];
210 }
211
215 value_type val_at(size_type row, size_type idx) const noexcept
216 {
217 return values_.get_const_data()[this->linearize_index(row, idx)];
218 }
219
230 index_type& col_at(size_type row, size_type idx) noexcept
231 {
232 return this->get_col_idxs()[this->linearize_index(row, idx)];
233 }
234
238 index_type col_at(size_type row, size_type idx) const noexcept
239 {
240 return this->get_const_col_idxs()[this->linearize_index(row, idx)];
241 }
242
254 static std::unique_ptr<Ell> create(
255 std::shared_ptr<const Executor> exec, const dim<2>& size = {},
256 size_type num_stored_elements_per_row = 0, size_type stride = 0);
257
277 static std::unique_ptr<Ell> create(std::shared_ptr<const Executor> exec,
278 const dim<2>& size,
279 array<value_type> values,
280 array<index_type> col_idxs,
281 size_type num_stored_elements_per_row,
282 size_type stride);
283
289 template <typename InputValueType, typename InputColumnIndexType>
290 GKO_DEPRECATED(
291 "explicitly construct the gko::array argument instead of passing "
292 "initializer lists")
293 static std::unique_ptr<Ell> create(
294 std::shared_ptr<const Executor> exec, const dim<2>& size,
295 std::initializer_list<InputValueType> values,
296 std::initializer_list<InputColumnIndexType> col_idxs,
297 size_type num_stored_elements_per_row, size_type stride)
298 {
299 return create(exec, size, array<value_type>{exec, std::move(values)},
300 array<index_type>{exec, std::move(col_idxs)},
301 num_stored_elements_per_row, stride);
302 }
303
317 static std::unique_ptr<const Ell> create_const(
318 std::shared_ptr<const Executor> exec, const dim<2>& size,
319 gko::detail::const_array_view<ValueType>&& values,
320 gko::detail::const_array_view<IndexType>&& col_idxs,
321 size_type num_stored_elements_per_row, size_type stride);
322
328 Ell& operator=(const Ell&);
329
336
341 Ell(const Ell&);
342
348
349protected:
350 Ell(std::shared_ptr<const Executor> exec, const dim<2>& size = {},
351 size_type num_stored_elements_per_row = 0, size_type stride = 0);
352
353 Ell(std::shared_ptr<const Executor> exec, const dim<2>& size,
354 array<value_type> values, array<index_type> col_idxs,
355 size_type num_stored_elements_per_row, size_type stride);
356
366 void resize(dim<2> new_size, size_type max_row_nnz);
367
368 void apply_impl(const LinOp* b, LinOp* x) const override;
369
370 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
371 LinOp* x) const override;
372
373 size_type linearize_index(size_type row, size_type col) const noexcept
374 {
375 return row + stride_ * col;
376 }
377
378private:
379 size_type num_stored_elements_per_row_;
380 size_type stride_;
381 array<value_type> values_;
382 array<index_type> col_idxs_;
383};
384
385
386} // namespace matrix
387} // namespace gko
388
389
390#endif // GKO_PUBLIC_CORE_MATRIX_ELL_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
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:605
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
COO stores a matrix in the coordinate matrix format.
Definition ell.hpp:21
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition sparsity_csr.hpp:21
Dense is a matrix format which explicitly stores all values of the matrix.
Definition sparsity_csr.hpp:25
ELL is a matrix format where stride with explicit zeros is used such that all rows have the same numb...
Definition ell.hpp:64
value_type & val_at(size_type row, size_type idx) noexcept
Returns the idx-th non-zero element of the row-th row .
Definition ell.hpp:207
size_type get_num_stored_elements_per_row() const noexcept
Returns the number of stored elements per row.
Definition ell.hpp:175
size_type get_stride() const noexcept
Returns the stride of the matrix.
Definition ell.hpp:185
static std::unique_ptr< Ell > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size={}, size_type num_stored_elements_per_row=0, size_type stride=0)
Creates an uninitialized Ell matrix of the specified size.
index_type col_at(size_type row, size_type idx) const noexcept
Returns the idx-th column index of the row-th row .
Definition ell.hpp:238
value_type * get_values() noexcept
Returns the values of the matrix.
Definition ell.hpp:137
value_type val_at(size_type row, size_type idx) const noexcept
Returns the idx-th non-zero element of the row-th row .
Definition ell.hpp:215
Ell & operator=(Ell &&)
Move-assigns an Ell matrix.
void compute_absolute_inplace() override
Compute absolute inplace on each element.
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition ell.hpp:156
Ell(Ell &&)
Move-constructs an Ell matrix.
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
Ell(const Ell &)
Copy-constructs an Ell matrix.
static std::unique_ptr< Ell > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, array< value_type > values, array< index_type > col_idxs, size_type num_stored_elements_per_row, size_type stride)
Creates an ELL matrix from already allocated (and initialized) column index and value arrays.
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition ell.hpp:165
static std::unique_ptr< const Ell > create_const(std::shared_ptr< const Executor > exec, const dim< 2 > &size, gko::detail::const_array_view< ValueType > &&values, gko::detail::const_array_view< IndexType > &&col_idxs, size_type num_stored_elements_per_row, size_type stride)
Creates a constant (immutable) Ell matrix from a set of constant arrays.
Ell & operator=(const Ell &)
Copy-assigns an Ell matrix.
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition ell.hpp:146
index_type & col_at(size_type row, size_type idx) noexcept
Returns the idx-th column index of the row-th row .
Definition ell.hpp:230
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition ell.hpp:192
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:55
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
std::unique_ptr< MatrixType > read(StreamType &&is, MatrixArgs &&... args)
Reads a matrix stored in matrix market format from an input stream.
Definition mtx_io.hpp:159
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