Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
partition_helpers.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_DISTRIBUTED_PARTITION_HELPERS_HPP_
34#define GKO_PUBLIC_CORE_DISTRIBUTED_PARTITION_HELPERS_HPP_
35
36
37#include <ginkgo/config.hpp>
38
39
40#if GINKGO_BUILD_MPI
41
42
43#include <ginkgo/core/base/mpi.hpp>
44#include <ginkgo/core/base/range.hpp>
45
46
47namespace gko {
48namespace experimental {
49namespace distributed {
50
51template <typename LocalIndexType, typename GlobalIndexType>
52class Partition;
53
54
71template <typename LocalIndexType, typename GlobalIndexType>
72std::unique_ptr<Partition<LocalIndexType, GlobalIndexType>>
73build_partition_from_local_range(std::shared_ptr<const Executor> exec,
75
76
89template <typename LocalIndexType, typename GlobalIndexType>
90std::unique_ptr<Partition<LocalIndexType, GlobalIndexType>>
91build_partition_from_local_size(std::shared_ptr<const Executor> exec,
93
94
95} // namespace distributed
96} // namespace experimental
97} // namespace gko
98
99
100#endif // GINKGO_BUILD_MPI
101#endif // GKO_PUBLIC_CORE_DISTRIBUTED_PARTITION_HELPERS_HPP_
A thin wrapper of MPI_Comm that supports most MPI calls.
Definition mpi.hpp:437
std::unique_ptr< Partition< LocalIndexType, GlobalIndexType > > build_partition_from_local_size(std::shared_ptr< const Executor > exec, mpi::communicator comm, size_type local_size)
Builds a partition from a local size.
std::unique_ptr< Partition< LocalIndexType, GlobalIndexType > > build_partition_from_local_range(std::shared_ptr< const Executor > exec, mpi::communicator comm, span local_range)
Builds a partition from a local range.
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
A span is a lightweight structure used to create sub-ranges from other ranges.
Definition range.hpp:75