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 >:

Collaboration diagram for gko::solver::LowerTrs< ValueType, IndexType >:

Classes
struct	parameters_type
class	Factory

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 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.
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
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::solver::EnableSolverBase< LowerTrs< default_precision, int32 >, matrix::Csr< default_precision, int32 > >
EnableSolverBase &	operator= (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< 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.

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

ValueType	precision of matrix elements
IndexType	precision 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>

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

config	the property tree for setting
context	the registry
td_for_child	the 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:

ginkgo/core/solver/triangular.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LowerTrs() [1/2]

◆ LowerTrs() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse()

◆ transpose()