5#ifndef GKO_PUBLIC_CORE_MATRIX_SELLP_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_SELLP_HPP_
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
17constexpr int default_slice_size = 64;
18constexpr int default_stride_factor = 1;
21template <
typename ValueType>
24template <
typename ValueType,
typename IndexType>
42template <
typename ValueType = default_precision,
typename IndexType =
int32>
45 public ConvertibleTo<Sellp<next_precision<ValueType>, IndexType>>,
46#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
47 public ConvertibleTo<Sellp<next_precision<ValueType, 2>, IndexType>>,
49#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
50 public ConvertibleTo<Sellp<next_precision<ValueType, 3>, IndexType>>,
58 remove_complex<Sellp<ValueType, IndexType>>> {
60 friend class Dense<ValueType>;
61 friend class Csr<ValueType, IndexType>;
76 using value_type = ValueType;
77 using index_type = IndexType;
89#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
103#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
125 void read(
const mat_data& data)
override;
127 void read(
const device_mat_data& data)
override;
129 void read(device_mat_data&& data)
override;
131 void write(mat_data& data)
const override;
144 value_type*
get_values() noexcept {
return values_.get_data(); }
155 return values_.get_const_data();
174 return col_idxs_.get_const_data();
184 return slice_lengths_.get_data();
196 return slice_lengths_.get_const_data();
215 return slice_sets_.get_const_data();
239 return values_.get_size() / slice_size_;
249 return values_.get_size();
267 return values_.get_data()[this->linearize_index(row, slice_set, idx)];
277 .get_const_data()[this->linearize_index(row, slice_set, idx)];
295 return this->
get_col_idxs()[this->linearize_index(row, slice_set, idx)];
305 ->get_const_col_idxs()[this->linearize_index(row, slice_set, idx)];
318 static std::unique_ptr<Sellp>
create(std::shared_ptr<const Executor> exec,
334 static std::unique_ptr<Sellp>
create(std::shared_ptr<const Executor> exec,
367 Sellp(std::shared_ptr<const Executor> exec,
const dim<2>& size = {},
370 Sellp(std::shared_ptr<const Executor> exec,
const dim<2>& size,
373 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
376 LinOp* x)
const override;
381 return (slice_set + col) * slice_size_ + row;
385 array<value_type> values_;
386 array<index_type> col_idxs_;
387 array<size_type> slice_lengths_;
388 array<size_type> slice_sets_;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:479
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:668
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
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
size_type get_slice_size() const noexcept
Returns the size of a slice.
Definition sellp.hpp:223
value_type & val_at(size_type row, size_type slice_set, size_type idx) noexcept
Returns the idx-th non-zero element of the row-th row with slice_set slice set.
Definition sellp.hpp:264
static std::unique_ptr< Sellp > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type slice_size, size_type stride_factor, size_type total_cols)
Creates an uninitialized Sellp matrix of the specified size.
index_type & col_at(size_type row, size_type slice_set, size_type idx) noexcept
Returns the idx-th column index of the row-th row with slice_set slice set.
Definition sellp.hpp:292
Sellp(const Sellp &)
Copy-assigns a Sellp matrix.
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
value_type * get_values() noexcept
Returns the values of the matrix.
Definition sellp.hpp:144
Sellp & operator=(Sellp &&)
Move-assigns a Sellp matrix.
size_type get_stride_factor() const noexcept
Returns the stride factor(t) of SELL-P.
Definition sellp.hpp:230
const size_type * get_const_slice_sets() const noexcept
Returns the offsets of slices.
Definition sellp.hpp:213
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition sellp.hpp:163
size_type get_total_cols() const noexcept
Returns the total column number.
Definition sellp.hpp:237
index_type col_at(size_type row, size_type slice_set, size_type idx) const noexcept
Returns the idx-th column index of the row-th row with slice_set slice set.
Definition sellp.hpp:301
size_type * get_slice_lengths() noexcept
Returns the lengths(columns) of slices.
Definition sellp.hpp:182
Sellp & operator=(const Sellp &)
Copy-assigns a Sellp matrix.
void compute_absolute_inplace() override
Compute absolute inplace on each element.
static std::unique_ptr< Sellp > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size={}, size_type total_cols=0)
Creates an uninitialized Sellp matrix of the specified size.
size_type * get_slice_sets() noexcept
Returns the offsets of slices.
Definition sellp.hpp:204
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition sellp.hpp:247
value_type val_at(size_type row, size_type slice_set, size_type idx) const noexcept
Returns the idx-th non-zero element of the row-th row with slice_set slice set.
Definition sellp.hpp:273
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition sellp.hpp:172
Sellp(Sellp &&)
Move-assigns a Sellp matrix.
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
const size_type * get_const_slice_lengths() const noexcept
Returns the lengths(columns) of slices.
Definition sellp.hpp:194
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition sellp.hpp:153
The matrix namespace.
Definition dense_cache.hpp:24
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:264
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
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
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
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
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