![]() |
Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
|
The Incomplete Cholesky (IC) preconditioner solves the equation
#include <ginkgo/core/preconditioner/ic.hpp>
Classes | |
class | Factory |
struct | parameters_type |
Public Types | |
using | value_type = typename LSolverType::value_type |
using | l_solver_type = LSolverType |
using | lh_solver_type = typename LSolverType::transposed_type |
using | index_type = IndexType |
using | transposed_type = Ic<LSolverType, IndexType> |
![]() | |
using | result_type |
![]() | |
using | result_type = ResultType |
Public Member Functions | |
const parameters_type & | get_parameters () const |
std::shared_ptr< const l_solver_type > | get_l_solver () const |
Returns the solver which is used for the provided L matrix. | |
std::shared_ptr< const lh_solver_type > | get_lh_solver () const |
Returns the solver which is used for the L^H matrix. | |
std::unique_ptr< LinOp > | transpose () const override |
Returns a LinOp representing the transpose of the Transposable object. | |
std::unique_ptr< LinOp > | conj_transpose () const override |
Returns a LinOp representing the conjugate transpose of the Transposable object. | |
Ic & | operator= (const Ic &other) |
Copy-assigns an IC preconditioner. | |
Ic & | operator= (Ic &&other) |
Move-assigns an IC preconditioner. | |
Ic (const Ic &other) | |
Copy-constructs an IC preconditioner. | |
Ic (Ic &&other) | |
Move-constructs an IC preconditioner. | |
![]() | |
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) |
![]() | |
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 () |
![]() | |
PolymorphicObject & | operator= (const PolymorphicObject &) |
std::unique_ptr< PolymorphicObject > | create_default (std::shared_ptr< const Executor > exec) const |
Creates a new "default" object of the same dynamic type as this object. | |
std::unique_ptr< PolymorphicObject > | create_default () const |
Creates a new "default" object of the same dynamic type as this object. | |
std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
Creates a clone of the object. | |
std::unique_ptr< PolymorphicObject > | clone () const |
Creates a clone of the object. | |
PolymorphicObject * | copy_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. | |
PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
Copies another object into this object. | |
PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
Moves another object into this object. | |
PolymorphicObject * | clear () |
Transforms the object into its default state. | |
std::shared_ptr< const Executor > | get_executor () const noexcept |
Returns the Executor of the object. | |
![]() | |
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. | |
void | remove_logger (ptr_param< const Logger > logger) |
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. | |
![]() | |
void | remove_logger (ptr_param< const Logger > logger) |
![]() | |
void | convert_to (result_type *result) const override |
Converts the implementer to an object of type result_type. | |
void | move_to (result_type *result) override |
Converts the implementer to an object of type result_type by moving data from this object. | |
![]() | |
virtual void | convert_to (result_type *result) const =0 |
Converts the implementer to an object of type result_type. | |
void | convert_to (ptr_param< result_type > result) const |
virtual void | move_to (result_type *result)=0 |
Converts the implementer to an object of type result_type by moving data from this object. | |
void | move_to (ptr_param< result_type > result) |
Static Public Member Functions | |
static auto | build () -> decltype(Factory ::create()) |
Friends | |
class | EnableLinOp< Ic > |
class | EnablePolymorphicObject< Ic, LinOp > |
The Incomplete Cholesky (IC) preconditioner solves the equation
It allows to set both the solver for L defaulting to solver::LowerTrs, which is a direct triangular solvers. The solver for L^H is the conjugate-transposed solver for L, ensuring that the preconditioner is symmetric and positive-definite. For this L solver, a factory can be provided (using with_l_solver
) to have more control over their behavior. In particular, it is possible to use an iterative method for solving the triangular systems. The default parameters for an iterative triangluar solver are:
An object of this class can be created with a matrix or a gko::Composition containing two matrices. If created with a matrix, it is factorized before creating the solver. If a gko::Composition (containing two matrices) is used, the first operand will be taken as the L matrix, the second will be considered the L^H matrix, which helps to avoid the otherwise necessary transposition of L inside the solver. ParIc can be directly used, since it orders the factors in the correct way.
LSolverType | type of the solver used for the L matrix. Defaults to solver::LowerTrs |
IndexType | type of the indices when ParIc is used to generate the L and L^H factors. Irrelevant otherwise. |
|
inline |
Copy-constructs an IC preconditioner.
Inherits the executor, shallow-copies the solvers and parameters.
References gko::one().
|
inline |
Move-constructs an IC preconditioner.
Inherits the executor, moves the solvers and parameters. The moved-from object is empty (0x0 with nullptr solvers and default parameters)
References gko::one().
|
inlineoverridevirtual |
Returns a LinOp representing the conjugate transpose of the Transposable object.
Implements gko::Transposable.
References gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), gko::PolymorphicObject::get_executor(), gko::preconditioner::Ic< LSolverType, IndexType >::get_l_solver(), gko::preconditioner::Ic< LSolverType, IndexType >::get_lh_solver(), gko::one(), gko::share(), and gko::transpose().
Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose().
|
inline |
Returns the solver which is used for the provided L matrix.
Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), and gko::preconditioner::Ic< LSolverType, IndexType >::transpose().
|
inline |
Returns the solver which is used for the L^H matrix.
Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), and gko::preconditioner::Ic< LSolverType, IndexType >::transpose().
|
inline |
Copy-assigns an IC preconditioner.
Preserves the executor, shallow-copies the solvers and parameters. Creates a clone of the solvers if they are on the wrong executor.
References gko::clone(), gko::PolymorphicObject::get_executor(), and gko::one().
|
inline |
Move-assigns an IC preconditioner.
Preserves the executor, moves the solvers and parameters. Creates a clone of the solvers if they are on the wrong executor. The moved-from object is empty (0x0 with nullptr solvers and default parameters)
References gko::clone(), gko::PolymorphicObject::get_executor(), and gko::one().
|
inlineoverridevirtual |
Returns a LinOp representing the transpose of the Transposable object.
Implements gko::Transposable.
References gko::PolymorphicObject::get_executor(), gko::preconditioner::Ic< LSolverType, IndexType >::get_l_solver(), gko::preconditioner::Ic< LSolverType, IndexType >::get_lh_solver(), gko::one(), gko::share(), gko::preconditioner::Ic< LSolverType, IndexType >::transpose(), and gko::transpose().
Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::transpose().