gko::preconditioner::GaussSeidel< ValueType, IndexType > Class Template Reference

This class generates the Gauss-Seidel preconditioner. More...

#include <ginkgo/core/preconditioner/gauss_seidel.hpp>

Inheritance diagram for gko::preconditioner::GaussSeidel< ValueType, IndexType >:

Collaboration diagram for gko::preconditioner::GaussSeidel< ValueType, IndexType >:

Classes
struct	parameters_type

Public Types
using	value_type = ValueType
using	index_type = IndexType
using	composition_type = Composition< ValueType >
Public Types inherited from gko::EnableCloneable< GaussSeidel< ValueType, IndexType > >
using	result_type = GaussSeidel< ValueType, IndexType >
Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
const parameters_type &	get_parameters ()
	Returns the parameters used to construct the factory. More...
const parameters_type &	get_parameters () const
	Returns the parameters used to construct the factory. More...
std::unique_ptr< composition_type >	generate (std::shared_ptr< const LinOp > system_matrix) const
Public Member Functions inherited from gko::LinOpFactory
std::unique_ptr< LinOp >	generate (std::shared_ptr< const LinOp > input) const
virtual std::unique_ptr< ReuseData >	create_empty_reuse_data () const
	Creates an empty ReuseData. More...
std::unique_ptr< LinOp >	generate_reuse (std::shared_ptr< const LinOp > input, ReuseData &reuse_data) const
	Generates a LinOp like generate(), reusing what earlier calls recorded in reuse_data. More...
virtual void	check_reuse_consistent (const LinOp *input, const ReuseData &reuse_data) const
	Throws if input can't be used with reuse_data. More...
Public Member Functions inherited from gko::PolymorphicObject
virtual void	validate_data () const
	Throws gko::InvalidData exception if we found the data inside the object does not fulfill certain property up to our knowledge.
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)
Public Member Functions inherited from gko::EnableCloneable< GaussSeidel< ValueType, IndexType > >
std::unique_ptr< GaussSeidel< ValueType, IndexType > >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...
std::unique_ptr< GaussSeidel< ValueType, IndexType > >	clone () const
	Creates a clone of the object. More...
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...
void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...
std::unique_ptr< GaussSeidel< ValueType, IndexType > >	create_default () const
std::unique_ptr< GaussSeidel< ValueType, IndexType > >	create_default (std::shared_ptr< const Executor > exec) const
Public Member Functions inherited from gko::ConvertibleTo< ResultType >
void	convert_to (ptr_param< result_type > result) const
void	move_to (ptr_param< result_type > result)
Public Member Functions inherited from gko::Cloneable
std::unique_ptr< Cloneable >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Cloneable >	clone () const
Cloneable *	copy_from (ptr_param< const Cloneable > other)
Cloneable *	move_from (ptr_param< Cloneable > other)
std::unique_ptr< Cloneable >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Cloneable >	create_default () const

Static Public Member Functions
static parameters_type	build ()
	Creates a new parameter_type to set up the factory.
static parameters_type	parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())

Friends
class	EnableCloneable< GaussSeidel >
class	enable_parameters_type< parameters_type, GaussSeidel >

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::preconditioner::GaussSeidel< ValueType, IndexType >

This class generates the Gauss-Seidel preconditioner.

This is the special case of the relaxation factor \(\omega = 1\) of the (S)SOR preconditioner.

See also

Sor

Member Function Documentation

generate()

template<typename ValueType = default_precision, typename IndexType = int32>

std::unique_ptr<composition_type> gko::preconditioner::GaussSeidel< ValueType, IndexType >::generate

(

std::shared_ptr< const LinOp >

system_matrix

)

const

Parameters

system_matrix

the source matrix used to generate the preconditioner.

Note

This function overrides the default LinOpFactory::generate to return a Factorization instead of a generic LinOp, which would need to be cast to Factorization again to access its factors. It is only necessary because smart pointers aren't covariant.

get_parameters() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

const parameters_type& gko::preconditioner::GaussSeidel< ValueType, IndexType >::get_parameters ( )

inline

Returns the parameters used to construct the factory.

Returns

the parameters used to construct the factory.

get_parameters() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

const parameters_type& gko::preconditioner::GaussSeidel< ValueType, IndexType >::get_parameters ( ) const

inline

Returns the parameters used to construct the factory.

Returns

the parameters used to construct the factory.

---

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

• ginkgo/core/preconditioner/gauss_seidel.hpp