5#ifndef GKO_PUBLIC_CORE_BASE_DEVICE_MATRIX_DATA_HPP_
6#define GKO_PUBLIC_CORE_BASE_DEVICE_MATRIX_DATA_HPP_
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/dim.hpp>
11#include <ginkgo/core/base/exception_helpers.hpp>
12#include <ginkgo/core/base/executor.hpp>
13#include <ginkgo/core/base/matrix_data.hpp>
14#include <ginkgo/core/base/temporary_clone.hpp>
35template <
typename ValueType,
typename IndexType>
38 using value_type = ValueType;
39 using index_type = IndexType;
82 template <
typename InputValueType,
typename RowIndexType,
83 typename ColIndexType>
85 "explicitly construct the gko::array arguments instead of passing "
88 std::initializer_list<RowIndexType> row_idxs,
89 std::initializer_list<ColIndexType> col_idxs,
90 std::initializer_list<InputValueType> values)
115 std::shared_ptr<const Executor> exec,
const host_type& data);
150 return values_.get_executor();
165 GKO_DEPRECATED(
"use get_num_stored_elements()")
189 return row_idxs_.get_const_data();
206 return col_idxs_.get_const_data();
223 return values_.get_const_data();
271template <
typename ValueType,
typename IndexType>
273 static std::unique_ptr<device_matrix_data<ValueType, IndexType>> create(
274 std::shared_ptr<const Executor> exec,
278 return std::make_unique<device_matrix_data<ValueType, IndexType>>(
279 std::move(exec), *ptr);
281 return std::make_unique<device_matrix_data<ValueType, IndexType>>(
288template <
typename ValueType,
typename IndexType>
289struct temporary_clone_helper<const device_matrix_data<ValueType, IndexType>> {
290 static std::unique_ptr<const device_matrix_data<ValueType, IndexType>>
291 create(std::shared_ptr<const Executor> exec,
292 const device_matrix_data<ValueType, IndexType>* ptr,
bool)
294 return std::make_unique<const device_matrix_data<ValueType, IndexType>>(
295 std::move(exec), *ptr);
300template <
typename ValueType,
typename IndexType>
301class copy_back_deleter<device_matrix_data<ValueType, IndexType>>
302 :
public copy_back_deleter_from_assignment<
303 device_matrix_data<ValueType, IndexType>> {
305 using copy_back_deleter_from_assignment<device_matrix_data<
306 ValueType, IndexType>>::copy_back_deleter_from_assignment;
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
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
dim< 2 > get_size() const
Returns the dimensions of the matrix.
Definition device_matrix_data.hpp:158
static device_matrix_data create_from_host(std::shared_ptr< const Executor > exec, const host_type &data)
Creates a device_matrix_data object from the given host data on the given executor.
const index_type * get_const_row_idxs() const
Returns a pointer to the constant row index array.
Definition device_matrix_data.hpp:187
index_type * get_row_idxs()
Returns a pointer to the row index array.
Definition device_matrix_data.hpp:180
const value_type * get_const_values() const
Returns a pointer to the constant value array.
Definition device_matrix_data.hpp:221
device_matrix_data(std::shared_ptr< const Executor > exec, dim< 2 > size={}, size_type num_entries=0)
Initializes a new device_matrix_data object.
size_type get_num_stored_elements() const
Returns the number of stored elements of the matrix.
Definition device_matrix_data.hpp:173
const index_type * get_const_col_idxs() const
Returns a pointer to the constant column index array.
Definition device_matrix_data.hpp:204
void resize_and_reset(size_type new_num_entries)
Resizes the internal storage to the given number of stored matrix entries.
void resize_and_reset(dim< 2 > new_size, size_type new_num_entries)
Resizes the matrix and internal storage to the given dimensions.
size_type get_num_elems() const
Definition device_matrix_data.hpp:166
void fill_zero()
Fills the matrix entries with zeros.
void sort_row_major()
Sorts the matrix entries in row-major order This means that they will be sorted by row index first,...
void sum_duplicates()
Sums up all duplicate entries pointing to the same non-zero location.
arrays empty_out()
Moves out the internal arrays of the device_matrix_data object and resets it to an empty 0x0 matrix.
std::shared_ptr< const Executor > get_executor() const
Returns the executor used to store the device_matrix_data entries.
Definition device_matrix_data.hpp:148
device_matrix_data(std::shared_ptr< const Executor > exec, const device_matrix_data &data)
Initializes a device_matrix_data object by copying an existing object on another executor.
index_type * get_col_idxs()
Returns a pointer to the column index array.
Definition device_matrix_data.hpp:197
value_type * get_values()
Returns a pointer to the value array.
Definition device_matrix_data.hpp:214
void remove_zeros()
Removes all zero entries from the storage.
host_type copy_to_host() const
Copies the device_matrix_data entries to the host to return a regular matrix_data object with the sam...
device_matrix_data(std::shared_ptr< const Executor > exec, dim< 2 > size, array< index_type > row_idxs, array< index_type > col_idxs, array< value_type > values)
Initializes a new device_matrix_data object from existing data.
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
Stores the internal arrays of a device_matrix_data object.
Definition device_matrix_data.hpp:246
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:26
Type used to store nonzeros.
Definition matrix_data.hpp:60
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126