UpperTrs is the triangular solver which solves the system U x = b, when U is an upper triangular matrix. More...

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

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

Collaboration 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< UpperTrs< ValueType, IndexType > >
using	result_type = UpperTrs< ValueType, IndexType >

Public Types inherited from gko::ConvertibleTo< UpperTrs< ValueType, IndexType > >
using	result_type = UpperTrs< ValueType, IndexType >

Public Member Functions
std::unique_ptr< LinOp >	transpose () const override
	Returns a LinOp representing the transpose of the Transposable object. More...

std::unique_ptr< LinOp >	conj_transpose () const override
	Returns a LinOp representing the conjugate transpose of the Transposable object. More...

const parameters_type &	get_parameters () const

	UpperTrs (const UpperTrs &)
	Copy-assigns a triangular solver. More...

	UpperTrs (UpperTrs &&)
	Move-assigns a triangular solver. More...

UpperTrs &	operator= (const UpperTrs &)
	Copy-constructs a triangular solver. More...

UpperTrs &	operator= (UpperTrs &&)
	Move-constructs a triangular solver. More...

Public Member Functions inherited from gko::EnableLinOp< UpperTrs< ValueType, IndexType > >
const UpperTrs< ValueType, IndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

UpperTrs< ValueType, IndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const UpperTrs< ValueType, IndexType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

UpperTrs< ValueType, IndexType > *	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< UpperTrs< ValueType, IndexType >, LinOp >
std::unique_ptr< UpperTrs< ValueType, IndexType > >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< UpperTrs< ValueType, IndexType > >	create_default () const

std::unique_ptr< UpperTrs< ValueType, IndexType > >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< UpperTrs< ValueType, IndexType > >	clone () const

UpperTrs< ValueType, IndexType > *	copy_from (const PolymorphicObject *other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, UpperTrs< ValueType, IndexType > > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, UpperTrs< ValueType, IndexType > > *	copy_from (const std::unique_ptr< Derived > &other)

UpperTrs< ValueType, IndexType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

UpperTrs< ValueType, IndexType > *	move_from (ptr_param< PolymorphicObject > other)

UpperTrs< ValueType, IndexType > *	clear ()

Public Member Functions inherited from gko::LinOp
LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
	Applies a linear operator to a vector (or a sequence of vectors). More...

const LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

LinOp *	apply (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. More...

const LinOp *	apply (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. More...

virtual bool	apply_uses_initial_guess () const
	Returns true if the linear operator uses the data given in x as an initial guess. More...

LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...

LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...

	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...

	LinOp (LinOp &&other)
	Move-constructs a LinOp. More...

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOp >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< LinOp >	create_default () const

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

std::unique_ptr< LinOp >	clone () const

LinOp *	copy_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)

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

LinOp *	move_from (ptr_param< PolymorphicObject > other)

LinOp *	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
	Creates a new "default" object of the same dynamic type as this object. More...

std::unique_ptr< PolymorphicObject >	create_default () const
	Creates a new "default" object of the same dynamic type as this object. More...

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...

std::unique_ptr< PolymorphicObject >	clone () const
	Creates a clone of the object. More...

PolymorphicObject *	copy_from (const PolymorphicObject *other)
	Copies another object into this object. More...

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. More...

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. More...

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
	Copies another object into this object. More...

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)
	Moves another object into this object. More...

PolymorphicObject *	clear ()
	Transforms the object into its default state. More...

std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...

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< UpperTrs< ValueType, IndexType > >
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...

void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...

Public Member Functions inherited from gko::ConvertibleTo< UpperTrs< ValueType, IndexType > >
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< UpperTrs< ValueType, IndexType >, matrix::Csr< ValueType, IndexType > >
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. More...

	EnableSolverBase (std::shared_ptr< const matrix::Csr< ValueType, IndexType > > system_matrix)

	EnableSolverBase (const EnableSolverBase &other)
	Creates a shallow copy of the provided system matrix.

	EnableSolverBase (EnableSolverBase &&other)
	Moves the provided system matrix. More...

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< ValueType, IndexType > >
std::shared_ptr< const matrix::Csr< ValueType, IndexType > >	get_system_matrix () const
	Returns the system matrix, with its concrete type, used by the solver. More...

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. More...

Friends
class	EnableLinOp< UpperTrs >

class	EnablePolymorphicObject< UpperTrs, LinOp >

class	LowerTrs< ValueType, IndexType >

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.

◆ 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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ UpperTrs() [1/2]

◆ UpperTrs() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse()

◆ transpose()

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