Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
index_map.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_DISTRIBUTED_INDEX_MAP_HPP_
6#define GKO_PUBLIC_CORE_DISTRIBUTED_INDEX_MAP_HPP_
7
8
9#include <ginkgo/core/base/segmented_array.hpp>
10#include <ginkgo/core/distributed/partition.hpp>
11
12
13namespace gko {
14namespace experimental {
15namespace distributed {
16
17
23enum class index_space {
24 local,
25 non_local,
27};
28
29
67template <typename LocalIndexType, typename GlobalIndexType = int64>
68struct index_map {
70
82 index_space index_space_v) const;
83
88
93
98
111 index_map(std::shared_ptr<const Executor> exec,
112 std::shared_ptr<const partition_type> partition,
113 comm_index_type rank,
114 const array<GlobalIndexType>& recv_connections);
115
119 index_map(std::shared_ptr<const Executor> exec);
120
127
143
151
155 std::shared_ptr<const Executor> get_executor() const;
156
157 index_map(const index_map& other);
158
159 index_map(index_map&& other) noexcept;
160
161 index_map& operator=(const index_map& other);
162
163 index_map& operator=(index_map&& other);
164
165private:
166 std::shared_ptr<const Executor> exec_;
167 std::shared_ptr<const partition_type> partition_;
168 comm_index_type rank_;
169
170 array<comm_index_type> remote_target_ids_;
171 segmented_array<LocalIndexType> remote_local_idxs_;
172 segmented_array<GlobalIndexType> remote_global_idxs_;
173};
174
175
176} // namespace distributed
177} // namespace experimental
178} // namespace gko
179
180
181#endif // GKO_PUBLIC_CORE_DISTRIBUTED_INDEX_MAP_HPP_
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition logger.hpp:25
Represents a partition of a range of indices [0, size) into a disjoint set of parts.
Definition vector.hpp:36
index_space
Index space classification for the locally stored indices.
Definition index_map.hpp:23
@ combined
both local and non_local indices
@ non_local
indices that are owned by other processes
@ local
indices that are locally owned
int comm_index_type
Index type for enumerating processes in a distributed application.
Definition types.hpp:967
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
This class defines mappings between global and local indices.
Definition index_map.hpp:68
index_map(std::shared_ptr< const Executor > exec, std::shared_ptr< const partition_type > partition, comm_index_type rank, const array< GlobalIndexType > &recv_connections)
Creates a new index map.
const array< comm_index_type > & get_remote_target_ids() const
get the rank ids which contain indices accessed by this rank.
size_type get_local_size() const
get size of index_space::local
size_type get_global_size() const
get size of index_space::local
array< LocalIndexType > map_to_local(const array< GlobalIndexType > &global_ids, index_space index_space_v) const
Maps global indices to local indices.
size_type get_non_local_size() const
get size of index_space::non_local
index_map(std::shared_ptr< const Executor > exec)
Creates an empty index map.
const segmented_array< GlobalIndexType > & get_remote_global_idxs() const
get the index set for this rank.
const segmented_array< LocalIndexType > & get_remote_local_idxs() const
get the index set , but mapped to their respective local index space.
std::shared_ptr< const Executor > get_executor() const
get the associated executor.
A minimal interface for a segmented array.
Definition segmented_array.hpp:27