Ginkgo: ginkgo/core/reorder/mc64.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
mc64.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_REORDER_MC64_HPP_
6#define GKO_PUBLIC_CORE_REORDER_MC64_HPP_
7
8
9#include <limits>
10#include <memory>
11
12#include <ginkgo/core/base/abstract_factory.hpp>
13#include <ginkgo/core/base/composition.hpp>
14#include <ginkgo/core/base/dim.hpp>
15#include <ginkgo/core/base/lin_op.hpp>
16#include <ginkgo/core/base/polymorphic_object.hpp>
17#include <ginkgo/core/base/types.hpp>
18#include <ginkgo/core/base/utils.hpp>
19#include <ginkgo/core/matrix/csr.hpp>
20#include <ginkgo/core/matrix/diagonal.hpp>
21#include <ginkgo/core/matrix/identity.hpp>
22#include <ginkgo/core/matrix/permutation.hpp>
23#include <ginkgo/core/matrix/sparsity_csr.hpp>
24#include <ginkgo/core/reorder/reordering_base.hpp>
25
26
27namespace gko {
28namespace experimental {
34namespace reorder {
35
36
44 enum class mc64_strategy { max_diagonal_product, max_diagonal_sum };
45
46
76template <typename ValueType = default_precision, typename IndexType = int32>
77 class Mc64 final
78 : public EnablePolymorphicObject<Mc64<ValueType, IndexType>, LinOpFactory>,
79 public EnablePolymorphicAssignment<Mc64<ValueType, IndexType>> {
80 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
81
82public:
83 struct parameters_type;
84 friend class EnablePolymorphicObject<Mc64<ValueType, IndexType>,
85 LinOpFactory>;
86 friend class enable_parameters_type<parameters_type,
87 Mc64<ValueType, IndexType>>;
88
89 using value_type = ValueType;
90 using index_type = IndexType;
91 using result_type = Composition<value_type>;
92 using matrix_type = matrix::Csr<value_type, index_type>;
93
94 struct parameters_type
95 : public enable_parameters_type<parameters_type, Mc64> {
99 mc64_strategy GKO_FACTORY_PARAMETER_SCALAR(
100 strategy, mc64_strategy::max_diagonal_product);
101
106 remove_complex<ValueType> GKO_FACTORY_PARAMETER_SCALAR(
107 tolerance,
108 50 * std::numeric_limits<remove_complex<ValueType>>::epsilon());
109 };
110
116 const parameters_type& get_parameters() const { return parameters_; }
117
125 std::unique_ptr<result_type> generate(
126 std::shared_ptr<const LinOp> system_matrix) const;
127
129 static parameters_type build() { return {}; }
130
131private:
132 explicit Mc64(std::shared_ptr<const Executor> exec,
133 const parameters_type& params = {});
134
135 std::unique_ptr<LinOp> generate_impl(
136 std::shared_ptr<const LinOp> system_matrix) const override;
137
138 parameters_type parameters_;
139};
140
141
142} // namespace reorder
143} // namespace experimental
144} // namespace gko
145
146
147#endif // GKO_PUBLIC_CORE_REORDER_MC64_HPP_
gko::Composition
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
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::LinOpFactory
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:385
gko::enable_parameters_type
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
gko::experimental::reorder::Mc64
MC64 is an algorithm for permuting large entries to the diagonal of a sparse matrix.
Definition mc64.hpp:79
gko::experimental::reorder::Mc64::build
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition mc64.hpp:129
gko::experimental::reorder::Mc64::generate
std::unique_ptr< result_type > generate(std::shared_ptr< const LinOp > system_matrix) const
Creates a new product from the given components.
gko::experimental::reorder::Mc64::get_parameters
const parameters_type & get_parameters() const
Returns the parameters used to construct the factory.
Definition mc64.hpp:116
gko::matrix::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
GKO_FACTORY_PARAMETER_SCALAR
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
gko::experimental::reorder
The Reorder namespace.
Definition amd.hpp:25
gko::experimental::reorder::mc64_strategy
mc64_strategy
Strategy defining the goal of the MC64 reordering.
Definition mc64.hpp:44
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::remove_complex
typename detail::remove_complex_s< T >::type remove_complex
Obtain the type which removed the complex of complex/scalar type or the template parameter of class b...
Definition math.hpp:264
gko::experimental::reorder::Mc64::parameters_type
Definition mc64.hpp:95
gko::experimental::reorder::Mc64::parameters_type::strategy
mc64_strategy strategy
This parameter controls the goal of the permutation.
Definition mc64.hpp:100
gko::experimental::reorder::Mc64::parameters_type::tolerance
remove_complex< ValueType > tolerance
This parameter controls the tolerance below which a weight is considered to be zero.
Definition mc64.hpp:108