#include <ginkgo/core/solver/triangular.hpp>

Inheritance diagram for gko::solver::UpperTrs< ValueType, IndexType >:

Classes
class	Factory

struct	parameters_type

Public Types
using	value_type = ValueType

using	index_type = IndexType

using	transposed_type = LowerTrs< ValueType, IndexType >

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
using	result_type = ConcreteLinOp

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
std::unique_ptr< LinOp >	transpose () const override

std::unique_ptr< LinOp >	conj_transpose () const override

const parameters_type &	get_parameters () const

	UpperTrs (const UpperTrs &)

	UpperTrs (UpperTrs &&)

UpperTrs &	operator= (const UpperTrs &)

UpperTrs &	operator= (UpperTrs &&)

Public Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
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)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
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 ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

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)

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)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

void	move_to (ptr_param< result_type > result)

Public Member Functions inherited from gko::solver::EnableSolverBase< DerivedType, MatrixType >
EnableSolverBase &	operator= (const EnableSolverBase &other)

EnableSolverBase &	operator= (EnableSolverBase &&other)

	EnableSolverBase (std::shared_ptr< const MatrixType > system_matrix)

	EnableSolverBase (const EnableSolverBase &other)

	EnableSolverBase (EnableSolverBase &&other)

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

std::vector< int >	get_workspace_vectors () const override

Public Member Functions inherited from gko::solver::SolverBase< MatrixType >
std::shared_ptr< const MatrixType >	get_system_matrix () const

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 >())

Protected Types
using	CsrMatrix = matrix::Csr< ValueType, IndexType >

Protected Member Functions
void	apply_impl (const LinOp b, LinOp x) const override

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

void	generate ()

	UpperTrs (std::shared_ptr< const Executor > exec)

	UpperTrs (const Factory *factory, std::shared_ptr< const LinOp > system_matrix)

Protected Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
ConcreteLinOp *	self () noexcept

const ConcreteLinOp *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Protected Member Functions inherited from gko::solver::EnableSolverBase< DerivedType, MatrixType >
void	set_system_matrix (std::shared_ptr< const MatrixType > new_system_matrix)

void	setup_workspace () const

Protected Member Functions inherited from gko::solver::SolverBase< MatrixType >
void	set_system_matrix_base (std::shared_ptr< const MatrixType > system_matrix)

Friends
class	EnableLinOp< UpperTrs >

class	EnablePolymorphicObject< UpperTrs, LinOp >

class	LowerTrs< ValueType, IndexType >

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::solver::UpperTrs< ValueType, IndexType >

UpperTrs is the triangular solver which solves the system U x = b, when U is an upper 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

◆ UpperTrs() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

gko::solver::UpperTrs< ValueType, IndexType >::UpperTrs ( const UpperTrs< 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.

◆ UpperTrs() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

gko::solver::UpperTrs< ValueType, IndexType >::UpperTrs ( UpperTrs< 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::UpperTrs< 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.

◆ generate()

template<typename ValueType = default_precision, typename IndexType = int32>

void gko::solver::UpperTrs< ValueType, IndexType >::generate ( )

protected

Generates the analysis structure from the system matrix and the right hand side(only dimensional info needed) needed for the level solver.

◆ operator=() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

UpperTrs & gko::solver::UpperTrs< ValueType, IndexType >::operator= ( const UpperTrs< 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>

UpperTrs & gko::solver::UpperTrs< ValueType, IndexType >::operator= ( UpperTrs< 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::UpperTrs< 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::UpperTrs< 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

UpperTrs< ValueType, IndexType > Class Template Reference

UpperTrs< ValueType, IndexType > Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UpperTrs() [1/2]

◆ UpperTrs() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ generate()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse()

◆ transpose()

UpperTrs< ValueType, IndexType > Class Template Reference

UpperTrs&lt; ValueType, IndexType &gt; Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UpperTrs() [1/2]

◆ UpperTrs() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ generate()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse()

◆ transpose()

UpperTrs< ValueType, IndexType > Class Template Reference#