![]() |
Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
|
LowerTrs is the triangular solver which solves the system L x = b, when L is a lower triangular matrix. More...
#include <ginkgo/core/solver/triangular.hpp>
Classes | |
class | Factory |
struct | parameters_type |
Public Types | |
using | value_type = ValueType |
using | index_type = IndexType |
using | transposed_type = UpperTrs<ValueType, IndexType> |
![]() | |
using | result_type |
![]() | |
using | result_type = ResultType |
Public Member Functions | |
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 parameters_type & | get_parameters () const |
LowerTrs (const LowerTrs &) | |
Copy-assigns a triangular solver. | |
LowerTrs (LowerTrs &&) | |
Move-assigns a triangular solver. | |
LowerTrs & | operator= (const LowerTrs &) |
Copy-constructs a triangular solver. | |
LowerTrs & | operator= (LowerTrs &&) |
Move-constructs a triangular solver. | |
![]() | |
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) |
![]() | |
EnableSolverBase & | operator= (const EnableSolverBase &other) |
Creates a shallow copy of the provided system matrix, clones it onto this executor if executors don't match. | |
EnableSolverBase & | operator= (EnableSolverBase &&other) |
Moves the provided system matrix, clones it onto this executor if executors don't match. | |
EnableSolverBase (std::shared_ptr< const MatrixType > system_matrix) | |
EnableSolverBase (const EnableSolverBase &other) | |
Creates a shallow copy of the provided system matrix. | |
EnableSolverBase (EnableSolverBase &&other) | |
Moves the provided system matrix. | |
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). | |
![]() | |
std::shared_ptr< const MatrixType > | get_system_matrix () const |
Returns the system matrix, with its concrete type, used by the solver. | |
Static Public Member Functions | |
static auto | build () -> decltype(Factory ::create()) |
Friends | |
class | EnableLinOp< LowerTrs > |
class | EnablePolymorphicObject< LowerTrs, LinOp > |
class | UpperTrs< ValueType, IndexType > |
LowerTrs is the triangular solver which solves the system L x = b, when L is a lower triangular matrix.
It works best when passing in a matrix in CSR format. If the matrix is not in CSR, then the generate step converts it into a CSR matrix. The generation fails if the matrix is not convertible to CSR.
ValueType | precision of matrix elements |
IndexType | precision of matrix indices |
gko::solver::LowerTrs< ValueType, IndexType >::LowerTrs | ( | const LowerTrs< ValueType, IndexType > & | ) |
Copy-assigns a triangular solver.
Preserves the executor, shallow-copies the system matrix. If the executors mismatch, clones system matrix onto this executor. Solver analysis information will be regenerated.
gko::solver::LowerTrs< ValueType, IndexType >::LowerTrs | ( | LowerTrs< ValueType, IndexType > && | ) |
Move-assigns a triangular solver.
Preserves the executor, moves the system matrix. If the executors mismatch, clones system matrix onto this executor and regenerates solver analysis information. Moved-from object is empty (0x0 and nullptr system matrix)
|
overridevirtual |
Returns a LinOp representing the conjugate transpose of the Transposable object.
Implements gko::Transposable.
LowerTrs & gko::solver::LowerTrs< ValueType, IndexType >::operator= | ( | const LowerTrs< ValueType, IndexType > & | ) |
Copy-constructs a triangular solver.
Preserves the executor, shallow-copies the system matrix. Solver analysis information will be regenerated.
LowerTrs & gko::solver::LowerTrs< ValueType, IndexType >::operator= | ( | LowerTrs< ValueType, IndexType > && | ) |
Move-constructs a triangular solver.
Preserves the executor, moves the system matrix and solver analysis information. Moved-from object is empty (0x0 and nullptr system matrix)
|
overridevirtual |
Returns a LinOp representing the transpose of the Transposable object.
Implements gko::Transposable.