num_collect::regularization::explicit_l_curve_objective_function< Solver > Class Template Reference

Class of objective function in L-curve. More...

#include <num_collect/regularization/explicit_l_curve.h>

Collaboration diagram for num_collect::regularization::explicit_l_curve_objective_function< Solver >:

Public Types
using	scalar_type = typename solver_type::scalar_type
	Type of scalars.
using	solver_type = Solver
	Type of solvers.

Public Member Functions
	explicit_l_curve_objective_function (const solver_type &solver)
	Constructor.
auto	operator() (const scalar_type &log_param) const -> scalar_type
	Calculate the curvature of L-curve.

Private Attributes
const solver_type *	solver_
	Solver.

Detailed Description

template<concepts::explicit_regularized_solver Solver>
class num_collect::regularization::explicit_l_curve_objective_function< Solver >

Class of objective function in L-curve.

Warning

This class is meant for use in optimizers.

Template Parameters

Solver

Type of solvers.

Definition at line 39 of file explicit_l_curve.h.

Member Typedef Documentation

scalar_type

template<concepts::explicit_regularized_solver Solver>

using num_collect::regularization::explicit_l_curve_objective_function< Solver >::scalar_type = typename solver_type::scalar_type

Type of scalars.

Definition at line 45 of file explicit_l_curve.h.

solver_type

template<concepts::explicit_regularized_solver Solver>

using num_collect::regularization::explicit_l_curve_objective_function< Solver >::solver_type = Solver

Type of solvers.

Definition at line 42 of file explicit_l_curve.h.

Constructor & Destructor Documentation

explicit_l_curve_objective_function()

template<concepts::explicit_regularized_solver Solver>

num_collect::regularization::explicit_l_curve_objective_function< Solver >::explicit_l_curve_objective_function ( const solver_type & solver )

inlineexplicit

Constructor.

Parameters

[in]

solver

Solver.

Definition at line 52 of file explicit_l_curve.h.

Member Function Documentation

operator()()

template<concepts::explicit_regularized_solver Solver>

auto num_collect::regularization::explicit_l_curve_objective_function< Solver >::operator() ( const scalar_type & log_param ) const -> scalar_type

inlinenodiscard

Calculate the curvature of L-curve.

Parameters

[in]

log_param

Logarithm of a regularization parameter.

Returns

Negated value of the curvature.

Definition at line 61 of file explicit_l_curve.h.

Member Data Documentation

solver_

template<concepts::explicit_regularized_solver Solver>

const solver_type* num_collect::regularization::explicit_l_curve_objective_function< Solver >::solver_

private

Solver.

Definition at line 71 of file explicit_l_curve.h.

---

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

• include/num_collect/regularization/explicit_l_curve.h