gko::experimental::reorder::ScaledReordered< ValueType, IndexType > Class Template Reference

Provides an interface to wrap reorderings like Rcm and diagonal scaling like equilibration around a LinOp like e.g. More...

#include <ginkgo/core/reorder/scaled_reordered.hpp>

Inheritance diagram for gko::experimental::reorder::ScaledReordered< ValueType, IndexType >:

Collaboration diagram for gko::experimental::reorder::ScaledReordered< ValueType, IndexType >:

Classes
class	Factory
struct	parameters_type

Public Types
using	value_type = ValueType
using	index_type = IndexType
using	ReorderingBaseFactory = AbstractFactory< gko::reorder::ReorderingBase< IndexType >, gko::reorder::ReorderingBaseArgs >

Public Member Functions
std::shared_ptr< const LinOp >	get_system_matrix () const
std::shared_ptr< const LinOp >	get_inner_operator () const
const parameters_type &	get_parameters () const
Public Member Functions inherited from gko::LinOp
void	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...
void	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
	Performs the operation x = alpha * op(b) + beta * x. More...
const dim< 2 > &	get_size () const noexcept
	Returns the size of the operator. More...
virtual bool	apply_uses_initial_guess () const
	Returns true if the linear operator uses the data given in x as an initial guess. More...
LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...
LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...
	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...
	LinOp (LinOp &&other)
	Move-constructs a LinOp. More...
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)
std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override
void	remove_logger (const Logger *logger) override
void	remove_logger (ptr_param< const Logger > logger)
const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override
void	clear_loggers () override
Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Static Public Member Functions
static auto	build () -> decltype(Factory ::create())

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::experimental::reorder::ScaledReordered< ValueType, IndexType >

Provides an interface to wrap reorderings like Rcm and diagonal scaling like equilibration around a LinOp like e.g.

a sparse direct solver.

Reorderings can be useful for reducing fill-in in the numerical factorization phase of direct solvers, diagonal scaling can help improve the numerical stability by reducing the condition number of the system matrix.

With a permutation matrix P, a row scaling R and a column scaling C, the inner operator is applied to the system matrix P*R*A*C*P^T instead of A. Instead of A*x = b, the inner operator attempts to solve the equivalent linear system P*R*A*C*P^T*y = P*R*b and retrieves the solution x = C*P^T*y. Note: The inner system matrix is computed from a clone of A, so the original system matrix is not changed.

Template Parameters

ValueType	Type of the values of all matrices used in this class
IndexType	Type of the indices of all matrices used in this class

---

The documentation for this class was generated from the following file:

• ginkgo/core/reorder/scaled_reordered.hpp