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
mc64.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 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
44enum class mc64_strategy { max_diagonal_product, max_diagonal_sum };
45
46
76template <typename ValueType = default_precision, typename IndexType = int32>
77class Mc64 final
78 : public EnablePolymorphicObject<Mc64<ValueType, IndexType>, LinOpFactory>,
79 public EnablePolymorphicAssignment<Mc64<ValueType, IndexType>> {
80public:
81 struct parameters_type;
82 friend class EnablePolymorphicObject<Mc64<ValueType, IndexType>,
85 Mc64<ValueType, IndexType>>;
86
87 using value_type = ValueType;
88 using index_type = IndexType;
89 using result_type = Composition<value_type>;
90 using matrix_type = matrix::Csr<value_type, index_type>;
91
93 : public enable_parameters_type<parameters_type, Mc64> {
98 strategy, mc64_strategy::max_diagonal_product);
99
105 tolerance,
106 50 * std::numeric_limits<remove_complex<ValueType>>::epsilon());
107 };
108
114 const parameters_type& get_parameters() const { return parameters_; }
115
123 std::unique_ptr<result_type> generate(
124 std::shared_ptr<const LinOp> system_matrix) const;
125
127 static parameters_type build() { return {}; }
128
129private:
130 explicit Mc64(std::shared_ptr<const Executor> exec,
131 const parameters_type& params = {});
132
133 std::unique_ptr<LinOp> generate_impl(
134 std::shared_ptr<const LinOp> system_matrix) const override;
135
136 parameters_type parameters_;
137};
138
139
140} // namespace reorder
141} // namespace experimental
142} // namespace gko
143
144
145#endif // GKO_PUBLIC_CORE_REORDER_MC64_HPP_
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:723
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:385
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
MC64 is an algorithm for permuting large entries to the diagonal of a sparse matrix.
Definition mc64.hpp:79
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition mc64.hpp:127
std::unique_ptr< result_type > generate(std::shared_ptr< const LinOp > system_matrix) const
const parameters_type & get_parameters() const
Returns the parameters used to construct the factory.
Definition mc64.hpp:114
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:121
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
The Reorder namespace.
Definition amd.hpp:25
mc64_strategy
Strategy defining the goal of the MC64 reordering.
Definition mc64.hpp:44
The Ginkgo namespace.
Definition abstract_factory.hpp:20
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:260
mc64_strategy strategy
This parameter controls the goal of the permutation.
Definition mc64.hpp:98
remove_complex< ValueType > tolerance
This parameter controls the tolerance below which a weight is considered to be zero.
Definition mc64.hpp:106