![]() |
Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
|
The Incomplete Sparse Approximate Inverse (ISAI) Preconditioner generates an approximate inverse matrix for a given square matrix A, lower triangular matrix L, upper triangular matrix U or symmetric positive (spd) matrix B. More...
#include <ginkgo/core/preconditioner/isai.hpp>
Classes | |
class | Factory |
struct | parameters_type |
Public Types | |
using | value_type = ValueType |
using | index_type = IndexType |
using | transposed_type |
using | Comp = Composition<ValueType> |
using | Csr = matrix::Csr<ValueType, IndexType> |
using | Dense = matrix::Dense<ValueType> |
![]() | |
using | result_type = ResultType |
![]() | |
using | result_type = ResultType |
Public Member Functions | |
std::shared_ptr< const typename std::conditional< IsaiType==isai_type::spd, Comp, Csr >::type > | get_approximate_inverse () const |
Returns the approximate inverse of the given matrix (either a CSR matrix for IsaiType general, upper or lower or a composition of two CSR matrices for IsaiType spd). | |
Isai & | operator= (const Isai &other) |
Copy-assigns an ISAI preconditioner. | |
Isai & | operator= (Isai &&other) |
Move-assigns an ISAI preconditioner. | |
Isai (const Isai &other) | |
Copy-constructs an ISAI preconditioner. | |
Isai (Isai &&other) | |
Move-constructs an ISAI preconditioner. | |
const parameters_type & | get_parameters () const |
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. | |
![]() | |
const Isai< IsaiType, ValueType, IndexType > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
Isai< IsaiType, ValueType, IndexType > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) |
const Isai< IsaiType, ValueType, IndexType > * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const |
Isai< IsaiType, ValueType, IndexType > * | 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. | |
![]() | |
void | convert_to (ptr_param< result_type > result) const |
void | move_to (ptr_param< result_type > result) |
Static Public Member Functions | |
static auto | build () -> decltype(Factory ::create()) |
Static Public Attributes | |
static constexpr isai_type | type {IsaiType} |
Friends | |
class | EnableLinOp< Isai > |
class | EnablePolymorphicObject< Isai, LinOp > |
class | Isai< isai_type::general, ValueType, IndexType > |
class | Isai< isai_type::lower, ValueType, IndexType > |
class | Isai< isai_type::upper, ValueType, IndexType > |
class | Isai< isai_type::spd, ValueType, IndexType > |
The Incomplete Sparse Approximate Inverse (ISAI) Preconditioner generates an approximate inverse matrix for a given square matrix A, lower triangular matrix L, upper triangular matrix U or symmetric positive (spd) matrix B.
Using the preconditioner computes
The sparsity pattern used for the approximate inverse of A, L and U is the same as the sparsity pattern of the respective matrix. For B, the sparsity pattern used for the approximate inverse is the same as the sparsity pattern of the lower triangular half of B.
Note that, except for the spd case, for a matrix A generally ISAI(A)^T != ISAI(A^T).
For more details on the algorithm, see the paper Incomplete Sparse Approximate Inverses for Parallel Preconditioning, which is the basis for this work.
width
(warp size for CUDA) as number of elements per row in the sparse matrix. If there are more than width
elements per row, the remaining elements will be ignored.IsaiType | determines if the ISAI is generated for a general square matrix, a lower triangular matrix, an upper triangular matrix or an spd matrix |
ValueType | precision of matrix elements |
IndexType | precision of matrix indexes |
using gko::preconditioner::Isai< IsaiType, ValueType, IndexType >::transposed_type |
gko::preconditioner::Isai< IsaiType, ValueType, IndexType >::Isai | ( | const Isai< IsaiType, ValueType, IndexType > & | other | ) |
Copy-constructs an ISAI preconditioner.
Inherits the executor, shallow-copies the matrix and parameters.
gko::preconditioner::Isai< IsaiType, ValueType, IndexType >::Isai | ( | Isai< IsaiType, ValueType, IndexType > && | other | ) |
Move-constructs an ISAI preconditioner.
Inherits the executor, moves the matrix and parameters. The moved-from object is empty (0x0 with nullptr matrix and default parameters)
|
overridevirtual |
Returns a LinOp representing the conjugate transpose of the Transposable object.
Implements gko::Transposable.
|
inline |
Returns the approximate inverse of the given matrix (either a CSR matrix for IsaiType general, upper or lower or a composition of two CSR matrices for IsaiType spd).
References gko::as(), and gko::one().
Isai & gko::preconditioner::Isai< IsaiType, ValueType, IndexType >::operator= | ( | const Isai< IsaiType, ValueType, IndexType > & | other | ) |
Copy-assigns an ISAI preconditioner.
Preserves the executor, shallow-copies the matrix and parameters. Creates a clone of the matrix if it is on the wrong executor.
Isai & gko::preconditioner::Isai< IsaiType, ValueType, IndexType >::operator= | ( | Isai< IsaiType, ValueType, IndexType > && | other | ) |
Move-assigns an ISAI preconditioner.
Preserves the executor, moves the matrix and parameters. Creates a clone of the matrix if it is on the wrong executor. The moved-from object is empty (0x0 with nullptr matrix and default parameters)
|
overridevirtual |
Returns a LinOp representing the transpose of the Transposable object.
Implements gko::Transposable.