Ginkgo: ginkgo/core/distributed/partition.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
partition.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_DISTRIBUTED_PARTITION_HPP_
6#define GKO_PUBLIC_CORE_DISTRIBUTED_PARTITION_HPP_
7
8
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/polymorphic_object.hpp>
11#include <ginkgo/core/base/segmented_array.hpp>
12#include <ginkgo/core/base/types.hpp>
13
14
15namespace gko {
16namespace experimental {
22namespace distributed {
23
24
79template <typename LocalIndexType = int32, typename GlobalIndexType = int64>
80 class Partition : public EnablePolymorphicObject<
81 Partition<LocalIndexType, GlobalIndexType>>,
82 public EnablePolymorphicAssignment<
83 Partition<LocalIndexType, GlobalIndexType>> {
84 friend class EnablePolymorphicObject<Partition>;
85 static_assert(sizeof(GlobalIndexType) >= sizeof(LocalIndexType),
86 "GlobalIndexType must be at least as large as "
87 "LocalIndexType");
88
89public:
90 using EnablePolymorphicAssignment<Partition>::convert_to;
91 using EnablePolymorphicAssignment<Partition>::move_to;
92
93 using local_index_type = LocalIndexType;
94 using global_index_type = GlobalIndexType;
95
101 size_type get_size() const { return size_; }
102
109 size_type get_num_ranges() const noexcept
110 {
111 return offsets_.get_size() - 1;
112 }
113
119 comm_index_type get_num_parts() const noexcept { return num_parts_; }
120
126 comm_index_type get_num_empty_parts() const noexcept
127 {
128 return num_empty_parts_;
129 }
130
138 const global_index_type* get_range_bounds() const noexcept
139 {
140 return offsets_.get_const_data();
141 }
142
150 const comm_index_type* get_part_ids() const noexcept
151 {
152 return part_ids_.get_const_data();
153 }
154
168 const local_index_type* get_range_starting_indices() const noexcept
169 {
170 return starting_indices_.get_const_data();
171 }
172
179 const local_index_type* get_part_sizes() const noexcept
180 {
181 return part_sizes_.get_const_data();
182 }
183
192 local_index_type get_part_size(comm_index_type part) const;
193
199 const segmented_array<size_type>& get_ranges_by_part() const
200 {
201 return ranges_by_part_;
202 }
203
209 bool has_connected_parts() const;
210
218 bool has_ordered_parts() const;
219
229 static std::unique_ptr<Partition> build_from_mapping(
230 std::shared_ptr<const Executor> exec,
231 const array<comm_index_type>& mapping, comm_index_type num_parts);
232
246 static std::unique_ptr<Partition> build_from_contiguous(
247 std::shared_ptr<const Executor> exec,
248 const array<global_index_type>& ranges,
249 const array<comm_index_type>& part_ids = {});
250
262 static std::unique_ptr<Partition> build_from_global_size_uniform(
263 std::shared_ptr<const Executor> exec, comm_index_type num_parts,
264 global_index_type global_size);
265
266private:
267 Partition(std::shared_ptr<const Executor> exec,
268 comm_index_type num_parts = 0, size_type num_ranges = 0);
269
270 static std::unique_ptr<Partition> create(
271 std::shared_ptr<const Executor> exec, comm_index_type num_parts = 0,
272 size_type num_ranges = 0);
273
279 void finalize_construction();
280
281 comm_index_type num_parts_;
282 comm_index_type num_empty_parts_;
283 global_index_type size_;
284 array<global_index_type> offsets_;
285 array<local_index_type> starting_indices_;
286 array<local_index_type> part_sizes_;
287 array<comm_index_type> part_ids_;
288 segmented_array<size_type> ranges_by_part_;
289};
290
291
292} // namespace distributed
293} // namespace experimental
294} // namespace gko
295
296
297#endif // GKO_PUBLIC_CORE_DISTRIBUTED_PARTITION_HPP_
gko::EnablePolymorphicAssignment
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:743
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::array
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
gko::experimental::distributed::Partition::get_num_empty_parts
comm_index_type get_num_empty_parts() const noexcept
Returns the number of empty parts within this partition.
Definition partition.hpp:126
gko::experimental::distributed::Partition::get_num_ranges
size_type get_num_ranges() const noexcept
Returns the number of ranges stored by this partition.
Definition partition.hpp:109
gko::experimental::distributed::Partition::get_part_sizes
const local_index_type * get_part_sizes() const noexcept
Returns the part size array.
Definition partition.hpp:179
gko::experimental::distributed::Partition::get_range_starting_indices
const local_index_type * get_range_starting_indices() const noexcept
Returns the part-local starting index for each range in this partition.
Definition partition.hpp:168
gko::experimental::distributed::Partition::get_ranges_by_part
const segmented_array< size_type > & get_ranges_by_part() const
Returns the range IDs segmented by their part ID.
Definition partition.hpp:199
gko::experimental::distributed::Partition::build_from_global_size_uniform
static std::unique_ptr< Partition > build_from_global_size_uniform(std::shared_ptr< const Executor > exec, comm_index_type num_parts, global_index_type global_size)
Builds a partition by evenly distributing the global range.
gko::experimental::distributed::Partition::has_connected_parts
bool has_connected_parts() const
Checks if each part has no more than one contiguous range.
gko::experimental::distributed::Partition::get_part_ids
const comm_index_type * get_part_ids() const noexcept
Returns the part IDs of the ranges in this partition.
Definition partition.hpp:150
gko::experimental::distributed::Partition::get_part_size
local_index_type get_part_size(comm_index_type part) const
Returns the size of a part given by its part ID.
gko::experimental::distributed::Partition::get_size
size_type get_size() const
Returns the total number of elements represented by this partition.
Definition partition.hpp:101
gko::experimental::distributed::Partition::get_num_parts
comm_index_type get_num_parts() const noexcept
Returns the number of parts represented in this partition.
Definition partition.hpp:119
gko::experimental::distributed::Partition::build_from_contiguous
static std::unique_ptr< Partition > build_from_contiguous(std::shared_ptr< const Executor > exec, const array< global_index_type > &ranges, const array< comm_index_type > &part_ids={})
Builds a partition consisting of contiguous ranges, one for each part.
gko::experimental::distributed::Partition::build_from_mapping
static std::unique_ptr< Partition > build_from_mapping(std::shared_ptr< const Executor > exec, const array< comm_index_type > &mapping, comm_index_type num_parts)
Builds a partition from a given mapping global_index -> part_id.
gko::experimental::distributed::Partition::has_ordered_parts
bool has_ordered_parts() const
Checks if the ranges are ordered by their part index.
gko::experimental::distributed::Partition::get_range_bounds
const global_index_type * get_range_bounds() const noexcept
Returns the ranges boundary array stored by this partition.
Definition partition.hpp:138
gko::experimental::distributed
The distributed namespace.
Definition polymorphic_object.hpp:19
gko::experimental::mpi::comm_index_type
int comm_index_type
Index type for enumerating processes in a distributed application.
Definition types.hpp:1124
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
gko::segmented_array
A minimal interface for a segmented array.
Definition segmented_array.hpp:27