num_collect::regularization::explicit_gcv< Solver, Optimizer > Class Template Reference

Class to search optimal regularization parameter using GCV. More...

#include <num_collect/regularization/explicit_gcv.h>

Inheritance diagram for num_collect::regularization::explicit_gcv< Solver, Optimizer >:

Collaboration diagram for num_collect::regularization::explicit_gcv< Solver, Optimizer >:

Public Types
using	base_type
	Type of base class.
using	data_type
	Type of data.
using	optimizer_type
	Type of optimizers.
using	scalar_type
	Type of scalars.
using	solver_type
	Type of solvers.
Public Types inherited from num_collect::regularization::explicit_param_searcher_base< explicit_gcv< Solver, opt::heuristic_global_optimizer >, Solver >
using	data_type
	Type of data.
using	scalar_type
	Type of scalars.
using	solver_type
	Type of solvers.

Public Member Functions
	explicit_gcv (const solver_type &solver)
	Constructor.
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.
Public Member Functions inherited from num_collect::regularization::explicit_param_searcher_base< explicit_gcv< Solver, opt::heuristic_global_optimizer >, Solver >
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.

Private Attributes
scalar_type	opt_param_ {}
	Optimal regularization parameter.
optimizer_type	optimizer_
	Optimizer.
const solver_type *	solver_
	Solver.

Additional Inherited Members
Protected Member Functions inherited from num_collect::regularization::explicit_param_searcher_base< explicit_gcv< Solver, opt::heuristic_global_optimizer >, Solver >
auto	derived () const noexcept -> const explicit_gcv< Solver, opt::heuristic_global_optimizer > &
	Access derived object.
auto	derived () noexcept -> explicit_gcv< Solver, opt::heuristic_global_optimizer > &
	Access derived object.

Detailed Description

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>
class num_collect::regularization::explicit_gcv< Solver, Optimizer >

Class to search optimal regularization parameter using GCV.

Template Parameters

Solver	Type of solvers.
Optimizer	Type of optimizers.

Definition at line 82 of file explicit_gcv.h.

Member Typedef Documentation

base_type

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

using num_collect::regularization::explicit_gcv< Solver, Optimizer >::base_type

Initial value:

 
        explicit_param_searcher_base<explicit_gcv<Solver, Optimizer>, Solver>

Type of base class.

Definition at line 87 of file explicit_gcv.h.

data_type

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

using num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::data_type

Type of data.

Definition at line 43 of file explicit_param_searcher_base.h.

optimizer_type

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

using num_collect::regularization::explicit_gcv< Solver, Optimizer >::optimizer_type

Initial value:

 
        Optimizer<opt::function_object_wrapper<scalar_type(scalar_type),
            explicit_gcv_objective_function<solver_type>>>

Type of optimizers.

Definition at line 95 of file explicit_gcv.h.

scalar_type

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

using num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::scalar_type

Type of scalars.

Definition at line 40 of file explicit_param_searcher_base.h.

solver_type

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

using num_collect::regularization::explicit_param_searcher_base< Derived, Solver >::solver_type

Type of solvers.

Definition at line 37 of file explicit_param_searcher_base.h.

Constructor & Destructor Documentation

explicit_gcv()

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

num_collect::regularization::explicit_gcv< Solver, Optimizer >::explicit_gcv ( const solver_type & solver )

inlineexplicit

Constructor.

Parameters

[in]

solver

Solver.

Definition at line 104 of file explicit_gcv.h.

Member Function Documentation

opt_param()

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

auto num_collect::regularization::explicit_gcv< Solver, Optimizer >::opt_param ( ) const -> scalar_type

inlinenodiscard

Get the optimal regularization parameter.

Returns

Optimal regularization parameter.

Definition at line 124 of file explicit_gcv.h.

search()

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

void num_collect::regularization::explicit_gcv< Solver, Optimizer >::search ( )

inline

Search the optimal regularization parameter.

Definition at line 111 of file explicit_gcv.h.

solve()

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

void num_collect::regularization::explicit_gcv< Solver, Optimizer >::solve ( data_type & solution ) const

inline

Solver with the optimal regularization parameter.

Template Parameters

Solution

Type of the solution.

Parameters

[out]

solution

Solution.

Definition at line 127 of file explicit_gcv.h.

Member Data Documentation

opt_param_

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

scalar_type num_collect::regularization::explicit_gcv< Solver, Optimizer >::opt_param_ {}

private

Optimal regularization parameter.

Definition at line 139 of file explicit_gcv.h.

optimizer_

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

optimizer_type num_collect::regularization::explicit_gcv< Solver, Optimizer >::optimizer_

private

Optimizer.

Definition at line 136 of file explicit_gcv.h.

solver_

template<concepts::explicit_regularized_solver Solver, template< typename > typename Optimizer = opt::heuristic_global_optimizer>

const solver_type* num_collect::regularization::explicit_gcv< Solver, Optimizer >::solver_

private

Solver.

Definition at line 133 of file explicit_gcv.h.

---

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

• include/num_collect/regularization/explicit_gcv.h