Ginkgo Generated from branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
gko::solver::LowerTrs< ValueType, IndexType > Class Template Reference

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>

Inheritance diagram for gko::solver::LowerTrs< ValueType, IndexType >:
[legend]
Collaboration diagram for gko::solver::LowerTrs< ValueType, IndexType >:
[legend]

Classes

class  Factory
 
struct  parameters_type
 

Public Types

using value_type = ValueType
 
using index_type = IndexType
 
using transposed_type = UpperTrs<ValueType, IndexType>
 
- Public Types inherited from gko::EnablePolymorphicAssignment< LowerTrs< default_precision, int32 > >
using result_type
 
- Public Types inherited from gko::ConvertibleTo< LowerTrs< default_precision, int32 > >
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.
 
const parameters_typeget_parameters () const
 
 LowerTrs (const LowerTrs &)
 Copy-assigns a triangular solver.
 
 LowerTrs (LowerTrs &&)
 Move-assigns a triangular solver.
 
LowerTrsoperator= (const LowerTrs &)
 Copy-constructs a triangular solver.
 
LowerTrsoperator= (LowerTrs &&)
 Move-constructs a triangular solver.
 
- Public Member Functions inherited from gko::EnableLinOp< LowerTrs< default_precision, int32 > >
const LowerTrs< default_precision, int32 > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
 
LowerTrs< default_precision, int32 > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
 
const LowerTrs< default_precision, int32 > * apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
 
LowerTrs< default_precision, int32 > * 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< LowerTrs< default_precision, int32 >, LinOp >
std::unique_ptr< LowerTrs< default_precision, int32 > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LowerTrs< default_precision, int32 > > create_default () const
 
std::unique_ptr< LowerTrs< default_precision, int32 > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LowerTrs< default_precision, int32 > > clone () const
 
LowerTrs< default_precision, int32 > * copy_from (const PolymorphicObject *other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LowerTrs< default_precision, int32 > > * copy_from (std::unique_ptr< Derived > &&other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LowerTrs< default_precision, int32 > > * copy_from (const std::unique_ptr< Derived > &other)
 
LowerTrs< default_precision, int32 > * copy_from (const std::shared_ptr< const PolymorphicObject > &other)
 
LowerTrs< default_precision, int32 > * move_from (ptr_param< PolymorphicObject > other)
 
LowerTrs< default_precision, int32 > * 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.
 
virtual bool apply_uses_initial_guess () const
 Returns true if the linear operator uses the data given in x as an initial guess.
 
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< LinOpcreate_default () const
 
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpclone () const
 
LinOpcopy_from (const PolymorphicObject *other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * copy_from (std::unique_ptr< Derived > &&other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * copy_from (const std::unique_ptr< Derived > &other)
 
LinOpcopy_from (const std::shared_ptr< 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.
 
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.
 
- Public Member Functions inherited from gko::log::Loggable
void remove_logger (ptr_param< const Logger > logger)
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< LowerTrs< default_precision, int32 > >
void convert_to (result_type *result) const override
 
void move_to (result_type *result) override
 
- Public Member Functions inherited from gko::ConvertibleTo< LowerTrs< default_precision, int32 > >
void convert_to (ptr_param< result_type > result) const
 
void move_to (ptr_param< result_type > result)
 
- Public Member Functions inherited from gko::solver::EnableSolverBase< LowerTrs< default_precision, int32 >, matrix::Csr< default_precision, int32 > >
EnableSolverBaseoperator= (const EnableSolverBase &other)
 Creates a shallow copy of the provided system matrix, clones it onto this executor if executors don't match.
 
EnableSolverBaseoperator= (EnableSolverBase &&other)
 Moves the provided system matrix, clones it onto this executor if executors don't match.
 
 EnableSolverBase (std::shared_ptr< const matrix::Csr< default_precision, int32 > > 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).
 
- Public Member Functions inherited from gko::solver::SolverBase< matrix::Csr< default_precision, int32 > >
std::shared_ptr< const matrix::Csr< default_precision, int32 > > get_system_matrix () const
 Returns the system matrix, with its concrete type, used by the solver.
 
- Public Member Functions inherited from gko::Transposable

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

Friends

class EnableLinOp< LowerTrs >
 
class EnablePolymorphicObject< LowerTrs, LinOp >
 
class UpperTrs< ValueType, IndexType >
 

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::solver::LowerTrs< 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.

Note
As the constructor uses the copy and convert functionality, it is not possible to create a empty solver or a solver with a matrix in any other format other than CSR, if none of the executor modules are being compiled with.
Template Parameters
ValueTypeprecision of matrix elements
IndexTypeprecision of matrix indices

Constructor & Destructor Documentation

◆ LowerTrs() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>
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.

◆ LowerTrs() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>
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)

Member Function Documentation

◆ conj_transpose()

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

◆ operator=() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>
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)

◆ parse()

template<typename ValueType = default_precision, typename IndexType = int32>
static parameters_type gko::solver::LowerTrs< ValueType, IndexType >::parse ( const config::pnode & config,
const config::registry & context,
const config::type_descriptor & td_for_child = config::make_type_descriptor< ValueType, IndexType >() )
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/index type of this class.
Returns
parameters

◆ transpose()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr< LinOp > gko::solver::LowerTrs< ValueType, IndexType >::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: