Ginkgo Generated from branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
amd.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_REORDER_AMD_HPP_
6#define GKO_PUBLIC_CORE_REORDER_AMD_HPP_
7
8
9#include <memory>
10
11
12#include <ginkgo/core/base/abstract_factory.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/polymorphic_object.hpp>
15#include <ginkgo/core/base/types.hpp>
16#include <ginkgo/core/matrix/permutation.hpp>
17
18
19namespace gko {
20namespace experimental {
26namespace reorder {
27
28
36template <typename IndexType = int32>
37class Amd : public EnablePolymorphicObject<Amd<IndexType>, LinOpFactory>,
38 public EnablePolymorphicAssignment<Amd<IndexType>> {
39public:
40 struct parameters_type;
41 friend class EnablePolymorphicObject<Amd<IndexType>, LinOpFactory>;
42 friend class enable_parameters_type<parameters_type, Amd<IndexType>>;
43
44 using index_type = IndexType;
46
48 : public enable_parameters_type<parameters_type, Amd<IndexType>> {
54
61 };
62
68 const parameters_type& get_parameters() { return parameters_; }
69
77 std::unique_ptr<permutation_type> generate(
78 std::shared_ptr<const LinOp> system_matrix) const;
79
81 static parameters_type build() { return {}; }
82
83protected:
84 explicit Amd(std::shared_ptr<const Executor> exec,
85 const parameters_type& params = {});
86
87 std::unique_ptr<LinOp> generate_impl(
88 std::shared_ptr<const LinOp> system_matrix) const override;
89
90 parameters_type parameters_;
91};
92
93
94} // namespace reorder
95} // namespace experimental
96} // namespace gko
97
98
99#endif // GKO_PUBLIC_CORE_REORDER_AMD_HPP_
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:724
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:386
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
Computes a Approximate Minimum Degree (AMD) reordering of an input matrix.
Definition amd.hpp:38
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition amd.hpp:81
std::unique_ptr< permutation_type > generate(std::shared_ptr< const LinOp > system_matrix) const
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition amd.hpp:68
Permutation is a matrix format that represents a permutation matrix, i.e.
Definition permutation.hpp:113
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
The Ginkgo namespace.
Definition abstract_factory.hpp:20
bool skip_sorting
If set to false, sorts the input matrix before computing the AMD reordering.
Definition amd.hpp:60
bool skip_symmetrize
If set to false, computes the AMD reordering on A + A^T, otherwise assumes that A is symmetric and us...
Definition amd.hpp:53