Ginkgo: ginkgo/core/matrix/ell.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
ell.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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>
52 class Ell : public EnableLinOp<Ell<ValueType, IndexType>>,
53 public ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>,
54#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
55 public ConvertibleTo<Ell<next_precision<ValueType, 2>, IndexType>>,
56#endif
57#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
58 public ConvertibleTo<Ell<next_precision<ValueType, 3>, IndexType>>,
59#endif
60 public ConvertibleTo<Dense<ValueType>>,
61 public ConvertibleTo<Csr<ValueType, IndexType>>,
62 public DiagonalExtractable<ValueType>,
63 public ReadableFromMatrixData<ValueType, IndexType>,
64 public WritableToMatrixData<ValueType, IndexType>,
65 public EnableAbsoluteComputation<
66 remove_complex<Ell<ValueType, IndexType>>> {
67 friend class EnablePolymorphicObject<Ell, LinOp>;
68 friend class Dense<ValueType>;
69 friend class Coo<ValueType, IndexType>;
70 friend class Csr<ValueType, IndexType>;
71 friend class Ell<to_complex<ValueType>, IndexType>;
72 friend class Ell<previous_precision<ValueType>, IndexType>;
73 friend class Hybrid<ValueType, IndexType>;
74 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
75
76public:
77 using EnableLinOp<Ell>::convert_to;
78 using EnableLinOp<Ell>::move_to;
79 using ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>::convert_to;
80 using ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>::move_to;
81 using ConvertibleTo<Dense<ValueType>>::convert_to;
82 using ConvertibleTo<Dense<ValueType>>::move_to;
83 using ConvertibleTo<Csr<ValueType, IndexType>>::convert_to;
84 using ConvertibleTo<Csr<ValueType, IndexType>>::move_to;
85 using ReadableFromMatrixData<ValueType, IndexType>::read;
86
87 using value_type = ValueType;
88 using index_type = IndexType;
89 using mat_data = matrix_data<ValueType, IndexType>;
90 using device_mat_data = device_matrix_data<ValueType, IndexType>;
91 using absolute_type = remove_complex<Ell>;
92
93 void convert_to(
94 Ell<next_precision<ValueType>, IndexType>* result) const override;
95
96 void move_to(Ell<next_precision<ValueType>, IndexType>* result) override;
97
98#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
99 friend class Ell<previous_precision<ValueType, 2>, IndexType>;
100 using ConvertibleTo<
101 Ell<next_precision<ValueType, 2>, IndexType>>::convert_to;
102 using ConvertibleTo<Ell<next_precision<ValueType, 2>, IndexType>>::move_to;
103
104 void convert_to(
105 Ell<next_precision<ValueType, 2>, IndexType>* result) const override;
106
107 void move_to(Ell<next_precision<ValueType, 2>, IndexType>* result) override;
108#endif
109
110#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
111 friend class Ell<previous_precision<ValueType, 3>, IndexType>;
112 using ConvertibleTo<
113 Ell<next_precision<ValueType, 3>, IndexType>>::convert_to;
114 using ConvertibleTo<Ell<next_precision<ValueType, 3>, IndexType>>::move_to;
115
116 void convert_to(
117 Ell<next_precision<ValueType, 3>, IndexType>* result) const override;
118
119 void move_to(Ell<next_precision<ValueType, 3>, IndexType>* result) override;
120#endif
121
122 void convert_to(Dense<ValueType>* other) const override;
123
124 void move_to(Dense<ValueType>* other) override;
125
126 void convert_to(Csr<ValueType, IndexType>* other) const override;
127
128 void move_to(Csr<ValueType, IndexType>* other) override;
129
130 void read(const mat_data& data) override;
131
132 void read(const device_mat_data& data) override;
133
134 void read(device_mat_data&& data) override;
135
136 void write(mat_data& data) const override;
137
138 std::unique_ptr<Diagonal<ValueType>> extract_diagonal() const override;
139
140 std::unique_ptr<absolute_type> compute_absolute() const override;
141
142 void compute_absolute_inplace() override;
143
149 value_type* get_values() noexcept { return values_.get_data(); }
150
158 const value_type* get_const_values() const noexcept
159 {
160 return values_.get_const_data();
161 }
162
168 index_type* get_col_idxs() noexcept { return col_idxs_.get_data(); }
169
177 const index_type* get_const_col_idxs() const noexcept
178 {
179 return col_idxs_.get_const_data();
180 }
181
187 size_type get_num_stored_elements_per_row() const noexcept
188 {
189 return num_stored_elements_per_row_;
190 }
191
197 size_type get_stride() const noexcept { return stride_; }
198
204 size_type get_num_stored_elements() const noexcept
205 {
206 return values_.get_size();
207 }
208
219 value_type& val_at(size_type row, size_type idx) noexcept
220 {
221 return values_.get_data()[this->linearize_index(row, idx)];
222 }
223
227 value_type val_at(size_type row, size_type idx) const noexcept
228 {
229 return values_.get_const_data()[this->linearize_index(row, idx)];
230 }
231
242 index_type& col_at(size_type row, size_type idx) noexcept
243 {
244 return this->get_col_idxs()[this->linearize_index(row, idx)];
245 }
246
250 index_type col_at(size_type row, size_type idx) const noexcept
251 {
252 return this->get_const_col_idxs()[this->linearize_index(row, idx)];
253 }
254
266 static std::unique_ptr<Ell> create(
267 std::shared_ptr<const Executor> exec, const dim<2>& size = {},
268 size_type num_stored_elements_per_row = 0, size_type stride = 0);
269
289 static std::unique_ptr<Ell> create(std::shared_ptr<const Executor> exec,
290 const dim<2>& size,
291 array<value_type> values,
292 array<index_type> col_idxs,
293 size_type num_stored_elements_per_row,
294 size_type stride);
295
301 template <typename InputValueType, typename InputColumnIndexType>
302 GKO_DEPRECATED(
303 "explicitly construct the gko::array argument instead of passing "
304 "initializer lists")
305 static std::unique_ptr<Ell> create(
306 std::shared_ptr<const Executor> exec, const dim<2>& size,
307 std::initializer_list<InputValueType> values,
308 std::initializer_list<InputColumnIndexType> col_idxs,
309 size_type num_stored_elements_per_row, size_type stride)
310 {
311 return create(exec, size, array<value_type>{exec, std::move(values)},
312 array<index_type>{exec, std::move(col_idxs)},
313 num_stored_elements_per_row, stride);
314 }
315
329 static std::unique_ptr<const Ell> create_const(
330 std::shared_ptr<const Executor> exec, const dim<2>& size,
331 gko::detail::const_array_view<ValueType>&& values,
332 gko::detail::const_array_view<IndexType>&& col_idxs,
333 size_type num_stored_elements_per_row, size_type stride);
334
340 Ell& operator=(const Ell&);
341
347 Ell& operator=(Ell&&);
348
353 Ell(const Ell&);
354
359 Ell(Ell&&);
360
361protected:
362 Ell(std::shared_ptr<const Executor> exec, const dim<2>& size = {},
363 size_type num_stored_elements_per_row = 0, size_type stride = 0);
364
365 Ell(std::shared_ptr<const Executor> exec, const dim<2>& size,
366 array<value_type> values, array<index_type> col_idxs,
367 size_type num_stored_elements_per_row, size_type stride);
368
378 void resize(dim<2> new_size, size_type max_row_nnz);
379
380 void apply_impl(const LinOp* b, LinOp* x) const override;
381
382 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
383 LinOp* x) const override;
384
385 size_type linearize_index(size_type row, size_type col) const noexcept
386 {
387 return row + stride_ * col;
388 }
389
390private:
391 size_type num_stored_elements_per_row_;
392 size_type stride_;
393 array<value_type> values_;
394 array<index_type> col_idxs_;
395};
396
397
398} // namespace matrix
399} // namespace gko
400
401
402#endif // GKO_PUBLIC_CORE_MATRIX_ELL_HPP_
gko::DiagonalExtractable
The diagonal of a LinOp implementing this interface can be extracted.
Definition lin_op.hpp:743
gko::EnableAbsoluteComputation
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:794
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::Executor
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
gko::LinOp
Definition lin_op.hpp:117
gko::ReadableFromMatrixData
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:605
gko::WritableToMatrixData
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:660
gko::array
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
gko::device_matrix_data
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
gko::matrix::Coo
COO stores a matrix in the coordinate matrix format.
Definition coo.hpp:65
gko::matrix::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
gko::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
gko::matrix::Ell::val_at
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:219
gko::matrix::Ell::get_num_stored_elements_per_row
size_type get_num_stored_elements_per_row() const noexcept
Returns the number of stored elements per row.
Definition ell.hpp:187
gko::matrix::Ell::get_stride
size_type get_stride() const noexcept
Returns the stride of the matrix.
Definition ell.hpp:197
gko::matrix::Ell::create
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.
gko::matrix::Ell::col_at
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:250
gko::matrix::Ell::get_values
value_type * get_values() noexcept
Returns the values of the matrix.
Definition ell.hpp:149
gko::matrix::Ell::val_at
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:227
gko::matrix::Ell::operator=
Ell & operator=(Ell &&)
Move-assigns an Ell matrix.
gko::matrix::Ell::compute_absolute_inplace
void compute_absolute_inplace() override
Compute absolute inplace on each element.
gko::matrix::Ell::extract_diagonal
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
gko::matrix::Ell::get_col_idxs
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition ell.hpp:168
gko::matrix::Ell::Ell
Ell(Ell &&)
Move-constructs an Ell matrix.
gko::matrix::Ell::compute_absolute
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
gko::matrix::Ell::Ell
Ell(const Ell &)
Copy-constructs an Ell matrix.
gko::matrix::Ell::create
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.
gko::matrix::Ell::get_const_col_idxs
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition ell.hpp:177
gko::matrix::Ell::create_const
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.
gko::matrix::Ell::operator=
Ell & operator=(const Ell &)
Copy-assigns an Ell matrix.
gko::matrix::Ell::get_const_values
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition ell.hpp:158
gko::matrix::Ell::col_at
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:242
gko::matrix::Ell::get_num_stored_elements
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition ell.hpp:204
gko::matrix::Hybrid
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:57
gko::matrix
The matrix namespace.
Definition dense_cache.hpp:24
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::remove_complex
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:264
gko::to_complex
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:283
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
gko::previous_precision
typename detail::find_precision_impl< T, -step >::type previous_precision
Obtains the previous move type of T in the singly-linked precision corresponding bfloat16/half.
Definition math.hpp:473
gko::next_precision
typename detail::find_precision_impl< T, step >::type next_precision
Obtains the next move type of T in the singly-linked precision corresponding bfloat16/half.
Definition math.hpp:466
std
STL namespace.
gko::dim
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:26
gko::matrix_data
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126