Class to perform conjugate gradient (CG) method [7] for linear operators. More...

#include <num_collect/linear/impl/operator_conjugate_gradient.h>

Inheritance diagram for num_collect::linear::impl::operator_conjugate_gradient< Vector >:

Collaboration diagram for num_collect::linear::impl::operator_conjugate_gradient< Vector >:

Public Types
using	scalar_type = typename vector_type::Scalar
	Type of scalars.

using	vector_type = Vector
	Type of vectors.

Public Member Functions
	operator_conjugate_gradient ()
	Constructor.

auto	iterations () -> index_type
	Get the number of iterations.

template<base::concepts::invocable< const vector_type &, vector_type & > CoeffFunction>
void	solve (CoeffFunction &&coeff_function, const vector_type &rhs, vector_type &solution)
	Solve.

auto	tolerance_rate (const scalar_type &val) -> operator_conjugate_gradient &
	Set the rate of tolerances.

Public Member Functions inherited from num_collect::logging::logging_mixin
	logging_mixin (log_tag_view tag)
	Constructor.

template<typename Child >
void	configure_child_algorithm_logger_if_exists (Child &child)
	Configure a logger of a child algorithm if exists.

auto	logger () const noexcept -> const num_collect::logging::logger &
	Access to the logger.

auto	logger () noexcept -> num_collect::logging::logger &
	Access to the logger.

Private Attributes
index_type	iterations_ {}
	Number of iterations.

index_type	max_iterations_ {default_max_iterations}
	Maximum number of iterations.

vector_type	residual_ {}
	Residual vector.

scalar_type	tolerance_rate_ {default_tolerance_rate}
	Rate of tolerance.

Intermidiate variables.
vector_type	previous_residual_ {}

vector_type	p_ {}

vector_type	coeff_p_ {}

Static Private Attributes
static constexpr index_type	default_max_iterations = 1000
	Default maximum number of iterations.

static constexpr scalar_type	default_tolerance_rate
	Default rate of tolerance.

Detailed Description

template<base::concepts::dense_vector Vector>
class num_collect::linear::impl::operator_conjugate_gradient< Vector >

Class to perform conjugate gradient (CG) method [7] for linear operators.

Template Parameters

Vector Type of vectors.

Definition at line 46 of file operator_conjugate_gradient.h.

Member Typedef Documentation

◆ scalar_type

template<base::concepts::dense_vector Vector>

using num_collect::linear::impl::operator_conjugate_gradient< Vector >::scalar_type = typename vector_type::Scalar

Type of scalars.

Definition at line 52 of file operator_conjugate_gradient.h.

◆ vector_type

template<base::concepts::dense_vector Vector>

using num_collect::linear::impl::operator_conjugate_gradient< Vector >::vector_type = Vector

Type of vectors.

Definition at line 49 of file operator_conjugate_gradient.h.

Constructor & Destructor Documentation

◆ operator_conjugate_gradient()

template<base::concepts::dense_vector Vector>

num_collect::linear::impl::operator_conjugate_gradient< Vector >::operator_conjugate_gradient ( )

inline

Constructor.

Definition at line 57 of file operator_conjugate_gradient.h.

Member Function Documentation

◆ iterations()

template<base::concepts::dense_vector Vector>

auto num_collect::linear::impl::operator_conjugate_gradient< Vector >::iterations ( ) -> index_type

inline

Get the number of iterations.

Returns: Number of iterations.

Definition at line 134 of file operator_conjugate_gradient.h.

◆ solve()

template<base::concepts::dense_vector Vector>

template<base::concepts::invocable< const vector_type &, vector_type & > CoeffFunction>

void num_collect::linear::impl::operator_conjugate_gradient< Vector >::solve	(	CoeffFunction &&	coeff_function,
		const vector_type &	rhs,
		vector_type &	solution )

inline

Solve.

coeff_function is assumed to have a signature like:

void coeff_function(const vector_type& target, vector_type& result);

num_collect::linear::impl::operator_conjugate_gradient::vector_type

Vector vector_type

Type of vectors.

Definition operator_conjugate_gradient.h:49

Template Parameters

CoeffFunction Type of the function to multiply coefficient matrix.

Parameters

[in]	coeff_function	Function to multiply coefficient matrix.
[in]	rhs	Right-hand-side vector.
[in,out]	solution	Solution. (Given vector is used as the initial solution.)

Definition at line 78 of file operator_conjugate_gradient.h.