5#ifndef GKO_PUBLIC_CORE_MATRIX_ELL_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_ELL_HPP_
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
17template <
typename ValueType>
20template <
typename ValueType,
typename IndexType>
23template <
typename ValueType,
typename IndexType>
26template <
typename ValueType,
typename IndexType>
51template <
typename ValueType = default_precision,
typename IndexType =
int32>
53 public ConvertibleTo<Ell<next_precision<ValueType>, IndexType>>,
56 Ell<next_precision<next_precision<ValueType>>, IndexType>>,
64 remove_complex<Ell<ValueType, IndexType>>> {
66 friend class Dense<ValueType>;
67 friend class Coo<ValueType, IndexType>;
68 friend class Csr<ValueType, IndexType>;
70 friend class Ell<previous_precision<ValueType>, IndexType>;
71 friend class Hybrid<ValueType, IndexType>;
84 using value_type = ValueType;
85 using index_type = IndexType;
96 friend class Ell<previous_precision<previous_precision<ValueType>>,
104 result)
const override;
118 void read(
const mat_data& data)
override;
120 void read(
const device_mat_data& data)
override;
122 void read(device_mat_data&& data)
override;
124 void write(mat_data& data)
const override;
137 value_type*
get_values() noexcept {
return values_.get_data(); }
148 return values_.get_const_data();
167 return col_idxs_.get_const_data();
177 return num_stored_elements_per_row_;
194 return values_.get_size();
209 return values_.get_data()[this->linearize_index(row, idx)];
217 return values_.get_const_data()[this->linearize_index(row, idx)];
232 return this->
get_col_idxs()[this->linearize_index(row, idx)];
255 std::shared_ptr<const Executor> exec,
const dim<2>& size = {},
277 static std::unique_ptr<Ell>
create(std::shared_ptr<const Executor> exec,
289 template <
typename InputValueType,
typename InputColumnIndexType>
291 "explicitly construct the gko::array argument instead of passing "
295 std::initializer_list<InputValueType> values,
296 std::initializer_list<InputColumnIndexType> col_idxs,
301 num_stored_elements_per_row, stride);
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,
350 Ell(std::shared_ptr<const Executor> exec,
const dim<2>& size = {},
353 Ell(std::shared_ptr<const Executor> exec,
const dim<2>& size,
368 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
371 LinOp* x)
const override;
375 return row + stride_ * col;
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
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 array.hpp:166
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 coo.hpp:62
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:121
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:117
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 matrix namespace.
Definition dense_cache.hpp:15
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