Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
gko::solver::Chebyshev< ValueType > Class Template Referencefinal

Chebyshev iteration is an iterative method for solving nonsymmetric problems based on some knowledge of the spectrum of the (preconditioned) system matrix. More...

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

Inheritance diagram for gko::solver::Chebyshev< ValueType >:
[legend]
Collaboration diagram for gko::solver::Chebyshev< ValueType >:
[legend]

Classes

class  Factory
struct  parameters_type

Public Types

using value_type = ValueType
using transposed_type = Chebyshev<ValueType>
Public Types inherited from gko::EnablePolymorphicAssignment< Chebyshev< default_precision > >
using result_type
Public Types inherited from gko::ConvertibleTo< Chebyshev< default_precision > >
using result_type

Public Member Functions

std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object.
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object.
bool apply_uses_initial_guess () const override
 Return true as iterative solvers use the data in x as an initial guess.
Chebyshevoperator= (const Chebyshev &)
 Copy-assigns a Chebyshev solver.
Chebyshevoperator= (Chebyshev &&)
 Move-assigns a Chebyshev solver.
 Chebyshev (const Chebyshev &)
 Copy-constructs an Chebyshev solver.
 Chebyshev (Chebyshev &&)
 Move-constructs an Chebyshev solver.
const parameters_typeget_parameters () const
Public Member Functions inherited from gko::EnableLinOp< Chebyshev< default_precision > >
const Chebyshev< default_precision > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Chebyshev< default_precision >, LinOp >
std::unique_ptr< Chebyshev< default_precision > > create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Chebyshev< default_precision > > clone (std::shared_ptr< const Executor > exec) const
Chebyshev< default_precision > * copy_from (const PolymorphicObject *other)
Chebyshev< default_precision > * move_from (ptr_param< PolymorphicObject > other)
Chebyshev< default_precision > * clear ()
Public Member Functions inherited from gko::LinOp
LinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
 Applies a linear operator to a vector (or a sequence of vectors).
const LinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
LinOpapply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)
 Performs the operation x = alpha * op(b) + beta * x.
const LinOpapply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
const dim< 2 > & get_size () const noexcept
 Returns the size of the operator.
LinOpoperator= (const LinOp &)=default
 Copy-assigns a LinOp.
LinOpoperator= (LinOp &&other)
 Move-assigns a LinOp.
 LinOp (const LinOp &)=default
 Copy-constructs a LinOp.
 LinOp (LinOp &&other)
 Move-constructs a LinOp.
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
LinOpcopy_from (const PolymorphicObject *other)
LinOpmove_from (ptr_param< PolymorphicObject > other)
LinOpclear ()
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object.
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object.
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object.
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object.
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object.
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)
 Moves another object into this object.
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)
 Copies another object into this object.
PolymorphicObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 Copies another object into this object.
PolymorphicObjectmove_from (ptr_param< PolymorphicObject > other)
 Moves another object into this object.
PolymorphicObjectclear ()
 Transforms the object into its default state.
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object.
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers.
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers.
const std::vector< std::shared_ptr< const Logger > > & get_loggers () const override
 Returns the vector containing all loggers registered at this object.
void clear_loggers () override
 Remove all loggers registered at this object.
Public Member Functions inherited from gko::log::Loggable
void remove_logger (ptr_param< const Logger > logger)
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Chebyshev< default_precision > >
void convert_to (result_type *result) const override
void move_to (result_type *result) override
Public Member Functions inherited from gko::solver::EnableSolverBase< Chebyshev< default_precision > >
EnableSolverBaseoperator= (const EnableSolverBase &other)
 Creates a shallow copy of the provided system matrix, clones it onto this executor if executors don't match.
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
 Returns the IDs of all scalars (workspace vectors with system dimension-independent size, usually 1 x num_rhs).
std::vector< int > get_workspace_vectors () const override
 Returns the IDs of all vectors (workspace vectors with system dimension-dependent size, usually system_matrix_size x num_rhs).
Public Member Functions inherited from gko::solver::SolverBase< LinOp >
std::shared_ptr< const LinOpget_system_matrix () const
 Returns the system matrix, with its concrete type, used by the solver.
