5#ifndef GKO_PUBLIC_CORE_DISTRIBUTED_MATRIX_HPP_
6#define GKO_PUBLIC_CORE_DISTRIBUTED_MATRIX_HPP_
9#include <ginkgo/config.hpp>
15#include <ginkgo/core/base/dense_cache.hpp>
16#include <ginkgo/core/base/mpi.hpp>
17#include <ginkgo/core/distributed/base.hpp>
18#include <ginkgo/core/distributed/lin_op.hpp>
25template <
typename ValueType,
typename IndexType>
39template <
typename Builder,
typename ValueType,
typename IndexType,
41struct is_matrix_type_builder : std::false_type {};
44template <
typename Builder,
typename ValueType,
typename IndexType>
45struct is_matrix_type_builder<
48 decltype(std::declval<Builder>().template create<ValueType, IndexType>(
49 std::declval<std::shared_ptr<const Executor>>()))>>
53template <
template <
typename,
typename>
class MatrixType,
55struct MatrixTypeBuilderFromValueAndIndex {
56 template <
typename ValueType,
typename IndexType, std::size_t...
I>
57 auto create_impl(std::shared_ptr<const Executor> exec,
58 std::index_sequence<I...>)
60 return MatrixType<ValueType, IndexType>::create(
61 exec, std::get<I>(create_args)...);
65 template <
typename ValueType,
typename IndexType>
66 auto create(std::shared_ptr<const Executor> exec)
69 static constexpr auto size =
sizeof...(CreateArgs);
71 std::move(exec), std::make_index_sequence<size>{});
112template <
template <
typename,
typename>
class MatrixType,
typename...
Args>
115 return detail::MatrixTypeBuilderFromValueAndIndex<
MatrixType,
Args...>{
116 std::forward_as_tuple(create_args...)};
120namespace experimental {
121namespace distributed {
124template <
typename LocalIndexType,
typename GlobalIndexType>
126template <
typename ValueType>
238 Matrix<ValueType, LocalIndexType, GlobalIndexType>>,
240 Matrix<next_precision<ValueType>, LocalIndexType, GlobalIndexType>>,
247 using value_type = ValueType;
263 global_index_type>*
result)
const override;
266 global_index_type>*
result)
override;
353 return non_local_mtx_;
398 static std::unique_ptr<Matrix>
create(std::shared_ptr<const Executor> exec,
422 typename = std::enable_if_t<detail::is_matrix_type_builder<
424 static std::unique_ptr<Matrix>
create(std::shared_ptr<const Executor> exec,
462 typename = std::enable_if_t<
520 explicit Matrix(std::shared_ptr<const Executor> exec,
523 explicit Matrix(std::shared_ptr<const Executor> exec,
538 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
541 LinOp* x)
const override;
544 std::vector<comm_index_type> send_offsets_;
545 std::vector<comm_index_type> send_sizes_;
546 std::vector<comm_index_type> recv_offsets_;
547 std::vector<comm_index_type> recv_sizes_;
550 gko::detail::DenseCache<value_type> one_scalar_;
551 gko::detail::DenseCache<value_type> host_send_buffer_;
552 gko::detail::DenseCache<value_type> host_recv_buffer_;
553 gko::detail::DenseCache<value_type> send_buffer_;
554 gko::detail::DenseCache<value_type> recv_buffer_;
555 std::shared_ptr<LinOp> local_mtx_;
556 std::shared_ptr<LinOp> non_local_mtx_;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:471
Definition lin_op.hpp:118
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:167
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:35
This mixin does the same as EnableLinOp, but for concrete types that are derived from distributed::Di...
Definition lin_op.hpp:45
This mixin does the same as EnablePolymorphicObject, but for concrete types that are derived from dis...
Definition polymorphic_object.hpp:54
A base class for distributed objects.
Definition base.hpp:32
The Matrix class defines a (MPI-)distributed matrix.
Definition matrix.hpp:241
std::shared_ptr< const LinOp > get_non_local_matrix() const
Get read access to the stored non-local matrix.
Definition matrix.hpp:351
void read_distributed(const matrix_data< value_type, global_index_type > &data, ptr_param< const Partition< local_index_type, global_index_type > > partition)
Reads a square matrix from the matrix_data structure and a global partition.
Matrix(Matrix &&other) noexcept
Move constructs a Matrix.
void read_distributed(const matrix_data< value_type, global_index_type > &data, ptr_param< const Partition< local_index_type, global_index_type > > row_partition, ptr_param< const Partition< local_index_type, global_index_type > > col_partition)
Reads a matrix from the matrix_data structure, a global row partition, and a global column partition.
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm, ptr_param< const LinOp > local_matrix_template, ptr_param< const LinOp > non_local_matrix_template)
Creates an empty distributed matrix with specified types for the local matrix and the non-local matri...
std::shared_ptr< const LinOp > get_local_matrix() const
Get read access to the stored local matrix.
Definition matrix.hpp:344
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm)
Creates an empty distributed matrix.
void read_distributed(const device_matrix_data< value_type, global_index_type > &data, ptr_param< const Partition< local_index_type, global_index_type > > partition)
Reads a square matrix from the device_matrix_data structure and a global partition.
void read_distributed(const device_matrix_data< value_type, global_index_type > &data, ptr_param< const Partition< local_index_type, global_index_type > > row_partition, ptr_param< const Partition< local_index_type, global_index_type > > col_partition)
Reads a matrix from the device_matrix_data structure, a global row partition, and a global column par...
Matrix(const Matrix &other)
Copy constructs a Matrix.
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm, LocalMatrixType local_matrix_template, NonLocalMatrixType non_local_matrix_template)
Creates an empty distributed matrix with specified types for the local matrix and the non-local matri...
Definition matrix.hpp:467
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm, MatrixType matrix_template)
Creates an empty distributed matrix with specified type for local matrices.
Definition matrix.hpp:424
Matrix & operator=(Matrix &&other)
Move assigns a Matrix.
Matrix & operator=(const Matrix &other)
Copy assigns a Matrix.
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm, ptr_param< const LinOp > matrix_template)
Creates an empty distributed matrix with specified type for local matrices.
Represents a partition of a range of indices [0, size) into a disjoint set of parts.
Definition partition.hpp:82
Vector is a format which explicitly stores (multiple) distributed column vectors in a dense storage f...
Definition vector.hpp:63
A thin wrapper of MPI_Comm that supports most MPI calls.
Definition mpi.hpp:409
The request class is a light, move-only wrapper around the MPI_Request handle.
Definition mpi.hpp:320
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:43
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:109
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list.
Definition math.hpp:462
auto with_matrix_type(Args &&... create_args)
This function returns a type that delays a call to MatrixType::create.
Definition matrix.hpp:113
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:177
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:115
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:127