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/base/std_extensions.hpp>
18#include <ginkgo/core/distributed/base.hpp>
19#include <ginkgo/core/distributed/index_map.hpp>
20#include <ginkgo/core/distributed/lin_op.hpp>
27template <
typename ValueType,
typename IndexType>
37template <
typename ValueType,
typename IndexType>
51template <
typename Builder,
typename ValueType,
typename IndexType,
53struct is_matrix_type_builder : std::false_type {};
56template <
typename Builder,
typename ValueType,
typename IndexType>
57struct is_matrix_type_builder<
58 Builder, ValueType, IndexType,
60 decltype(std::declval<Builder>().template create<ValueType, IndexType>(
61 std::declval<std::shared_ptr<const Executor>>()))>>
65template <
template <
typename,
typename>
class MatrixType,
66 typename... CreateArgs>
67struct MatrixTypeBuilderFromValueAndIndex {
68 template <
typename ValueType,
typename IndexType, std::size_t... I>
69 auto create_impl(std::shared_ptr<const Executor> exec,
70 std::index_sequence<I...>)
72 return MatrixType<ValueType, IndexType>::create(
73 exec, std::get<I>(create_args)...);
77 template <
typename ValueType,
typename IndexType>
78 auto create(std::shared_ptr<const Executor> exec)
81 static constexpr auto size =
sizeof...(CreateArgs);
82 return create_impl<ValueType, IndexType>(
83 std::move(exec), std::make_index_sequence<size>{});
86 std::tuple<CreateArgs...> create_args;
124template <
template <
typename,
typename>
class MatrixType,
typename... Args>
127 return detail::MatrixTypeBuilderFromValueAndIndex<MatrixType, Args...>{
128 std::forward_as_tuple(create_args...)};
132namespace experimental {
133namespace distributed {
148template <
typename LocalIndexType,
typename GlobalIndexType>
150template <
typename ValueType>
259 typename LocalIndexType =
int32,
typename GlobalIndexType =
int64>
261 Matrix<ValueType, LocalIndexType, GlobalIndexType>>,
263 LocalIndexType, GlobalIndexType>>,
271 using value_type = ValueType;
272 using index_type = GlobalIndexType;
273 using local_index_type = LocalIndexType;
274 using global_index_type = GlobalIndexType;
282 GlobalIndexType>>::convert_to;
284 GlobalIndexType>>::move_to;
287 global_index_type>* result)
const override;
290 global_index_type>* result)
override;
387 return non_local_mtx_;
433 static std::unique_ptr<Matrix>
create(std::shared_ptr<const Executor> exec,
456 template <
typename MatrixType,
457 typename = std::enable_if_t<gko::detail::is_matrix_type_builder<
458 MatrixType, ValueType, LocalIndexType>::value>>
459 static std::unique_ptr<Matrix>
create(std::shared_ptr<const Executor> exec,
461 MatrixType matrix_template)
496 template <
typename LocalMatrixType,
typename NonLocalMatrixType,
497 typename = std::enable_if_t<
498 gko::detail::is_matrix_type_builder<
499 LocalMatrixType, ValueType, LocalIndexType>::value &&
500 gko::detail::is_matrix_type_builder<
501 NonLocalMatrixType, ValueType, LocalIndexType>::value>>
504 LocalMatrixType local_matrix_template,
505 NonLocalMatrixType non_local_matrix_template)
511 non_local_matrix_template
566 static std::unique_ptr<Matrix>
create(std::shared_ptr<const Executor> exec,
568 std::shared_ptr<LinOp> local_linop);
590 dim<2> size, std::shared_ptr<LinOp> local_linop,
591 std::shared_ptr<LinOp> non_local_linop,
592 std::vector<comm_index_type> recv_sizes,
593 std::vector<comm_index_type> recv_offsets,
615 explicit Matrix(std::shared_ptr<const Executor> exec,
618 explicit Matrix(std::shared_ptr<const Executor> exec,
623 explicit Matrix(std::shared_ptr<const Executor> exec,
625 std::shared_ptr<LinOp> local_linop);
627 explicit Matrix(std::shared_ptr<const Executor> exec,
629 std::shared_ptr<LinOp> local_linop,
630 std::shared_ptr<LinOp> non_local_linop,
631 std::vector<comm_index_type> recv_sizes,
632 std::vector<comm_index_type> recv_offsets,
643 mpi::request communicate(
const local_vector_type* local_b)
const;
645 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
648 LinOp* x)
const override;
651 std::vector<comm_index_type> send_offsets_;
652 std::vector<comm_index_type> send_sizes_;
653 std::vector<comm_index_type> recv_offsets_;
654 std::vector<comm_index_type> recv_sizes_;
657 gko::detail::DenseCache<value_type> one_scalar_;
658 gko::detail::DenseCache<value_type> host_send_buffer_;
659 gko::detail::DenseCache<value_type> host_recv_buffer_;
660 gko::detail::DenseCache<value_type> send_buffer_;
661 gko::detail::DenseCache<value_type> recv_buffer_;
662 std::shared_ptr<LinOp> local_mtx_;
663 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:470
Definition lin_op.hpp:117
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition logger.hpp:25
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
This mixin does the same as EnableLinOp, but for concrete types that are derived from distributed::Di...
Definition lin_op.hpp:44
This mixin does the same as EnablePolymorphicObject, but for concrete types that are derived from dis...
Definition polymorphic_object.hpp:53
A base class for distributed objects.
Definition base.hpp:32
The Matrix class defines a (MPI-)distributed matrix.
Definition matrix.hpp:264
std::shared_ptr< const LinOp > get_non_local_matrix() const
Get read access to the stored non-local matrix.
Definition matrix.hpp:385
Matrix(Matrix &&other) noexcept
Move constructs a Matrix.
void read_distributed(const matrix_data< value_type, global_index_type > &data, std::shared_ptr< const Partition< local_index_type, global_index_type > > row_partition, std::shared_ptr< const Partition< local_index_type, global_index_type > > col_partition, assembly_mode assembly_type=assembly_mode::local_only)
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...
void col_scale(ptr_param< const global_vector_type > scaling_factors)
Scales the columns of the matrix by the respective entries of the vector.
std::shared_ptr< const LinOp > get_local_matrix() const
Get read access to the stored local matrix.
Definition matrix.hpp:378
void read_distributed(const device_matrix_data< value_type, global_index_type > &data, std::shared_ptr< const Partition< local_index_type, global_index_type > > row_partition, std::shared_ptr< const Partition< local_index_type, global_index_type > > col_partition, assembly_mode assembly_type=assembly_mode::local_only)
Reads a matrix from the device_matrix_data structure, a global row partition, and a global column par...
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm)
Creates an empty distributed matrix.
void read_distributed(const matrix_data< value_type, global_index_type > &data, std::shared_ptr< const Partition< local_index_type, global_index_type > > partition, assembly_mode assembly_type=assembly_mode::local_only)
Reads a square matrix from the matrix_data structure and a global partition.
void row_scale(ptr_param< const global_vector_type > scaling_factors)
Scales the rows of the matrix by the respective entries of the vector.
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm, dim< 2 > size, std::shared_ptr< LinOp > local_linop)
Creates a local-only distributed matrix with existent LinOp.
static std::unique_ptr< Matrix > create(std::shared_ptr< const Executor > exec, mpi::communicator comm, dim< 2 > size, std::shared_ptr< LinOp > local_linop, std::shared_ptr< LinOp > non_local_linop, std::vector< comm_index_type > recv_sizes, std::vector< comm_index_type > recv_offsets, array< local_index_type > recv_gather_idxs)
Creates distributed matrix with existent local and non-local LinOp and the corresponding mapping to c...
void read_distributed(const device_matrix_data< value_type, global_index_type > &data, std::shared_ptr< const Partition< local_index_type, global_index_type > > partition, assembly_mode assembly_type=assembly_mode::local_only)
Reads a square matrix from the device_matrix_data structure and a global partition.
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:502
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:459
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 vector.hpp:36
Vector is a format which explicitly stores (multiple) distributed column vectors in a dense storage f...
Definition dense.hpp:29
A thin wrapper of MPI_Comm that supports most MPI calls.
Definition mpi.hpp:408
The request class is a light, move-only wrapper around the MPI_Request handle.
Definition mpi.hpp:319
Parallel graph match (Pgm) is the aggregate method introduced in the paper M.
Definition pgm.hpp:52
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
assembly_mode
assembly_mode defines how the read_distributed function of the distributed matrix treats non-local in...
Definition matrix.hpp:145
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:106
typename detail::next_precision_base_impl< T >::type next_precision_base
Obtains the next type in the singly-linked precision list.
Definition math.hpp:421
auto with_matrix_type(Args &&... create_args)
This function returns a type that delays a call to MatrixType::create.
Definition matrix.hpp:125
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:171
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:112
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