Public Member Functions inherited from gko::solver::EnableIterativeBase< Chebyshev< default_precision > >
EnableIterativeBaseoperator= (const EnableIterativeBase &other)
 Creates a shallow copy of the provided stopping criterion, clones it onto this executor if executors don't match.
void set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override
 Sets the stopping criterion of the solver.
Public Member Functions inherited from gko::solver::IterativeBase
std::shared_ptr< const stop::CriterionFactoryget_stop_criterion_factory () const
 Gets the stopping criterion factory of the solver.
Public Member Functions inherited from gko::solver::EnablePreconditionable< Chebyshev< default_precision > >
void set_preconditioner (std::shared_ptr< const LinOp > new_precond) override
 Sets the preconditioner operator used by the Preconditionable.
EnablePreconditionableoperator= (const EnablePreconditionable &other)
 Creates a shallow copy of the provided preconditioner, clones it onto this executor if executors don't match.
Public Member Functions inherited from gko::Preconditionable
virtual std::shared_ptr< const LinOpget_preconditioner () const
 Returns the preconditioner operator used by the Preconditionable.

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 >())
 Create the parameters from the property_tree.

Friends

class EnableLinOp< Chebyshev >
class EnablePolymorphicObject< Chebyshev, LinOp >
class EnableApplyWithInitialGuess< Chebyshev >

Detailed Description

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

Chebyshev iteration is an iterative method for solving nonsymmetric problems based on some knowledge of the spectrum of the (preconditioned) system matrix.

It avoids the computation of inner products, which may be a performance bottleneck for distributed system. Chebyshev iteration is developed based on Chebyshev polynomials of the first kind. This implementation follows the algorithm in "Templates for the Solution of Linear Systems: Building Blocks for Iterative Methods, 2nd Edition".

solution = initial_guess
while not converged:
residual = b - A solution
error = preconditioner(A) * residual
solution = solution + alpha_i * error + beta_i * (solution_i -
solution_{i-1})
The Preconditioner namespace.
Definition gauss_seidel.hpp:19
Template Parameters
ValueTypeprecision of matrix elements

Constructor & Destructor Documentation

◆ Chebyshev() [1/2]

template<typename ValueType = default_precision>
gko::solver::Chebyshev< ValueType >::Chebyshev ( const Chebyshev< ValueType > & )

Copy-constructs an Chebyshev solver.

Inherits the executor, shallow-copies inner solver, stopping criterion and system matrix.

◆ Chebyshev() [2/2]

template<typename ValueType = default_precision>
gko::solver::Chebyshev< ValueType >::Chebyshev ( Chebyshev< ValueType > && )

Move-constructs an Chebyshev solver.

Preserves the executor, moves inner solver, stopping criterion and system matrix. The moved-from object is empty (0x0 and nullptr inner solver, stopping criterion and system matrix)

Member Function Documentation

◆ apply_uses_initial_guess()

template<typename ValueType = default_precision>
bool gko::solver::Chebyshev< ValueType >::apply_uses_initial_guess ( ) const
inlineoverridevirtual

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.

Reimplemented from gko::LinOp.

◆ conj_transpose()

template<typename ValueType = default_precision>
std::unique_ptr< LinOp > gko::solver::Chebyshev< 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.

◆ operator=() [1/2]

template<typename ValueType = default_precision>
Chebyshev & gko::solver::Chebyshev< ValueType >::operator= ( Chebyshev< ValueType > && )

Move-assigns a Chebyshev solver.

Preserves the executor, moves inner solver, stopping criterion and system matrix. If the executors mismatch, clones inner solver, stopping criterion and system matrix onto this executor. The moved-from object is empty (0x0 and nullptr inner solver, stopping criterion and system matrix)

◆ operator=() [2/2]

template<typename ValueType = default_precision>
Chebyshev & gko::solver::Chebyshev< ValueType >::operator= ( const Chebyshev< ValueType > & )

Copy-assigns a Chebyshev solver.

Preserves the executor, shallow-copies inner solver, stopping criterion and system matrix. If the executors mismatch, clones inner solver, stopping criterion and system matrix onto this executor.

◆ parse()

template<typename ValueType = default_precision>
parameters_type gko::solver::Chebyshev< 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
configthe property tree for setting
contextthe registry
td_for_childthe 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::Chebyshev< 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: