amd.hpp

// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef GKO_PUBLIC_CORE_REORDER_AMD_HPP_
#define GKO_PUBLIC_CORE_REORDER_AMD_HPP_
 
 
#include <memory>
 
 
#include <ginkgo/core/base/abstract_factory.hpp>
#include <ginkgo/core/base/lin_op.hpp>
#include <ginkgo/core/base/polymorphic_object.hpp>
#include <ginkgo/core/base/types.hpp>
#include <ginkgo/core/matrix/permutation.hpp>
 
 
namespace gko {
namespace experimental {
namespace reorder {
 
 
template <typename IndexType = int32>
class Amd : public EnablePolymorphicObject<Amd<IndexType>, LinOpFactory>,
            public EnablePolymorphicAssignment<Amd<IndexType>> {
public:
    struct parameters_type;
    friend class EnablePolymorphicObject<Amd<IndexType>, LinOpFactory>;
    friend class enable_parameters_type<parameters_type, Amd<IndexType>>;
 
    using index_type = IndexType;
    using permutation_type = matrix::Permutation<index_type>;
 
    struct parameters_type
        : public enable_parameters_type<parameters_type, Amd<IndexType>> {
        bool GKO_FACTORY_PARAMETER_SCALAR(skip_symmetrize, false);
 
        bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
    };
 
    const parameters_type& get_parameters() { return parameters_; }
 
    std::unique_ptr<permutation_type> generate(
        std::shared_ptr<const LinOp> system_matrix) const;
 
    static parameters_type build() { return {}; }
 
protected:
    explicit Amd(std::shared_ptr<const Executor> exec,
                 const parameters_type& params = {});
 
    std::unique_ptr<LinOp> generate_impl(
        std::shared_ptr<const LinOp> system_matrix) const override;
 
    parameters_type parameters_;
};
 
 
}  // namespace reorder
}  // namespace experimental
}  // namespace gko
 
 
#endif  // GKO_PUBLIC_CORE_REORDER_AMD_HPP_