33#ifndef GKO_PUBLIC_CORE_REORDER_RCM_HPP_
34#define GKO_PUBLIC_CORE_REORDER_RCM_HPP_
40#include <ginkgo/core/base/abstract_factory.hpp>
41#include <ginkgo/core/base/array.hpp>
42#include <ginkgo/core/base/dim.hpp>
43#include <ginkgo/core/base/lin_op.hpp>
44#include <ginkgo/core/base/polymorphic_object.hpp>
45#include <ginkgo/core/base/types.hpp>
46#include <ginkgo/core/base/utils.hpp>
47#include <ginkgo/core/matrix/csr.hpp>
48#include <ginkgo/core/matrix/identity.hpp>
49#include <ginkgo/core/matrix/permutation.hpp>
50#include <ginkgo/core/matrix/sparsity_csr.hpp>
51#include <ginkgo/core/reorder/reordering_base.hpp>
63enum class starting_strategy { minimum_degree, pseudo_peripheral };
99template <
typename ValueType = default_precision,
typename IndexType =
int32>
101 ReorderingBase<IndexType>>,
108 using value_type = ValueType;
109 using index_type = IndexType;
130 return inv_permutation_;
151 strategy, starting_strategy::pseudo_peripheral);
157 explicit Rcm(std::shared_ptr<const Executor> exec);
162 std::shared_ptr<PermutationMatrix> permutation_;
163 std::shared_ptr<PermutationMatrix> inv_permutation_;
170namespace experimental {
174using rcm_starting_strategy = gko::reorder::starting_strategy;
202template <
typename IndexType =
int32>
210 using index_type = IndexType;
226 strategy, rcm_starting_strategy::pseudo_peripheral);
244 std::shared_ptr<const LinOp> system_matrix)
const;
250 explicit Rcm(std::shared_ptr<const Executor> exec,
251 const parameters_type&
params = {});
253 std::unique_ptr<LinOp> generate_impl(
254 std::shared_ptr<const LinOp> system_matrix)
const override;
256 parameters_type parameters_;
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:752
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:414
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:239
Rcm (Reverse Cuthill-McKee) is a reordering algorithm minimizing the bandwidth of a matrix.
Definition rcm.hpp:204
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition rcm.hpp:234
std::unique_ptr< permutation_type > generate(std::shared_ptr< const LinOp > system_matrix) const
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition rcm.hpp:247
Permutation is a matrix format that represents a permutation matrix, i.e.
Definition permutation.hpp:142
SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressi...
Definition sparsity_csr.hpp:87
Rcm (Reverse Cuthill-McKee) is a reordering algorithm minimizing the bandwidth of a matrix.
Definition rcm.hpp:102
std::shared_ptr< const PermutationMatrix > get_inverse_permutation() const
Gets the inverse permutation (permutation matrix, output of the algorithm) of the linear operator.
Definition rcm.hpp:128
std::shared_ptr< const PermutationMatrix > get_permutation() const
Gets the permutation (permutation matrix, output of the algorithm) of the linear operator.
Definition rcm.hpp:117
The ReorderingBase class is a base class for all the reordering algorithms.
Definition reordering_base.hpp:64
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition abstract_factory.hpp:308
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition abstract_factory.hpp:422
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
bool skip_symmetrize
If set to false, computes the RCM reordering on A + A^T, otherwise assumes that A is symmetric and us...
Definition rcm.hpp:219
rcm_starting_strategy strategy
This parameter controls the strategy used to determine a starting vertex.
Definition rcm.hpp:226
This struct is used to pass parameters to the EnableDefaultReorderingBaseFactory::generate() method.
Definition reordering_base.hpp:94