numerical-collection-cpp 0.10.0
A collection of algorithms in numerical analysis implemented in C++
Loading...
Searching...
No Matches
num_collect::regularization::explicit_param_searcher_base< Derived, Solver > Class Template Reference

Base class for searching the optimal regularization parameters using explicit formulas for regularization. More...

#include <num_collect/regularization/explicit_param_searcher_base.h>

+ Inheritance diagram for num_collect::regularization::explicit_param_searcher_base< Derived, Solver >:
+ Collaboration diagram for num_collect::regularization::explicit_param_searcher_base< Derived, Solver >:

Public Types

using data_type = typename solver_type::data_type
 Type of data.
 
using scalar_type = typename solver_type::scalar_type
 Type of scalars.
 
using solver_type = Solver
 Type of solvers.
 

Public Member Functions

auto opt_param () const -> scalar_type
 Get the optimal regularization parameter.
 
void search ()
 Search the optimal regularization parameter.
 
void solve (data_type &solution) const
 Solver with the optimal regularization parameter.
 

Protected Member Functions

auto derived () const noexcept -> const Derived &
 Access derived object.
 
auto derived () noexcept -> Derived &
 Access derived object.
 

Detailed Description

template<typename Derived, concepts::explicit_regularized_solver Solver>
class num_collect::regularization::explicit_param_searcher_base< Derived, Solver >

Base class for searching the optimal regularization parameters using explicit formulas for regularization.

Template Parameters
DerivedType of the derived class.
SolverType of solvers.

Definition at line 34 of file explicit_param_searcher_base.h.

Member Typedef Documentation

◆ data_type

template<typename Derived , concepts::explicit_regularized_solver Solver>
using num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::data_type = typename solver_type::data_type

Type of data.

Definition at line 43 of file explicit_param_searcher_base.h.

◆ scalar_type

template<typename Derived , concepts::explicit_regularized_solver Solver>
using num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::scalar_type = typename solver_type::scalar_type

Type of scalars.

Definition at line 40 of file explicit_param_searcher_base.h.

◆ solver_type

template<typename Derived , concepts::explicit_regularized_solver Solver>
using num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::solver_type = Solver

Type of solvers.

Definition at line 37 of file explicit_param_searcher_base.h.

Member Function Documentation

◆ derived() [1/2]

template<typename Derived , concepts::explicit_regularized_solver Solver>
auto num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::derived ( ) const -> const Derived&
inlinenodiscardprotectednoexcept

Access derived object.

Returns
Reference to the derived object.

Definition at line 82 of file explicit_param_searcher_base.h.

◆ derived() [2/2]

template<typename Derived , concepts::explicit_regularized_solver Solver>
auto num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::derived ( ) -> Derived&
inlinenodiscardprotectednoexcept

Access derived object.

Returns
Reference to the derived object.

Definition at line 73 of file explicit_param_searcher_base.h.

◆ opt_param()

template<typename Derived , concepts::explicit_regularized_solver Solver>
auto num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::opt_param ( ) const -> scalar_type
inlinenodiscard

Get the optimal regularization parameter.

Returns
Optimal regularization parameter.

Definition at line 55 of file explicit_param_searcher_base.h.

◆ search()

template<typename Derived , concepts::explicit_regularized_solver Solver>
void num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::search ( )
inline

Search the optimal regularization parameter.

Definition at line 48 of file explicit_param_searcher_base.h.

◆ solve()

template<typename Derived , concepts::explicit_regularized_solver Solver>
void num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::solve ( data_type & solution) const
inline

Solver with the optimal regularization parameter.

Template Parameters
SolutionType of the solution.
Parameters
[out]solutionSolution.

Definition at line 65 of file explicit_param_searcher_base.h.


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