num_collect::regularization::regularized_solver_base< Derived, Data > Class Template Reference

Base class of solvers for regularization. More...

#include <num_collect/regularization/regularized_solver_base.h>

Inheritance diagram for num_collect::regularization::regularized_solver_base< Derived, Data >:

Collaboration diagram for num_collect::regularization::regularized_solver_base< Derived, Data >:

Public Types
using	data_type = Data
	Type of data.
using	scalar_type
	Type of scalars.

Public Member Functions
auto	data_size () const -> index_type
	Get the size of data.
auto	param_search_region () const -> std::pair< scalar_type, scalar_type >
	Get the default region to search for the optimal regularization parameter.
void	solve (const scalar_type &param, data_type &solution)
	Solve for a regularization parameter.
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.

Protected Member Functions
	regularized_solver_base (logging::log_tag_view tag)
	Constructor.
auto	derived () const noexcept -> const Derived &
	Access derived object.
auto	derived () noexcept -> Derived &
	Access derived object.

Detailed Description

template<typename Derived, base::concepts::dense_matrix Data>
class num_collect::regularization::regularized_solver_base< Derived, Data >

Base class of solvers for regularization.

Template Parameters

Derived	Type of derived class.
Data	Type of data.

Definition at line 40 of file regularized_solver_base.h.

Member Typedef Documentation

data_type

template<typename Derived , base::concepts::dense_matrix Data>

using num_collect::regularization::regularized_solver_base< Derived, Data >::data_type = Data

Type of data.

Definition at line 43 of file regularized_solver_base.h.

scalar_type

template<typename Derived , base::concepts::dense_matrix Data>

using num_collect::regularization::regularized_solver_base< Derived, Data >::scalar_type

Initial value:

 
        typename Eigen::NumTraits<typename data_type::Scalar>::Real

Type of scalars.

Definition at line 46 of file regularized_solver_base.h.

Constructor & Destructor Documentation

regularized_solver_base()

template<typename Derived , base::concepts::dense_matrix Data>

num_collect::regularization::regularized_solver_base< Derived, Data >::regularized_solver_base ( logging::log_tag_view tag )

inlineexplicitprotected

Constructor.

Parameters

[in]

tag

Log tag.

Definition at line 86 of file regularized_solver_base.h.

Member Function Documentation

data_size()

template<typename Derived , base::concepts::dense_matrix Data>

auto num_collect::regularization::regularized_solver_base< Derived, Data >::data_size ( ) const -> index_type

inlinenodiscard

Get the size of data.

Returns

Size of data.

Definition at line 65 of file regularized_solver_base.h.

derived() [1/2]

template<typename Derived , base::concepts::dense_matrix Data>

auto num_collect::regularization::regularized_solver_base< Derived, Data >::derived ( ) const -> const Derived&

inlinenodiscardprotectednoexcept

Access derived object.

Returns

Reference to the derived object.

Definition at line 103 of file regularized_solver_base.h.

derived() [2/2]

template<typename Derived , base::concepts::dense_matrix Data>

auto num_collect::regularization::regularized_solver_base< Derived, Data >::derived ( ) -> Derived&

inlinenodiscardprotectednoexcept

Access derived object.

Returns

Reference to the derived object.

Definition at line 94 of file regularized_solver_base.h.

param_search_region()

template<typename Derived , base::concepts::dense_matrix Data>

auto num_collect::regularization::regularized_solver_base< Derived, Data >::param_search_region ( ) const -> std::pair<scalar_type, scalar_type>

inlinenodiscard

Get the default region to search for the optimal regularization parameter.

Returns

Pair of minimum and maximum regularization parameters.

Definition at line 75 of file regularized_solver_base.h.

solve()

template<typename Derived , base::concepts::dense_matrix Data>

void num_collect::regularization::regularized_solver_base< Derived, Data >::solve ( const scalar_type & param, data_type & solution )

inline

Solve for a regularization parameter.

Parameters

[in]	param	Regularization parameter.
[in,out]	solution	Solution. (Iterative algorithm uses this parameter as the initial solution.)

Definition at line 56 of file regularized_solver_base.h.

---

The documentation for this class was generated from the following file:

• include/num_collect/regularization/regularized_solver_base.h