5#ifndef GKO_PUBLIC_CORE_MATRIX_COO_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_COO_HPP_
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
22template <
typename ValueType,
typename IndexType>
25template <
typename ValueType>
28template <
typename ValueType,
typename IndexType>
31template <
typename ValueType,
typename IndexType>
49template <
typename ValueType = default_precision,
typename IndexType =
int32>
51 public ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>,
52#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
53 public ConvertibleTo<Coo<next_precision<ValueType, 2>, IndexType>>,
55#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
56 public ConvertibleTo<Coo<next_precision<ValueType, 3>, IndexType>>,
65 remove_complex<Coo<ValueType, IndexType>>> {
67 friend class Csr<ValueType, IndexType>;
68 friend class Dense<ValueType>;
70 friend class Coo<
to_complex<ValueType>, IndexType>;
71 friend class Hybrid<ValueType, IndexType>;
76 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::convert_to;
77 using ConvertibleTo<Coo<next_precision<ValueType>, IndexType>>::move_to;
84 using value_type = ValueType;
85 using index_type = IndexType;
86 using transposed_type = Coo<ValueType, IndexType>;
98#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
101 Coo<next_precision<ValueType, 2>, IndexType>>::convert_to;
102 using ConvertibleTo<Coo<next_precision<ValueType, 2>, IndexType>>::move_to;
110#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
113 Coo<next_precision<ValueType, 3>, IndexType>>::convert_to;
114 using ConvertibleTo<Coo<next_precision<ValueType, 3>, IndexType>>::move_to;
130 void read(
const mat_data& data)
override;
132 void read(
const device_mat_data& data)
override;
134 void read(device_mat_data&& data)
override;
136 void write(mat_data& data)
const override;
153 value_type*
get_values() noexcept {
return values_.get_data(); }
164 return values_.get_const_data();
183 return col_idxs_.get_const_data();
202 return row_idxs_.get_const_data();
212 return values_.get_size();
259 static std::unique_ptr<Coo>
create(std::shared_ptr<const Executor> exec,
283 static std::unique_ptr<Coo>
create(std::shared_ptr<const Executor> exec,
293 template <
typename InputValueType,
typename InputColumnIndexType,
294 typename InputRowIndexType>
296 "explicitly construct the gko::array argument instead of passing "
300 std::initializer_list<InputValueType> values,
301 std::initializer_list<InputColumnIndexType> col_idxs,
302 std::initializer_list<InputRowIndexType> row_idxs)
323 std::shared_ptr<const Executor> exec,
const dim<2>& size,
324 gko::detail::const_array_view<ValueType>&& values,
325 gko::detail::const_array_view<IndexType>&& col_idxs,
326 gko::detail::const_array_view<IndexType>&& row_idxs);
329 Coo(std::shared_ptr<const Executor> exec,
const dim<2>& size =
dim<2>{},
332 Coo(std::shared_ptr<const Executor> exec,
const dim<2>& size,
345 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
348 LinOp* x)
const override;
350 void apply2_impl(
const LinOp* b,
LinOp* x)
const;
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
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
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:172
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition coo.hpp:181
static std::unique_ptr< const Coo > 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, gko::detail::const_array_view< IndexType > &&row_idxs)
Creates a constant (immutable) Coo matrix from a set of constant arrays.
const LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x) const
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x)
Applies Coo matrix axpy to a vector (or a sequence of vectors).
LinOp * apply2(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< LinOp > x)
Performs the operation x = alpha * Coo * b + x.
void compute_absolute_inplace() override
Compute absolute inplace on each element.
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition coo.hpp:162
const index_type * get_const_row_idxs() const noexcept
Definition coo.hpp:200
const LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x) const
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
static std::unique_ptr< Coo > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size=dim< 2 >{}, size_type num_nonzeros={})
Creates an uninitialized COO matrix of the specified size.
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition coo.hpp:210
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
index_type * get_row_idxs() noexcept
Returns the row indexes of the matrix.
Definition coo.hpp:191
static std::unique_ptr< Coo > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, array< value_type > values, array< index_type > col_idxs, array< index_type > row_idxs)
Creates a COO matrix from already allocated (and initialized) row index, column index and value array...
value_type * get_values() noexcept
Returns the values of the matrix.
Definition coo.hpp:153
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
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:57
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
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