 |
Ginkgo
Generated from pipelines/2017069469 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
|
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>
22 template <
typename ValueType,
typename IndexType>
25 template <
typename ValueType>
28 template <
typename ValueType,
typename IndexType>
31 template <
typename ValueType,
typename IndexType>
49 template <
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>;
71 friend class Hybrid<ValueType, IndexType>;
84 using value_type = ValueType;
85 using index_type = IndexType;
98 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
110 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
138 std::unique_ptr<LinOp>
transpose()
const override;
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,
285 array<value_type> values,
286 array<index_type> col_idxs,
287 array<index_type> row_idxs);
293 template <
typename InputValueType,
typename InputColumnIndexType,
294 typename InputRowIndexType>
296 "explicitly construct the gko::array argument instead of passing "
299 std::shared_ptr<const
Executor> exec, const
dim<2>& size,
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,
333 array<value_type> values, array<index_type> col_idxs,
334 array<index_type> row_idxs);
343 void resize(dim<2> new_size,
size_type nnz);
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;
355 array<value_type> values_;
356 array<index_type> col_idxs_;
357 array<index_type> row_idxs_;
365 #endif // GKO_PUBLIC_CORE_MATRIX_COO_HPP_
LinOp * apply2(ptr_param< const LinOp > b, ptr_param< LinOp > x)
Applies Coo matrix axpy to a vector (or a sequence of vectors).
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition: matrix.hpp:30
index_type * get_col_idxs() noexcept
Returns the column indexes of the matrix.
Definition: coo.hpp:172
Definition: lin_op.hpp:117
Dense is a matrix format which explicitly stores all values of the matrix.
Definition: dense_cache.hpp:28
void read(const mat_data &data) override
Reads a matrix from a matrix_data structure.
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
const index_type * get_const_col_idxs() const noexcept
Returns the column indexes of the matrix.
Definition: coo.hpp:181
Linear operators which support transposition should implement the Transposable interface.
Definition: lin_op.hpp:433
std::size_t size_type
Integral type used for allocation quantities.
Definition: types.hpp:90
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
This structure is used as an intermediate data type to store a sparse matrix.
Definition: matrix_data.hpp:126
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition: coo.hpp:210
This class is used for function parameters in the place of raw pointers.
Definition: utils_helper.hpp:41
void write(mat_data &data) const override
Writes a matrix to a matrix_data structure.
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:687
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
value_type * get_values() noexcept
Returns the values of the matrix.
Definition: coo.hpp:153
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::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
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
const index_type * get_const_row_idxs() const noexcept
Definition: coo.hpp:200
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition: polymorphic_object.hpp:479
void compute_absolute_inplace() override
Compute absolute inplace on each element.
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
The first step in using the Ginkgo library consists of creating an executor.
Definition: executor.hpp:615
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition: coo.hpp:32
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
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:696
const value_type * get_const_values() const noexcept
Returns the values of the matrix.
Definition: coo.hpp:162
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.
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition: lin_op.hpp:794
index_type * get_row_idxs() noexcept
Returns the row indexes of the matrix.
Definition: coo.hpp:191
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition: array.hpp:670
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
This type is a device-side equivalent to matrix_data.
Definition: device_matrix_data.hpp:36
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:877
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.
LinOp(const LinOp &)=default
Copy-constructs a LinOp.
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
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition: polymorphic_object.hpp:667
COO stores a matrix in the coordinate matrix format.
Definition: coo.hpp:50