#include <ginkgo/core/solver/cgs.hpp>

Inheritance diagram for gko::solver::Cgs< ValueType >:

Classes
class	Factory

struct	parameters_type

Public Types
using	value_type = ValueType

using	transposed_type = Cgs< ValueType >

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
using	result_type = ConcreteLinOp

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
std::unique_ptr< LinOp >	transpose () const override

std::unique_ptr< LinOp >	conj_transpose () const override

bool	apply_uses_initial_guess () const override

const parameters_type &	get_parameters () const

Public Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
const ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

std::unique_ptr< AbstractObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_from (const PolymorphicObject *other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (std::unique_ptr< Derived > &&other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (const std::unique_ptr< Derived > &other)

AbstractObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	clear ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (std::unique_ptr< Derived, Deleter > &&other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (const std::unique_ptr< Derived, Deleter > &other)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

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::EnablePolymorphicAssignment< ConcreteLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

void	move_to (ptr_param< result_type > result)

Public Member Functions inherited from gko::solver::EnablePreconditionedIterativeSolver< ValueType, DerivedType >
	EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, std::shared_ptr< const stop::CriterionFactory > stop_factory, std::shared_ptr< const LinOp > preconditioner)

template<typename FactoryParameters >
	EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, const FactoryParameters &params)

Public Member Functions inherited from gko::solver::EnableSolverBase< DerivedType, MatrixType >
EnableSolverBase &	operator= (const EnableSolverBase &other)

EnableSolverBase &	operator= (EnableSolverBase &&other)

	EnableSolverBase (std::shared_ptr< const MatrixType > system_matrix)

	EnableSolverBase (const EnableSolverBase &other)

	EnableSolverBase (EnableSolverBase &&other)

int	get_num_workspace_ops () const override

std::vector< std::string >	get_workspace_op_names () const override

std::vector< int >	get_workspace_scalars () const override

std::vector< int >	get_workspace_vectors () const override

Public Member Functions inherited from gko::solver::SolverBase< MatrixType >
std::shared_ptr< const MatrixType >	get_system_matrix () const

Public Member Functions inherited from gko::solver::EnableIterativeBase< DerivedType >
EnableIterativeBase &	operator= (const EnableIterativeBase &other)

EnableIterativeBase &	operator= (EnableIterativeBase &&other)

	EnableIterativeBase (std::shared_ptr< const stop::CriterionFactory > stop_factory)

	EnableIterativeBase (const EnableIterativeBase &other)

	EnableIterativeBase (EnableIterativeBase &&other)

void	set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override

Public Member Functions inherited from gko::solver::IterativeBase
std::shared_ptr< const stop::CriterionFactory >	get_stop_criterion_factory () const

Public Member Functions inherited from gko::solver::EnablePreconditionable< DerivedType >
void	set_preconditioner (std::shared_ptr< const LinOp > new_precond) override

EnablePreconditionable &	operator= (const EnablePreconditionable &other)

EnablePreconditionable &	operator= (EnablePreconditionable &&other)

	EnablePreconditionable (std::shared_ptr< const LinOp > preconditioner)

	EnablePreconditionable (const EnablePreconditionable &other)

	EnablePreconditionable (EnablePreconditionable &&other)

Public Member Functions inherited from gko::Preconditionable
virtual std::shared_ptr< const LinOp >	get_preconditioner () const

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

static parameters_type	parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType >())

Protected Member Functions
void	apply_impl (const LinOp b, LinOp x) const override

template<typename VectorType >
void	apply_dense_impl (const VectorType b, VectorType x) const

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

	Cgs (std::shared_ptr< const Executor > exec)

	Cgs (const Factory *factory, std::shared_ptr< const LinOp > system_matrix)

Protected Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
ConcreteLinOp *	self () noexcept

const ConcreteLinOp *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Protected Member Functions inherited from gko::solver::EnableSolverBase< DerivedType, MatrixType >
void	set_system_matrix (std::shared_ptr< const MatrixType > new_system_matrix)

void	setup_workspace () const

Protected Member Functions inherited from gko::solver::SolverBase< MatrixType >
void	set_system_matrix_base (std::shared_ptr< const MatrixType > system_matrix)

Friends
class	EnableLinOp< Cgs >

class	EnablePolymorphicObject< Cgs, LinOp >

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

template<typename ValueType = default_precision>
class gko::solver::Cgs< ValueType >

CGS or the conjugate gradient square method is an iterative type Krylov subspace method which is suitable for general systems.

The implementation in Ginkgo makes use of the merged kernel to make the best use of data locality. The inner operations in one iteration of CGS are merged into 3 separate steps.

Template Parameters

ValueType precision of matrix elements

Member Function Documentation

◆ apply_uses_initial_guess()

template<typename ValueType = default_precision>

bool gko::solver::Cgs< ValueType >::apply_uses_initial_guess ( ) const

inlineoverride

Return true as iterative solvers use the data in x as an initial guess.

Returns: true as iterative solvers use the data in x as an initial guess.

◆ conj_transpose()

template<typename ValueType = default_precision>

std::unique_ptr< LinOp > gko::solver::Cgs< ValueType >::conj_transpose ( ) const

overridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns: a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ parse()

template<typename ValueType = default_precision>

static parameters_type gko::solver::Cgs< ValueType >::parse	(	const config::pnode &	config,
		const config::registry &	context,
		const config::type_descriptor &	td_for_child = `config::make_type_descriptor< ValueType >()`
	)

static

Create the parameters from the property_tree. Because this is directly tied to the specific type, the value/index type settings within config are ignored and type_descriptor is only used for children configs.

Parameters

config	the property tree for setting
context	the registry
td_for_child	the type descriptor for children configs. The default uses the value type of this class.

Returns: parameters

◆ transpose()

template<typename ValueType = default_precision>

std::unique_ptr< LinOp > gko::solver::Cgs< ValueType >::transpose ( ) const

overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns: a pointer to the new transposed object

Implements gko::Transposable.

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

ginkgo/core/solver/cgs.hpp

Cgs< ValueType > Class Template Reference

Cgs< ValueType > Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply_uses_initial_guess()

◆ conj_transpose()

◆ parse()

◆ transpose()

Cgs< ValueType > Class Template Reference

Cgs&lt; ValueType &gt; Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply_uses_initial_guess()

◆ conj_transpose()

◆ parse()

◆ transpose()

Cgs< ValueType > Class Template Reference#